Package org.agrona.concurrent

Concurrent data structures and utilities that support both on and off Java heap usage.

See: Description

Interface Summary

Interface	Description
Agent	An Agent is scheduled to do work on a thread on a duty cycle.
AtomicBuffer	Abstraction over a range of buffer types that allows type to be accessed with memory ordering semantics.
ControlledMessageHandler	Callback interface for processing of messages that are read from a buffer.
EpochClock	Retrieves the number of milliseconds since 1 Jan 1970 UTC.
EpochMicroClock	Clock representing the time in microseconds since 1 Jan 1970 UTC.
EpochNanoClock	Clock representing the time in nanoseconds since 1 Jan 1970 UTC.
IdleStrategy	Idle strategy for use by threads when they do not have work to do.
MessageHandler	Callback interface for processing of messages that are read from a buffer.
NanoClock	Functional interface for return the current time as system wide monotonic tick of 1 nanosecond precision.
Pipe<E>	A container for items exchanged from producers to consumers.
QueuedPipe<E>	Composed interface for concurrent Queue and Pipe.
RecordBuffer.RecordHandler	Callback interface for reading elements out of the buffer.
RecordBuffer.RecordWriter	Interface for safely writing to the buffer.

Class Summary

Class	Description
AbstractConcurrentArrayQueue<E>	Left over immutable queue fields.
AgentInvoker	Agent container which does not start a thread.
AgentRunner	Agent runner containing an Agent which is run on a Thread.
BackoffIdleStrategy	Idling strategy for threads when they have no work to do.
BusySpinIdleStrategy	Busy spin strategy targeted at lowest possible latency.
CachedEpochClock	An EpochClock that caches a timestamp which can be updated with CachedEpochClock.update(long).
CachedNanoClock	A NanoClock that caches a timestamp which can be updated with CachedNanoClock.update(long).
CompositeAgent	Group several Agents into one composite so they can be scheduled as a unit.
ControllableIdleStrategy	IdleStrategy which can be controlled by a counter so its mode of operation can be switched between doing nothing (NOOP), busy spinning by calling ThreadHints.onSpinWait(), yielding by calling Thread.yield(), or sleeping for the minimum period by calling LockSupport.parkNanos(long) when work count is zero so it idles.
CountedErrorHandler	An ErrorHandler which calls AtomicCounter.increment() before delegating the exception.
DynamicCompositeAgent	Group several Agents into one composite so they can be scheduled as a unit.
HighResolutionClock	Clock that provides the number of time units since the 1 Jan 1970 UTC.
HighResolutionTimer	Control the use of high resolution timers on Windows by a bit of hackery.
ManyToManyConcurrentArrayQueue<E>	Many producer to many consumer concurrent queue that is array backed.
ManyToOneConcurrentArrayQueue<E>	Many producer to one consumer concurrent queue that is array backed.
ManyToOneConcurrentLinkedQueue<E>	Concurrent linked Queue that can be used from many producers and a single consumer.
MappedResizeableBuffer	Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer.
NoOpIdleStrategy	Low-latency idle strategy to be employed in loops that do significant work on each iteration such that any work in the idle strategy would be wasteful.
NoOpLock	A Lock implementation that is a no operation, i.e.
OffsetEpochNanoClock	An accurate, zero-gc, pure-java, EpochNanoClock that calculates an initial epoch nano time based on System.currentTimeMillis() and then uses that offset to adjust the return value of System.nanoTime() to the UNIX epoch.
OneToOneConcurrentArrayQueue<E>	One producer to one consumer concurrent queue that is array backed.
RecordBuffer	A record buffer is an off-heap buffer with a series of records and a header that can be written to or read from multiple threads.
ShutdownSignalBarrier	One time barrier for blocking one or more threads until a SIGINT or SIGTERM signal is received from the operating system or by programmatically calling ShutdownSignalBarrier.signal().
SigInt	Utility to allow the registration of a SIGINT handler that hides the unsupported Signal class.
SigIntBarrier	One time barrier for blocking one or more threads until a SIGINT signal is received from the operating system or by programmatically calling SigIntBarrier.signal().
SleepingIdleStrategy	When idle this strategy is to sleep for a specified period in nanoseconds.
SleepingMillisIdleStrategy	When idle this strategy is to sleep for a specified period time in milliseconds.
SystemEpochClock	Implementation that calls System.currentTimeMillis().
SystemEpochMicroClock	Implementation that calls HighResolutionClock.epochMicros().
SystemEpochNanoClock	Implementation that calls HighResolutionClock.epochNanos().
SystemNanoClock	A NanoClock the delegates to System.nanoTime().
UnsafeBuffer	Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer.
YieldingIdleStrategy	IdleStrategy that will call Thread.yield() when the work count is zero.

Enum Summary

Enum	Description
ControlledMessageHandler.Action	Action to be taken on return from ControlledMessageHandler.onMessage(int, MutableDirectBuffer, int, int).
DynamicCompositeAgent.Status	Enum to indicate the current status of a DynamicCompositeAgent.

Exception Summary

Exception	Description
AgentTerminationException	Thrown to terminate the work/duty cycle of an Agent.

Package org.agrona.concurrent Description

Concurrent data structures and utilities that support both on and off Java heap usage.