/usr/include/log4cxx/asyncappender.h is in liblog4cxx10-dev 0.10.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef _LOG4CXX_ASYNC_APPENDER_H
#define _LOG4CXX_ASYNC_APPENDER_H
#if defined(_MSC_VER)
#pragma warning ( push )
#pragma warning ( disable: 4231 4251 4275 4786 )
#endif
#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/appenderattachableimpl.h>
#include <deque>
#include <log4cxx/spi/loggingevent.h>
#include <log4cxx/helpers/thread.h>
#include <log4cxx/helpers/mutex.h>
#include <log4cxx/helpers/condition.h>
namespace log4cxx
{
/**
The AsyncAppender lets users log events asynchronously. It uses a
bounded buffer to store logging events.
<p>The AsyncAppender will collect the events sent to it and then
dispatch them to all the appenders that are attached to it. You can
attach multiple appenders to an AsyncAppender.
<p>The AsyncAppender uses a separate thread to serve the events in
its bounded buffer.
<p><b>Important note:</b> The <code>AsyncAppender</code> can only
be script configured using the {@link xml::DOMConfigurator DOMConfigurator}.
*/
class LOG4CXX_EXPORT AsyncAppender :
public virtual spi::AppenderAttachable,
public virtual AppenderSkeleton
{
public:
DECLARE_LOG4CXX_OBJECT(AsyncAppender)
BEGIN_LOG4CXX_CAST_MAP()
LOG4CXX_CAST_ENTRY(AsyncAppender)
LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
LOG4CXX_CAST_ENTRY(spi::AppenderAttachable)
END_LOG4CXX_CAST_MAP()
/**
* Create new instance.
*/
AsyncAppender();
/**
* Destructor.
*/
virtual ~AsyncAppender();
void addRef() const;
void releaseRef() const;
/**
* Add appender.
*
* @param newAppender appender to add, may not be null.
*/
void addAppender(const AppenderPtr& newAppender);
void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p);
/**
Close this <code>AsyncAppender</code> by interrupting the
dispatcher thread which will process all pending events before
exiting.
*/
void close();
/**
* Get iterator over attached appenders.
* @return list of all attached appenders.
*/
AppenderList getAllAppenders() const;
/**
* Get appender by name.
*
* @param name name, may not be null.
* @return matching appender or null.
*/
AppenderPtr getAppender(const LogString& name) const;
/**
* Gets whether the location of the logging request call
* should be captured.
*
* @return the current value of the <b>LocationInfo</b> option.
*/
bool getLocationInfo() const;
/**
* Determines if specified appender is attached.
* @param appender appender.
* @return true if attached.
*/
bool isAttached(const AppenderPtr& appender) const;
virtual bool requiresLayout() const;
/**
* Removes and closes all attached appenders.
*/
void removeAllAppenders();
/**
* Removes an appender.
* @param appender appender to remove.
*/
void removeAppender(const AppenderPtr& appender);
/**
* Remove appender by name.
* @param name name.
*/
void removeAppender(const LogString& name);
/**
* The <b>LocationInfo</b> attribute is provided for compatibility
* with log4j and has no effect on the log output.
* @param flag new value.
*/
void setLocationInfo(bool flag);
/**
* The <b>BufferSize</b> option takes a non-negative integer value.
* This integer value determines the maximum size of the bounded
* buffer.
* */
void setBufferSize(int size);
/**
* Gets the current buffer size.
* @return the current value of the <b>BufferSize</b> option.
*/
int getBufferSize() const;
/**
* Sets whether appender should wait if there is no
* space available in the event buffer or immediately return.
*
* @param value true if appender should wait until available space in buffer.
*/
void setBlocking(bool value);
/**
* Gets whether appender should block calling thread when buffer is full.
* If false, messages will be counted by logger and a summary
* message appended after the contents of the buffer have been appended.
*
* @return true if calling thread will be blocked when buffer is full.
*/
bool getBlocking() const;
/**
* Set appender properties by name.
* @param option property name.
* @param value property value.
*/
void setOption(const LogString& option, const LogString& value);
private:
AsyncAppender(const AsyncAppender&);
AsyncAppender& operator=(const AsyncAppender&);
/**
* The default buffer size is set to 128 events.
*/
enum { DEFAULT_BUFFER_SIZE = 128 };
/**
* Event buffer.
*/
LOG4CXX_LIST_DEF(LoggingEventList, log4cxx::spi::LoggingEventPtr);
LoggingEventList buffer;
/**
* Mutex used to guard access to buffer and discardMap.
*/
::log4cxx::helpers::Mutex bufferMutex;
::log4cxx::helpers::Condition bufferNotFull;
::log4cxx::helpers::Condition bufferNotEmpty;
class DiscardSummary {
private:
/**
* First event of the highest severity.
*/
::log4cxx::spi::LoggingEventPtr maxEvent;
/**
* Total count of messages discarded.
*/
int count;
public:
/**
* Create new instance.
*
* @param event event, may not be null.
*/
DiscardSummary(const ::log4cxx::spi::LoggingEventPtr& event);
/** Copy constructor. */
DiscardSummary(const DiscardSummary& src);
/** Assignment operator. */
DiscardSummary& operator=(const DiscardSummary& src);
/**
* Add discarded event to summary.
*
* @param event event, may not be null.
*/
void add(const ::log4cxx::spi::LoggingEventPtr& event);
/**
* Create event with summary information.
*
* @return new event.
*/
::log4cxx::spi::LoggingEventPtr createEvent(::log4cxx::helpers::Pool& p);
};
/**
* Map of DiscardSummary objects keyed by logger name.
*/
typedef std::map<LogString, DiscardSummary> DiscardMap;
DiscardMap* discardMap;
/**
* Buffer size.
*/
int bufferSize;
/**
* Nested appenders.
*/
helpers::AppenderAttachableImplPtr appenders;
/**
* Dispatcher.
*/
helpers::Thread dispatcher;
/**
* Should location info be included in dispatched messages.
*/
bool locationInfo;
/**
* Does appender block when buffer is full.
*/
bool blocking;
/**
* Dispatch routine.
*/
static void* LOG4CXX_THREAD_FUNC dispatch(apr_thread_t* thread, void* data);
}; // class AsyncAppender
LOG4CXX_PTR_DEF(AsyncAppender);
} // namespace log4cxx
#if defined(_MSC_VER)
#pragma warning ( pop )
#endif
#endif// _LOG4CXX_ASYNC_APPENDER_H
|