uk.org.simonsite.log4j.appender.concurrent

Class LoggingEventBlockingQueue

java.lang.Object

uk.org.simonsite.log4j.appender.concurrent.LoggingEventBlockingQueue

All Implemented Interfaces:

LoggingEventQueue

public final class LoggingEventBlockingQueue
extends Object
implements LoggingEventQueue

Queue used to buffer LoggingEvents for asynchronous dispatch. This is backed by a LinkedBlockingQueue and is thread-safe.

Version:

1.0

Author:

Simon Park

Constructor Summary

Constructors

Constructor and Description
LoggingEventBlockingQueue(ActiveAsynchronousAppenderProperties properties)

Method Summary

Methods

Modifier and Type	Method and Description
LoggingEvent	poll()
void	put(LoggingEvent loggingEvent) Inserts the specified element at the tail of this queue, waiting if necessary for space to become available, and notifies all waiting threads.
LoggingEvent	take() Retrieves and removes the head element of this queue, waiting if necessary until an element becomes available.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingEventBlockingQueue

public LoggingEventBlockingQueue(ActiveAsynchronousAppenderProperties properties)

Method Detail

poll

public final LoggingEvent poll()

Specified by:

poll in interface LoggingEventQueue

Returns:

the head of this queue, or null if this queue is empty.

See Also:

LoggingEventQueue.poll()

put

public final void put(LoggingEvent loggingEvent)
               throws InterruptedException

Description copied from interface: LoggingEventQueue

Inserts the specified element at the tail of this queue, waiting if necessary for space to become available, and notifies all waiting threads.

Specified by:

put in interface LoggingEventQueue

Throws:

InterruptedException

See Also:

LoggingEventQueue.put(org.apache.log4j.spi.LoggingEvent)

take

public final LoggingEvent take()
                        throws InterruptedException

Description copied from interface: LoggingEventQueue

Retrieves and removes the head element of this queue, waiting if necessary until an element becomes available.

Specified by:

take in interface LoggingEventQueue

Returns:

the head of this queue.

Throws:

InterruptedException - if interrupted whilst waiting.

See Also:

LoggingEventQueue.take()