io.aeron.samples

Class SamplesUtil

java.lang.Object

io.aeron.samples.SamplesUtil

public class SamplesUtil
extends Object

Utility functions for the samples.

Constructor Summary

Constructors

Constructor and Description
SamplesUtil()

Method Summary

Modifier and Type	Method and Description
static CountersReader	mapCounters() Map an existing CnC file.
static CountersReader	mapCounters(MutableInteger cncFileVersion) Map an existing CnC file.
static MappedByteBuffer	mapExistingFileReadOnly(File location) Map an existing file as a read only buffer.
static FragmentHandler	printAsciiMessage(int streamId) Return a reusable, parametrised FragmentHandler that prints to stdout.
static void	printAvailableImage(Image image) Print the information for an available image to stdout.
static void	printError(String channel, int streamId, int sessionId, String message, HeaderFlyweight cause) Generic error handler that just prints message to stdout.
static void	printRate(double messagesPerSec, double bytesPerSec, long totalMessages, long totalBytes) Print the rates to stdout.
static void	printUnavailableImage(Image image) Print the information for an unavailable image to stdout.
static FragmentHandler	rateReporterHandler(RateReporter reporter) Return a reusable, parametrised FragmentHandler that calls into a RateReporter.
static Consumer<Subscription>	subscriberLoop(FragmentHandler fragmentHandler, int limit, AtomicBoolean running) Return a reusable, parametrised event loop that calls a default IdleStrategy when no messages are received.
static Consumer<Subscription>	subscriberLoop(FragmentHandler fragmentHandler, int limit, AtomicBoolean running, IdleStrategy idleStrategy) Return a reusable, parametrised event loop that calls and idler when no messages are received.

Methods inherited from class java.lang.Object

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

Constructor Detail

SamplesUtil

public SamplesUtil()

Method Detail

subscriberLoop

public static Consumer<Subscription> subscriberLoop(FragmentHandler fragmentHandler,
                                                    int limit,
                                                    AtomicBoolean running)

Return a reusable, parametrised event loop that calls a default IdleStrategy when no messages are received.

Parameters:

fragmentHandler - to be called back for each message.

limit - passed to Subscription.poll(FragmentHandler, int).

running - indication for loop.

Returns:

loop function.

subscriberLoop

public static Consumer<Subscription> subscriberLoop(FragmentHandler fragmentHandler,
                                                    int limit,
                                                    AtomicBoolean running,
                                                    IdleStrategy idleStrategy)

Return a reusable, parametrised event loop that calls and idler when no messages are received.

Parameters:

fragmentHandler - to be called back for each message.

limit - passed to Subscription.poll(FragmentHandler, int).

running - indication for loop.

idleStrategy - to use for loop.

Returns:

loop function.

printAsciiMessage

public static FragmentHandler printAsciiMessage(int streamId)

Return a reusable, parametrised FragmentHandler that prints to stdout.

Parameters:

streamId - to show when printing.

Returns:

subscription data handler function that prints the message contents.

rateReporterHandler

public static FragmentHandler rateReporterHandler(RateReporter reporter)

Return a reusable, parametrised FragmentHandler that calls into a RateReporter.

Parameters:

reporter - for the rate.

Returns:

FragmentHandler that records the rate information.

printError

public static void printError(String channel,
                              int streamId,
                              int sessionId,
                              String message,
                              HeaderFlyweight cause)

Generic error handler that just prints message to stdout.

Parameters:

channel - for the error.

streamId - for the error.

sessionId - for the error, if it has a source.

message - indicating what the error was.

cause - of the error.

printRate

public static void printRate(double messagesPerSec,
                             double bytesPerSec,
                             long totalMessages,
                             long totalBytes)

Print the rates to stdout.

Parameters:

messagesPerSec - being reported.

bytesPerSec - being reported.

totalMessages - being reported.

totalBytes - being reported.

printAvailableImage

public static void printAvailableImage(Image image)

Print the information for an available image to stdout.

Parameters:

image - that has been created.

printUnavailableImage

public static void printUnavailableImage(Image image)

Print the information for an unavailable image to stdout.

Parameters:

image - that has gone inactive.

mapExistingFileReadOnly

public static MappedByteBuffer mapExistingFileReadOnly(File location)

Map an existing file as a read only buffer.

Parameters:

location - of file to map.

Returns:

the mapped file.

mapCounters

public static CountersReader mapCounters()

Map an existing CnC file.

Returns:

the CountersReader over the CnC file.

mapCounters

public static CountersReader mapCounters(MutableInteger cncFileVersion)

Map an existing CnC file.

Parameters:

cncFileVersion - to set as value of file.

Returns:

the CountersReader over the CnC file.