org.apache.logging.log4j.core.async

Class AsyncLoggerConfigDisruptor

java.lang.Object

org.apache.logging.log4j.core.async.AsyncLoggerConfigDisruptor

All Implemented Interfaces:

AsyncLoggerConfigDelegate

public class AsyncLoggerConfigDisruptor
extends Object
implements AsyncLoggerConfigDelegate

Helper class decoupling the AsyncLoggerConfig class from the LMAX Disruptor library.

AsyncLoggerConfig is a plugin, and will be loaded even if users do not configure any <asyncLogger> or <asyncRoot> elements in the configuration. If AsyncLoggerConfig has inner classes that extend or implement classes from the Disruptor library, a NoClassDefFoundError is thrown if the Disruptor jar is not in the classpath when the PluginManager loads the AsyncLoggerConfig plugin from the pre-defined plugins definition file.

This class serves to make the dependency on the Disruptor optional, so that these classes are only loaded when the AsyncLoggerConfig is actually used.

Constructor Summary

Constructors

Constructor and Description
AsyncLoggerConfigDisruptor()

Method Summary

Methods

Modifier and Type	Method and Description
RingBufferAdmin	createRingBufferAdmin(String contextName, String loggerConfigName) Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.
void	start() Increases the reference count and creates and starts a new Disruptor and associated thread if none currently exists.
void	stop() Decreases the reference count.
boolean	tryCallAppendersInBackground(LogEvent event, AsyncLoggerConfig asyncLoggerConfig) If possible, delegates the invocation of callAppenders to the background thread and returns true.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncLoggerConfigDisruptor

public AsyncLoggerConfigDisruptor()

Method Detail

start

public void start()

Increases the reference count and creates and starts a new Disruptor and associated thread if none currently exists.

See Also:

#release()

stop

public void stop()

Decreases the reference count. If the reference count reached zero, the Disruptor and its associated thread are shut down and their references set to null.

tryCallAppendersInBackground

public boolean tryCallAppendersInBackground(LogEvent event,
                                   AsyncLoggerConfig asyncLoggerConfig)

Description copied from interface: AsyncLoggerConfigDelegate

If possible, delegates the invocation of callAppenders to the background thread and returns true. If this is not possible (if it detects that delegating to the background thread would cause deadlock because the current call to Logger.log() originated from the background thread and the ringbuffer is full) then this method does nothing and returns false. It is the responsibility of the caller to process the event when this method returns false.

Specified by:

tryCallAppendersInBackground in interface AsyncLoggerConfigDelegate

Parameters:

event - the event to delegate to the background thread

asyncLoggerConfig - the logger config to call from the background thread

Returns:

true if delegation was successful, false if the calling thread needs to process the event itself

createRingBufferAdmin

public RingBufferAdmin createRingBufferAdmin(String contextName,
                                    String loggerConfigName)

Description copied from interface: AsyncLoggerConfigDelegate

Creates and returns a new RingBufferAdmin that instruments the ringbuffer of this AsyncLoggerConfig.

Specified by:

createRingBufferAdmin in interface AsyncLoggerConfigDelegate

Parameters:

contextName - name of the LoggerContext

loggerConfigName - name of the logger config

Returns:

the RingBufferAdmin that instruments the ringbuffer