Package io.aeron.samples

Samples for using the major features and measuring throughput and latency.

See: Description

Interface Summary

Interface	Description
RateReporter.Reporter	Interface for reporting of rate information

Class Summary

Class	Description
AeronStat	Tool for printing out Aeron counters.
BacklogStat	Tool for taking a snapshot of Aeron streams backlog information and some explanation for the StreamStat counters.
BacklogStat.StreamBacklog	Represents the backlog information for a particular stream of messages.
BacklogStat.StreamCompositeKey	Composite key which identifies an Aeron stream of messages.
BasicPublisher	Basic Aeron publisher application.
BasicSubscriber	This is a Basic Aeron subscriber application.
CncFileReader	Reader for Aeron CnC file represented by CncFileDescriptor which can be used for observability.
DriverTool	Tool for printing out Aeron Media Driver Information.
EmbeddedBufferClaimIpcThroughput	Throughput test using ExclusivePublication.tryClaim(int, BufferClaim) over UDP transport.
EmbeddedDualExclusiveThroughput	Throughput test with dual ExclusivePublications using ExclusivePublication.tryClaim(int, BufferClaim) for testing two sources into a single Subscription over UDP transport.
EmbeddedExclusiveBufferClaimIpcThroughput	Throughput test using ExclusivePublication.tryClaim(int, BufferClaim) over IPC transport.
EmbeddedExclusiveIpcThroughput	Throughput test using Publication.offer(DirectBuffer, int, int) over IPC transport.
EmbeddedExclusiveSpiedThroughput	Throughput test using Publication.offer(DirectBuffer, int, int) over UDP transport by spying via IPC.
EmbeddedExclusiveThroughput	Throughput test using Publication.offer(DirectBuffer, int, int) over UDP transport.
EmbeddedExclusiveVectoredIpcThroughput	Throughput test using Publication.offer(DirectBufferVector[]) over IPC transport.
EmbeddedIpcThroughput	Throughput test using Publication.offer(DirectBuffer, int, int) over IPC transport.
EmbeddedPingPong	Latency test using a ping-pong approach to measure RTT and store all results in a Histogram.
EmbeddedThroughput	Throughput test using Publication.offer(DirectBuffer, int, int) over UDP transport.
ErrorStat	Application to print out errors recorded in the command-and-control (CnC) file is maintained by media driver in shared memory.
FileReceiver	Receives files in chunks and saves them in a directory provided as the first command line option or the temporary directory if no command line arguments are provided.
FileSender	Sends a large file in chunks to a FileReceiver.
ImageRateReporter	Report the rate received to an Image and print to System.out.
ImageRateSubscriber	Runnable which picks up a single Image from a Subscription and reports the rate of consumption.
LogInspector	Command line utility for inspecting a log buffer to see what terms and messages it contains.
LossStat	Application that prints a report of loss observed by stream to System.out.
LowLatencyMediaDriver	Sample setup for a MediaDriver that is configured for low latency communications.
MultiplePublishersWithFragmentation	A publisher application with multiple publications which send fragmented messages to a channel and two different stream IDs.
MultipleSubscribersWithFragmentAssembly	A subscriber application with two subscriptions which can receive fragmented messages.
Ping	Ping component of Ping-Pong latency test recorded to a histogram to capture full distribution.
Pong	Pong component of Ping-Pong.
RateReporter	Tracker and reporter of throughput rates.
RateSubscriber	Example that displays current throughput rate while receiving data.
SampleConfiguration	Configuration used for samples with defaults which can be overridden by system properties.
SamplesUtil	Utility functions for the samples.
SetControllableIdleStrategy	Allows a ControllableIdleStrategy to be set via the command line.
SimplePublisher	A very simple Aeron publisher application which publishes a fixed size message on a fixed channel and stream.
SimpleSubscriber	A very simple Aeron subscriber application which can receive small non-fragmented messages on a fixed channel and stream ID.
StreamingPublisher	Publisher that sends a given number of messages at a given length as fast as possible.
StreamStat	Tool for taking a snapshot of Aeron streams and relevant position counters.
StreamStat.StreamCompositeKey	Composite key which identifies an Aeron stream of messages.
StreamStat.StreamPosition	Represents a position within a particular stream of messages.

Package io.aeron.samples Description

Samples for using the major features and measuring throughput and latency.