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
140 void close() override;
141
146 AppenderList getAllAppenders() const override;
147
154 AppenderPtr getAppender(const LogString& name) const override;
155
161 bool isAttached(const AppenderPtr appender) const override;
162
165 bool requiresLayout() const override;
166
170 void removeAllAppenders() override;
171
176 void removeAppender(const AppenderPtr appender) override;
181 void removeAppender(const LogString& name) override;
182
187 bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) override;
188
192 void replaceAppenders(const AppenderList& newList) override;
193
199 void setBufferSize(int newSize);
200
205 int getBufferSize() const;
206
213 void setBlocking(bool newValue);
214
222 bool getBlocking() const;
223
224
235 void setOption(const LogString& option, const LogString& value) override;
236
237
238 private:
240 AsyncAppender& operator=(const AsyncAppender&);
241
242}; // class AsyncAppender
244} // namespace log4cxx
245
246#endif// _LOG4CXX_ASYNC_APPENDER_H
247
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
Set option to value.
bool requiresLayout() const override
Return false.
bool getBlocking() const
Gets whether appender should block calling thread when ring buffer is full.
void setBufferSize(int newSize)
Use newSize (a non-negative integer value) for the number of logging events the ring buffer can hold.
void doAppend(const spi::LoggingEventPtr &event) override
Call AppenderSkeleton::doAppendImpl without acquiring a lock.
AppenderList getAllAppenders() const override
Get iterator over attached appenders.
void removeAppender(const AppenderPtr appender) override
Removes an appender.
AppenderPtr getAppender(const LogString &name) const override
Get appender by name.
void addAppender(const AppenderPtr newAppender) override
Ensure newAppender receives any logging event added to this appender.
int getBufferSize() const
Gets the current buffer size.
void replaceAppenders(const AppenderList &newList) override
Replace any previously added appenders with newList.
void close() override
Close this AsyncAppender by interrupting the dispatcher thread which will process all pending events ...
void setBlocking(bool newValue)
Use newValue for whether appender should block the calling thread if there is no space in the ring bu...
bool isAttached(const AppenderPtr appender) const override
Determines if specified appender is attached.
bool replaceAppender(const AppenderPtr &oldAppender, const AppenderPtr &newAppender) override
Replace oldAppender with newAppender.
This Interface is for attaching Appenders to objects.
Definition appenderattachable.h:33
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: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