Apache Log4cxx  Version 1.6.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
83class LOG4CXX_EXPORT AsyncAppender :
84 public virtual spi::AppenderAttachable,
85 public virtual AppenderSkeleton
86{
87 protected:
88 struct AsyncAppenderPriv;
89
90 public:
97
98
102
106 virtual ~AsyncAppender();
107
114 void addAppender(const AppenderPtr newAppender) override;
115
119 void doAppend(const spi::LoggingEventPtr& event,
120 helpers::Pool& pool1) override;
121
127 void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
128
134 void close() override;
135
140 AppenderList getAllAppenders() const override;
141
148 AppenderPtr getAppender(const LogString& name) const override;
149
153 bool getLocationInfo() const;
159 bool isAttached(const AppenderPtr appender) const override;
160
163 bool requiresLayout() const override;
164
168 void removeAllAppenders() override;
169
174 void removeAppender(const AppenderPtr appender) override;
179 void removeAppender(const LogString& name) override;
180
185 bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) LOG4CXX_16_VIRTUAL_SPECIFIER;
186
190 void replaceAppenders(const AppenderList& newList) LOG4CXX_16_VIRTUAL_SPECIFIER;
191
197 void setLocationInfo(bool flag);
198
204 void setBufferSize(int size);
205
210 int getBufferSize() const;
211
218 void setBlocking(bool value);
219
227 bool getBlocking() const;
228
229
240 void setOption(const LogString& option, const LogString& value) override;
241
242
243 private:
245 AsyncAppender& operator=(const AsyncAppender&);
246
250 void dispatch();
251
252}; // class AsyncAppender
254} // namespace log4cxx
255
256#endif// _LOG4CXX_ASYNC_APPENDER_H
257
#define LOG4CXX_16_VIRTUAL_SPECIFIER
Definition appenderattachable.h:99
AppenderSkeleton(LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
The AsyncAppender decouples logging event creation from output by processing log events asynchronousl...
Definition asyncappender.h:86
void setLocationInfo(bool flag)
The LocationInfo attribute is provided for compatibility with log4j and has no effect on the log outp...
AsyncAppender()
Create new instance.
void removeAllAppenders() override
Removes and closes all attached appenders.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
void append(const spi::LoggingEventPtr &event, helpers::Pool &p) override
Add event to a ring buffer.
bool requiresLayout() const override
Return false.
bool getBlocking() const
Gets whether appender should block calling thread when buffer is full.
void setBlocking(bool value)
Sets whether appender should wait if there is no space available in the event buffer or immediately r...
void replaceAppenders(const AppenderList &newList) LOG4CXX_16_VIRTUAL_SPECIFIER
Replace any previously added appenders with newList.
AppenderList getAllAppenders() const override
Get iterator over attached appenders.
void removeAppender(const AppenderPtr appender) override
Removes an appender.
void doAppend(const spi::LoggingEventPtr &event, helpers::Pool &pool1) override
Call AppenderSkeleton::doAppendImpl without acquiring a lock.
bool replaceAppender(const AppenderPtr &oldAppender, const AppenderPtr &newAppender) LOG4CXX_16_VIRTUAL_SPECIFIER
Replace oldAppender with newAppender.
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 close() override
Close this AsyncAppender by interrupting the dispatcher thread which will process all pending events ...
void setBufferSize(int size)
The BufferSize option takes a non-negative integer value.
bool isAttached(const AppenderPtr appender) const override
Determines if specified appender is attached.
bool getLocationInfo() const
The current value of the (unused) LocationInfo option.
This Interface is for attaching Appenders to objects.
Definition appenderattachable.h:33
Definition propertysetter.h:27
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:60
LOG4CXX_PTR_DEF(Appender)
std::shared_ptr< Appender > AppenderPtr
Definition basicconfigurator.h:29
#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