net.openhft.chronicle.queue.impl.single

Class ThreadLocalAppender

java.lang.Object

net.openhft.chronicle.queue.impl.single.ThreadLocalAppender

public final class ThreadLocalAppender
extends Object

Internal implementation class that enables the use of a thread local appender. Please ensure that you carefully read the javadoc and understand the lifecycle of this thread-local appender before use.

Method Summary

Modifier and Type	Method and Description
static ExcerptAppender	acquireThreadLocalAppender(ChronicleQueue queue) Returns a ExcerptAppender for the given ChronicleQueue that is local to the current Thread.

Methods inherited from class java.lang.Object

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

Method Detail

acquireThreadLocalAppender

public static ExcerptAppender acquireThreadLocalAppender(ChronicleQueue queue)

Returns a ExcerptAppender for the given ChronicleQueue that is local to the current Thread.

An Appender can be used to store new excerpts sequentially to the queue.

An Appender is NOT thread-safe and, in addition to that, confined to be used by the creating thread only.. Sharing an Appender across threads is unsafe and will inevitably lead to errors and unspecified behaviour.

This method returns a ThreadLocal appender, so does not produce any garbage, hence it's safe to simply call this method every time an appender is needed.

Returns:

Returns a ExcerptAppender for this ChronicleQueue that is local to the current Thread

Throws:

IllegalArgumentException - if the queue it is passed is not an instance of SingleChronicleQueue