Apache Log4cxx  Version 1.7.0
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 
90 class LOG4CXX_EXPORT AsyncAppender :
91  public virtual spi::AppenderAttachable,
92  public virtual AppenderSkeleton
93 {
94  protected:
95  struct AsyncAppenderPriv;
96 
97  public:
104 
105 
109 
113  virtual ~AsyncAppender();
114 
121  void addAppender(const AppenderPtr newAppender) override;
122 
126  void doAppend(const spi::LoggingEventPtr& event,
127  helpers::Pool& pool1) override;
128 
134  void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
135 
141  void close() override;
142 
147  AppenderList getAllAppenders() const override;
148 
155  AppenderPtr getAppender(const LogString& name) const override;
156 
160  bool getLocationInfo() const;
166  bool isAttached(const AppenderPtr appender) const override;
167 
170  bool requiresLayout() const override;
171 
175  void removeAllAppenders() override;
176 
181  void removeAppender(const AppenderPtr appender) override;
186  void removeAppender(const LogString& name) override;
187 
192  bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) LOG4CXX_16_VIRTUAL_SPECIFIER;
193 
197  void replaceAppenders(const AppenderList& newList) LOG4CXX_16_VIRTUAL_SPECIFIER;
198 
204  void setLocationInfo(bool flag);
205 
211  void setBufferSize(int newSize);
212 
217  int getBufferSize() const;
218 
225  void setBlocking(bool newValue);
226 
234  bool getBlocking() const;
235 
236 
247  void setOption(const LogString& option, const LogString& value) override;
248 
249 
250  private:
252  AsyncAppender& operator=(const AsyncAppender&);
253 
254 }; // class AsyncAppender
256 } // namespace log4cxx
257 
258 #endif// _LOG4CXX_ASYNC_APPENDER_H
259 
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:93
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:154
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:148
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:160
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:142
#define LOG4CXX_16_VIRTUAL_SPECIFIER
Definition: socket.h:90