public class AsyncAppender extends AppenderSkeleton implements AppenderAttachable
AsyncAppender
can only be script
configured using the DOMConfigurator
.
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BUFFER_SIZE
The default buffer size is set to 128 events.
|
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
Constructor and Description |
---|
AsyncAppender()
Create new instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addAppender(Appender newAppender)
Add appender.
|
void |
append(LoggingEvent event) |
void |
close()
Close this
AsyncAppender by interrupting the dispatcher
thread which will process all pending events before exiting. |
void |
doAppend(LoggingEvent event) |
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() |
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.
|
activateOptions, addFilter, clearFilters, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
public static final int DEFAULT_BUFFER_SIZE
public void doAppend(LoggingEvent event)
doAppend
in interface Appender
doAppend
in class AppenderSkeleton
public void addAppender(Appender newAppender)
addAppender
in interface AppenderAttachable
newAppender
- appender to add, may not be null.public void append(LoggingEvent event)
append
in class AppenderSkeleton
public void close()
AsyncAppender
by interrupting the dispatcher
thread which will process all pending events before exiting.public java.util.Enumeration getAllAppenders()
getAllAppenders
in interface AppenderAttachable
public Appender getAppender(java.lang.String name)
getAppender
in interface AppenderAttachable
name
- name, may not be null.public boolean getLocationInfo()
public boolean isAttached(Appender appender)
isAttached
in interface AppenderAttachable
appender
- appender.public boolean requiresLayout()
requiresLayout
in interface Appender
public void removeAllAppenders()
removeAllAppenders
in interface AppenderAttachable
public void removeAppender(Appender appender)
removeAppender
in interface AppenderAttachable
appender
- appender to remove.public void removeAppender(java.lang.String name)
removeAppender
in interface AppenderAttachable
name
- name.public void setLocationInfo(boolean flag)
flag
- true if location information should be extracted.public void setBufferSize(int size)
size
- buffer size, must be positive.public int getBufferSize()
public void setBlocking(boolean value)
value
- true if appender should wait until available space in buffer.public boolean getBlocking()
Copyright © 2006-2019 OPS4J - Open Participation Software for Java. All Rights Reserved.