org.apache.logging.log4j.core.async

Interface AsyncLoggerConfigDelegate

All Known Implementing Classes:

AsyncLoggerConfigDisruptor

public interface AsyncLoggerConfigDelegate

Encapsulates the mechanism used to log asynchronously. There is one delegate per configuration, which is shared by all AsyncLoggerConfig objects in the configuration.

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.
boolean	tryCallAppendersInBackground(LogEvent event, AsyncLoggerConfig asyncLoggerConfig) If possible, delegates the invocation of callAppenders to the background thread and returns true.

Method Detail

tryCallAppendersInBackground

boolean tryCallAppendersInBackground(LogEvent event,
                                   AsyncLoggerConfig asyncLoggerConfig)

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.

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

RingBufferAdmin createRingBufferAdmin(String contextName,
                                    String loggerConfigName)

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

Parameters:

contextName - name of the LoggerContext

loggerConfigName - name of the logger config

Returns:

the RingBufferAdmin that instruments the ringbuffer