com.fr.third.apache.log4j

类 AsyncAppender

java.lang.Object

com.fr.third.apache.log4j.AppenderSkeleton

com.fr.third.apache.log4j.AsyncAppender

所有已实现的接口:

Appender, AppenderAttachable, OptionHandler

public class AsyncAppender
extends AppenderSkeleton
implements AppenderAttachable

The AsyncAppender lets users log events asynchronously.

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.

The AsyncAppender uses a separate thread to serve the events in its buffer.

Important note: The AsyncAppender can only be script configured using the DOMConfigurator.

从以下版本开始:

0.9.1

作者:

Ceki Gülcü, Curt Arnold

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_BUFFER_SIZE The default buffer size is set to 128 events.

从类继承的字段 com.fr.third.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

构造器概要

构造器

构造器和说明
AsyncAppender() Create new instance.

方法概要

方法

限定符和类型	方法和说明
void	addAppender(Appender newAppender) Add appender.
void	append(LoggingEvent event) Subclasses of AppenderSkeleton should implement this method to perform actual logging.
void	close() Close this AsyncAppender by interrupting the dispatcher thread which will process all pending events before exiting.
java.util.Enumeration	getAllAppenders() Get iterator over attached appenders.
Appender	getAppender(java.lang.String name) Get appender by name.
boolean	getBlocking() Gets whether appender should block calling thread when buffer is full.
int	getBufferSize() Gets the current buffer size.
boolean	getLocationInfo() Gets whether the location of the logging request call should be captured.
boolean	isAttached(Appender appender) Determines if specified appender is attached.
void	removeAllAppenders() Removes and closes all attached appenders.
void	removeAppender(Appender appender) Removes an appender.
void	removeAppender(java.lang.String name) Remove appender by name.
boolean	requiresLayout() Configurators call this method to determine if the appender requires a layout.
void	setBlocking(boolean value) Sets whether appender should wait if there is no space available in the event buffer or immediately return.
void	setBufferSize(int size) Sets the number of messages allowed in the event buffer before the calling thread is blocked (if blocking is true) or until messages are summarized and discarded.
void	setLocationInfo(boolean flag) The LocationInfo option takes a boolean value.

从类继承的方法 com.fr.third.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

从类继承的方法 java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default buffer size is set to 128 events.

另请参阅:

常量字段值

构造器详细资料

AsyncAppender

public AsyncAppender()

Create new instance.

方法详细资料

addAppender

public void addAppender(Appender newAppender)

Add appender.

指定者:

addAppender 在接口中 AppenderAttachable

参数:

newAppender - appender to add, may not be null.

append

public void append(LoggingEvent event)

Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton.doAppend method.

指定者:

append 在类中 AppenderSkeleton

close

public void close()

Close this AsyncAppender by interrupting the dispatcher thread which will process all pending events before exiting.

指定者:

close 在接口中 Appender

getAllAppenders

public java.util.Enumeration getAllAppenders()

Get iterator over attached appenders.

指定者:

getAllAppenders 在接口中 AppenderAttachable

返回:

iterator or null if no attached appenders.

getAppender

public Appender getAppender(java.lang.String name)

Get appender by name.

指定者:

getAppender 在接口中 AppenderAttachable

参数:

name - name, may not be null.

返回:

matching appender or null.

getLocationInfo

public boolean getLocationInfo()

Gets whether the location of the logging request call should be captured.

返回:

the current value of the LocationInfo option.

isAttached

public boolean isAttached(Appender appender)

Determines if specified appender is attached.

指定者:

isAttached 在接口中 AppenderAttachable

参数:

appender - appender.

返回:

true if attached.

requiresLayout

public boolean requiresLayout()

Configurators call this method to determine if the appender requires a layout. If this method returns true, meaning that layout is required, then the configurator will configure an layout using the configuration information at its disposal. If this method returns false, meaning that a layout is not required, then layout configuration will be skipped even if there is available layout configuration information at the disposal of the configurator..

In the rather exceptional case, where the appender implementation admits a layout but can also work without it, then the appender should return true.

指定者:

requiresLayout 在接口中 Appender

removeAllAppenders

public void removeAllAppenders()

Removes and closes all attached appenders.

指定者:

removeAllAppenders 在接口中 AppenderAttachable

removeAppender

public void removeAppender(Appender appender)

Removes an appender.

指定者:

removeAppender 在接口中 AppenderAttachable

参数:

appender - appender to remove.

removeAppender

public void removeAppender(java.lang.String name)

Remove appender by name.

指定者:

removeAppender 在接口中 AppenderAttachable

参数:

name - name.

setLocationInfo

public void setLocationInfo(boolean flag)

The LocationInfo option takes a boolean value. By default, it is set to false which means there will be no effort to extract the location information related to the event. As a result, the event that will be ultimately logged will likely to contain the wrong location information (if present in the log format).

Location information extraction is comparatively very slow and should be avoided unless performance is not a concern.

参数:

flag - true if location information should be extracted.

setBufferSize

public void setBufferSize(int size)

Sets the number of messages allowed in the event buffer before the calling thread is blocked (if blocking is true) or until messages are summarized and discarded. Changing the size will not affect messages already in the buffer.

参数:

size - buffer size, must be positive.

getBufferSize

public int getBufferSize()

Gets the current buffer size.

返回:

the current value of the BufferSize option.

setBlocking

public void setBlocking(boolean value)

Sets whether appender should wait if there is no space available in the event buffer or immediately return.

参数:

value - true if appender should wait until available space in buffer.

从以下版本开始:

1.2.14

getBlocking

public boolean getBlocking()

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.

返回:

true if calling thread will be blocked when buffer is full.

从以下版本开始:

1.2.14