net.openhft.chronicle.queue.reader

Interface Reader

All Known Implementing Classes:

ChronicleReader

public interface Reader

The Reader interface provides methods for reading messages from a Chronicle Queue. It allows for customization of the reading process through various configuration methods, and creates a Reader with the create() method

Method Summary

Modifier and Type	Method and Description
String	arg() Retrieves the argument for this Reader.
Reader	asMethodReader(@NotNull String methodReaderInterface) Sets the method reader interface for this Reader.
static Reader	create() Creates a new Reader instance.
void	execute() Executes the Reader.
Reader	historyRecords(long maxHistoryRecords) Sets the maximum number of history records for this Reader.
String	limiterArg() Retrieves the limiter argument for this Reader.
Class<?>	methodReaderInterface() Retrieves the method reader interface for this Reader.
Reader	showMessageHistory(boolean showMessageHistory) Sets whether to show message history for this Reader.
void	stop() Stops the Reader.
Reader	suppressDisplayIndex() Suppresses the display index for this Reader.
Reader	tail() Sets the Reader to tail mode.
Reader	withArg(@NotNull String arg) Sets the argument for this Reader.
Reader	withBasePath(@NotNull Path path) Sets the base path for this Reader.
Reader	withBinarySearch(@NotNull String binarySearch) Sets the binary search for this Reader.
ChronicleReader	withContentBasedLimiter(ContentBasedLimiter contentBasedLimiter) Sets the content-based limiter for this Reader.
Reader	withCustomPlugin(@NotNull ChronicleReaderPlugin customPlugin) Sets the custom plugin for this Reader.
Reader	withExclusionRegex(@NotNull String regex) Adds exclusion regex for this Reader.
Reader	withInclusionRegex(@NotNull String regex) Adds an inclusion regex for this Reader.
Reader	withLimiterArg(@NotNull String limiterArg) Sets the limiter argument for this Reader.
Reader	withMessageSink(@NotNull Consumer<String> messageSink) Sets the message sink for this Reader.
Reader	withStartIndex(long index) Sets the start index for this Reader.
Reader	withWireType(@NotNull net.openhft.chronicle.wire.WireType wireType) Sets the wire type for this Reader.

Method Detail

execute

void execute()

Executes the Reader.

stop

void stop()

Stops the Reader.

withMessageSink

Reader withMessageSink(@NotNull
                       @NotNull Consumer<String> messageSink)

Sets the message sink for this Reader. If not set, messages are output to stdout.

Parameters:

messageSink - A Consumer function that will handle the messages read by this Reader.

Returns:

this

withBasePath

Reader withBasePath(@NotNull
                    @NotNull Path path)

Sets the base path for this Reader.

Parameters:

path - The base path.

Returns:

this

withInclusionRegex

Reader withInclusionRegex(@NotNull
                          @NotNull String regex)

Adds an inclusion regex for this Reader. These are anded together.

Parameters:

regex - The inclusion regex.

Returns:

The Reader instance with the inclusion regex set.

withExclusionRegex

Reader withExclusionRegex(@NotNull
                          @NotNull String regex)

Adds exclusion regex for this Reader. These are anded together.

Parameters:

regex - The exclusion regex.

Returns:

this

withCustomPlugin

Reader withCustomPlugin(@NotNull
                        @NotNull ChronicleReaderPlugin customPlugin)

Sets the custom plugin for this Reader. Allows more flexibility than withMessageSink(Consumer)

Parameters:

customPlugin - The custom plugin.

Returns:

this

withStartIndex

Reader withStartIndex(long index)

Sets the start index for this Reader.

Parameters:

index - The start index.

Returns:

this

withContentBasedLimiter

ChronicleReader withContentBasedLimiter(ContentBasedLimiter contentBasedLimiter)

Sets the content-based limiter for this Reader.

Parameters:

contentBasedLimiter - The content-based limiter.

Returns:

this

withArg

Reader withArg(@NotNull
               @NotNull String arg)

Sets the argument for this Reader. Used in conjunction with withBinarySearch(String)

Parameters:

arg - The argument.

Returns:

this

withLimiterArg

Reader withLimiterArg(@NotNull
                      @NotNull String limiterArg)

Sets the limiter argument for this Reader. Used with withContentBasedLimiter(ContentBasedLimiter)

Parameters:

limiterArg - The limiter argument.

Returns:

this

tail

Reader tail()

Sets the Reader to tail mode.

Returns:

this

historyRecords

Reader historyRecords(long maxHistoryRecords)

Sets the maximum number of history records for this Reader.

Parameters:

maxHistoryRecords - The maximum number of history records.

Returns:

this

asMethodReader

Reader asMethodReader(@NotNull
                      @NotNull String methodReaderInterface)

Sets the method reader interface for this Reader.

Parameters:

methodReaderInterface - The method reader interface class name. If empty, a dummy reader is created.

Returns:

this

withWireType

Reader withWireType(@NotNull
                    @NotNull net.openhft.chronicle.wire.WireType wireType)

Sets the wire type for this Reader.

Parameters:

wireType - The wire type.

Returns:

this

suppressDisplayIndex

Reader suppressDisplayIndex()

Suppresses the display index for this Reader.

Returns:

this

withBinarySearch

Reader withBinarySearch(@NotNull
                        @NotNull String binarySearch)

Sets the binary search for this Reader.

Parameters:

binarySearch - The binary search.

Returns:

this

showMessageHistory

Reader showMessageHistory(boolean showMessageHistory)

Sets whether to show message history for this Reader.

Parameters:

showMessageHistory - Whether to show message history.

Returns:

this

arg

String arg()

Retrieves the argument for this Reader.

Returns:

The argument.

limiterArg

String limiterArg()

Retrieves the limiter argument for this Reader.

Returns:

The limiter argument.

methodReaderInterface

Class<?> methodReaderInterface()

Retrieves the method reader interface for this Reader.

Returns:

The method reader interface.

create

static Reader create()

Creates a new Reader instance.

Returns:

A new Reader instance.