/src/logging-log4cxx/src/main/include/log4cxx/rolling/action.h
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Licensed to the Apache Software Foundation (ASF) under one or more |
3 | | * contributor license agreements. See the NOTICE file distributed with |
4 | | * this work for additional information regarding copyright ownership. |
5 | | * The ASF licenses this file to You under the Apache License, Version 2.0 |
6 | | * (the "License"); you may not use this file except in compliance with |
7 | | * the License. You may obtain a copy of the License at |
8 | | * |
9 | | * http://www.apache.org/licenses/LICENSE-2.0 |
10 | | * |
11 | | * Unless required by applicable law or agreed to in writing, software |
12 | | * distributed under the License is distributed on an "AS IS" BASIS, |
13 | | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
14 | | * See the License for the specific language governing permissions and |
15 | | * limitations under the License. |
16 | | */ |
17 | | |
18 | | #if !defined(_LOG4CXX_ROLLING_ACTION_H) |
19 | | #define _LOG4CXX_ROLLING_ACTION_H |
20 | | |
21 | | #include <log4cxx/helpers/object.h> |
22 | | #include <log4cxx/helpers/pool.h> |
23 | | #include <mutex> |
24 | | #include <memory> |
25 | | |
26 | | namespace LOG4CXX_NS |
27 | | { |
28 | | namespace rolling |
29 | | { |
30 | | |
31 | | |
32 | | /** |
33 | | * A file system action performed as part of a rollover event. |
34 | | */ |
35 | | class Action : public virtual LOG4CXX_NS::helpers::Object |
36 | | { |
37 | | DECLARE_ABSTRACT_LOG4CXX_OBJECT(Action) |
38 | 0 | BEGIN_LOG4CXX_CAST_MAP() |
39 | 0 | LOG4CXX_CAST_ENTRY(Action) |
40 | 0 | END_LOG4CXX_CAST_MAP() |
41 | | |
42 | | LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(ActionPrivate, m_priv) |
43 | | |
44 | | protected: |
45 | | /** |
46 | | * Constructor. |
47 | | */ |
48 | | Action(); |
49 | | Action(LOG4CXX_PRIVATE_PTR(ActionPrivate) priv); |
50 | | virtual ~Action(); |
51 | | |
52 | | public: |
53 | | /** |
54 | | * Perform action. |
55 | | * |
56 | | * @return true if successful. |
57 | | */ |
58 | | virtual bool execute(LOG4CXX_NS::helpers::Pool& pool) const = 0; |
59 | | |
60 | | void run(LOG4CXX_NS::helpers::Pool& pool); |
61 | | |
62 | | void close(); |
63 | | |
64 | | /** |
65 | | * Tests if the action is complete. |
66 | | * @return true if action is complete. |
67 | | */ |
68 | | bool isComplete() const; |
69 | | |
70 | | void reportException(const std::exception&); |
71 | | |
72 | | |
73 | | }; |
74 | | |
75 | | LOG4CXX_PTR_DEF(Action); |
76 | | |
77 | | } |
78 | | } |
79 | | #endif |
80 | | |