Class AsyncHandler

java.lang.Object

java.util.logging.Handler

org.jboss.logmanager.ExtHandler

org.jboss.logmanager.handlers.AsyncHandler

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, FlushableCloseable, Protectable

public class AsyncHandler
extends ExtHandler

An asynchronous log handler which is used to write to a handler or group of handlers which are "slow" or introduce some degree of latency.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	AsyncHandler.AsyncTask
static enum	AsyncHandler.OverflowAction

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_QUEUE_LENGTH
private AsyncHandler.OverflowAction	overflowAction
private final int	queueLength
private final BlockingQueue<ExtLogRecord>	recordQueue
private int	state
private static final AtomicIntegerFieldUpdater<AsyncHandler>	stateUpdater
private final Thread	thread

Fields inherited from class ExtHandler

handlers, handlersUpdater

Constructor Summary

Constructors

Constructor	Description
AsyncHandler()	Construct a new instance.
AsyncHandler(int queueLength)	Construct a new instance.
AsyncHandler(int queueLength, ThreadFactory threadFactory)	Construct a new instance.
AsyncHandler(ThreadFactory threadFactory)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Close all child handlers.
protected void	doPublish(ExtLogRecord record)	Do the actual work of publication; the record will have been filtered already.
AsyncHandler.OverflowAction	getOverflowAction()	Get the overflow action.
int	getQueueLength()	The full size of the queue.
void	setOverflowAction(AsyncHandler.OverflowAction overflowAction)	Set the overflow action.

Methods inherited from class ExtHandler

addHandler, checkAccess, checkAccess, clearHandlers, disableAccess, enableAccess, flush, getHandlers, isAutoFlush, isEnabled, protect, publish, publish, removeHandler, setAutoFlush, setEnabled, setEncoding, setErrorManager, setFilter, setFormatter, setHandlers, setLevel, unprotect

Methods inherited from class Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError

Methods inherited from class Object

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

Field Details

recordQueue

private final BlockingQueue<ExtLogRecord> recordQueue

queueLength

private final int queueLength

thread

private final Thread thread

overflowAction

private volatile AsyncHandler.OverflowAction overflowAction

state

private volatile int state

stateUpdater

private static final AtomicIntegerFieldUpdater<AsyncHandler> stateUpdater

DEFAULT_QUEUE_LENGTH

private static final int DEFAULT_QUEUE_LENGTH

See Also:

• Constant Field Values

Constructor Details

AsyncHandler

public AsyncHandler(int queueLength,
 ThreadFactory threadFactory)

Construct a new instance.

Parameters:

queueLength - the queue length

threadFactory - the thread factory to use to construct the handler thread

AsyncHandler

public AsyncHandler(ThreadFactory threadFactory)

Construct a new instance.

Parameters:

threadFactory - the thread factory to use to construct the handler thread

AsyncHandler

public AsyncHandler(int queueLength)

Construct a new instance.

Parameters:

queueLength - the queue length

AsyncHandler

public AsyncHandler()

Construct a new instance.

Method Details

getQueueLength

public int getQueueLength()

The full size of the queue.

Returns:

the full size of the queue.

getOverflowAction

public AsyncHandler.OverflowAction getOverflowAction()

Get the overflow action.

Returns:

the overflow action

setOverflowAction

public void setOverflowAction(AsyncHandler.OverflowAction overflowAction)

Set the overflow action.

Parameters:

overflowAction - the overflow action

doPublish

protected void doPublish(ExtLogRecord record)

Do the actual work of publication; the record will have been filtered already. The default implementation does nothing except to flush if the autoFlush property is set to true; if this behavior is to be preserved in a subclass then this method should be called after the record is physically written.

Overrides:

doPublish in class ExtHandler

Parameters:

record - the log record to publish

close

public void close()
           throws SecurityException

Close all child handlers.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ExtHandler

Throws:

SecurityException