Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
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
25namespace LOG4CXX_NS
26{
28
90class LOG4CXX_EXPORT AsyncAppender :
91 public virtual spi::AppenderAttachable,
92 public 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 ) override;
127
133 void append( const spi::LoggingEventPtr& event ) override;
134
139 AppenderList getAllAppenders() const override;
140
147 AppenderPtr getAppender(const LogString& name) const override;
148
154 bool isAttached(const AppenderPtr& appender) const override;
155
159 void removeAllAppenders() override;
160
165 bool removeAppender(const AppenderPtr& appender) override;
170 bool removeAppender(const LogString& name) override;
171
176 bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) override;
177
181 void replaceAppenders(const AppenderList& newList) override;
182
183 static const int MaxBufferedEventCount = 10000000;
189 void setBufferSize(int newSize);
190
195 int getBufferSize() const;
196
203 void setBlocking(bool newValue);
204
212 bool getBlocking() const;
213
214
225 void setOption(const LogString& option, const LogString& value) override;
226
227
228 private:
230 AsyncAppender& operator=(const AsyncAppender&);
231
232}; // class AsyncAppender
234} // namespace log4cxx
235
236#endif// _LOG4CXX_ASYNC_APPENDER_H
237
AppenderSkeleton(LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
The AsyncAppender decouples logging event creation from output by processing log events asynchronousl...
Definition asyncappender.h:93
AsyncAppender()
Create new instance.
void removeAllAppenders() override
Removes and closes all attached appenders.
void append(const spi::LoggingEventPtr &event) override
Add event to a ring buffer.
void setOption(const LogString &option, const LogString &value) override
Override this method to set option to value.
bool getBlocking() const
Gets whether appender should block calling thread when ring buffer is full.
static const int MaxBufferedEventCount
Definition asyncappender.h:183
bool removeAppender(const AppenderPtr &appender) override
Remove appender.
void setBufferSize(int newSize)
Use newSize (an integer value in the range 1 to 10 million) for the number of logging events the ring...
void doAppend(const spi::LoggingEventPtr &event) override
Call AppenderSkeleton::doAppendImpl without acquiring a lock.
AppenderList getAllAppenders() const override
Get iterator over attached appenders.
bool isAttached(const AppenderPtr &appender) const override
Determines if specified appender is attached.
void addAppender(const AppenderPtr &newAppender) override
Ensure newAppender receives any logging event added to this appender.
AppenderPtr getAppender(const LogString &name) const override
Get appender by name.
int getBufferSize() const
Gets the current buffer size.
void replaceAppenders(const AppenderList &newList) override
Replace any previously added appenders with newList.
void setBlocking(bool newValue)
Use newValue for whether appender should block the calling thread if there is no space in the ring bu...
bool replaceAppender(const AppenderPtr &oldAppender, const AppenderPtr &newAppender) override
Replace oldAppender with newAppender.
This Interface is for attaching Appenders to objects.
Definition appenderattachable.h:37
Definition appender.h:30
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition appender.h:32
LOG4CXX_LIST_DEF(AppenderList, AppenderPtr)
std::basic_string< logchar > LogString
Definition logstring.h:51
std::shared_ptr< Appender > AppenderPtr
Definition basicconfigurator.h:29
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition object.h:153
#define END_LOG4CXX_CAST_MAP()
Definition object.h:147
#define DECLARE_LOG4CXX_OBJECT(object)
Definition object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition object.h:159
#define BEGIN_LOG4CXX_CAST_MAP()
Definition object.h:141