Apache Log4cxx  Version 1.3.1
asyncappender.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 #ifndef _LOG4CXX_ASYNC_APPENDER_H
19 #define _LOG4CXX_ASYNC_APPENDER_H
20 
24 
25 namespace LOG4CXX_NS
26 {
28 
65 class LOG4CXX_EXPORT AsyncAppender :
66  public virtual spi::AppenderAttachable,
67  public virtual AppenderSkeleton
68 {
69  protected:
70  struct AsyncAppenderPriv;
71 
72  public:
79 
80 
84 
88  virtual ~AsyncAppender();
89 
95  void addAppender(const AppenderPtr newAppender) override;
96 
97  void doAppend(const spi::LoggingEventPtr& event,
98  helpers::Pool& pool1) override;
99 
100  void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
101 
107  void close() override;
108 
113  AppenderList getAllAppenders() const override;
114 
121  AppenderPtr getAppender(const LogString& name) const override;
122 
129  bool getLocationInfo() const;
135  bool isAttached(const AppenderPtr appender) const override;
136 
137  bool requiresLayout() const override;
138 
142  void removeAllAppenders() override;
143 
148  void removeAppender(const AppenderPtr appender) override;
153  void removeAppender(const LogString& name) override;
154 
160  void setLocationInfo(bool flag);
161 
167  void setBufferSize(int size);
168 
173  int getBufferSize() const;
174 
181  void setBlocking(bool value);
182 
190  bool getBlocking() const;
191 
192 
204  void setOption(const LogString& option, const LogString& value) override;
205 
206 
207  private:
209  AsyncAppender& operator=(const AsyncAppender&);
210 
214  void dispatch();
215 
216 }; // class AsyncAppender
218 } // namespace log4cxx
219 
220 #endif// _LOG4CXX_ASYNC_APPENDER_H
221 
Implementation base class for all appenders.
Definition: appenderskeleton.h:41
The AsyncAppender decouples logging event creation from output by processing log events asynchronousl...
Definition: asyncappender.h:68
This Interface is for attaching Appenders to objects.
Definition: appenderattachable.h:33
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
LOG4CXX_LIST_DEF(LoggingEventList, spi::LoggingEventPtr)
LOG4CXX_PTR_DEF(AsyncAppender)
std::basic_string< logchar > LogString
Definition: logstring.h:60
std::shared_ptr< Appender > AppenderPtr
Definition: basicconfigurator.h:28
#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