Apache Log4cxx  Version 1.3.1
multiprocessrollingfileappender.h
Go to the documentation of this file.
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_MULTIPROCESS_ROLLING_FILE_APPENDER_H)
19 #define LOG4CXX_ROLLING_MULTIPROCESS_ROLLING_FILE_APPENDER_H
20 
21 #include <log4cxx/fileappender.h>
23 #include <log4cxx/fileappender.h>
26 #include <log4cxx/rolling/action.h>
27 
28 namespace LOG4CXX_NS
29 {
30 namespace rolling
31 {
32 
33 
37 class LOG4CXX_EXPORT MultiprocessRollingFileAppender : public FileAppender
38 {
44  protected:
45  struct MultiprocessRollingFileAppenderPriv;
46 
47  public:
49 
57  void activateOptions(helpers::Pool&) override;
58 
59 
75 
76  protected:
77 
81  void subAppend(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
82 
83  bool rolloverInternal(LOG4CXX_NS::helpers::Pool& p);
84 
85  public:
86 
87  RollingPolicyPtr getRollingPolicy() const;
88 
89  TriggeringPolicyPtr getTriggeringPolicy() const;
90 
97  void setRollingPolicy(const RollingPolicyPtr& policy);
98 
99  void setTriggeringPolicy(const TriggeringPolicyPtr& policy);
100 
101  public:
105  void close() override;
106 
107  protected:
117  helpers::WriterPtr createWriter(helpers::OutputStreamPtr& os) override;
118 
119  public:
124  size_t getFileLength() const;
125 
130  void incrementFileLength(size_t increment);
131 
132  private:
137  void setFileLength(size_t length);
138 
143  void releaseFileLock(apr_file_t* lock_file);
148  void reopenLatestFile(LOG4CXX_NS::helpers::Pool& p);
149 
150  friend class CountingOutputStream;
151 
152 };
153 
155 
156 }
157 }
158 
159 #endif
160 
FileAppender appends log events to a file.
Definition: fileappender.h:42
Definition: pool.h:33
A special version of the RollingFileAppender that acts properly with multiple processes.
Definition: multiprocessrollingfileappender.h:38
void subAppend(const spi::LoggingEventPtr &event, helpers::Pool &p) override
Actual writing occurs here.
void incrementFileLength(size_t increment)
Increments estimated byte length of current active log file.
void activateOptions(helpers::Pool &) override
Activate the options that were previously set with calls to option setters.
helpers::WriterPtr createWriter(helpers::OutputStreamPtr &os) override
Returns an OutputStreamWriter when passed an OutputStream.
bool rolloverInternal(log4cxx::helpers::Pool &p)
size_t getFileLength() const
Get byte length of current active log file.
void setRollingPolicy(const RollingPolicyPtr &policy)
Sets the rolling policy.
void setTriggeringPolicy(const TriggeringPolicyPtr &policy)
bool rollover(helpers::Pool &p)
Implements the usual roll over behaviour.
TriggeringPolicyPtr getTriggeringPolicy() const
LOG4CXX_PTR_DEF(MultiprocessRollingFileAppender)
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146