net.openhft.chronicle.queue.reader

Class ChronicleReader

java.lang.Object

net.openhft.chronicle.queue.reader.ChronicleReader

All Implemented Interfaces:

Reader

public class ChronicleReader
extends Object
implements Reader

Constructor Summary

Constructors

Constructor and Description
ChronicleReader()

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.queue.reader.Reader

create

Constructor Detail

ChronicleReader

public ChronicleReader()

Method Detail

execute

public void execute()

Description copied from interface: Reader

Executes the Reader.

Specified by:

execute in interface Reader

withReadOnly

public ChronicleReader withReadOnly(boolean readOnly)

withMatchLimit

public ChronicleReader withMatchLimit(long matchLimit)

withMessageSink

public ChronicleReader withMessageSink(@NotNull
                                       @NotNull Consumer<String> messageSink)

Description copied from interface: Reader

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

Specified by:

withMessageSink in interface Reader

Parameters:

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

Returns:

this

messageSink

public Consumer<String> messageSink()

withBasePath

public ChronicleReader withBasePath(@NotNull
                                    @NotNull Path path)

Description copied from interface: Reader

Sets the base path for this Reader.

Specified by:

withBasePath in interface Reader

Parameters:

path - The base path.

Returns:

this

withInclusionRegex

public ChronicleReader withInclusionRegex(@NotNull
                                          @NotNull String regex)

Description copied from interface: Reader

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

Specified by:

withInclusionRegex in interface Reader

Parameters:

regex - The inclusion regex.

Returns:

The Reader instance with the inclusion regex set.

withExclusionRegex

public ChronicleReader withExclusionRegex(@NotNull
                                          @NotNull String regex)

Description copied from interface: Reader

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

Specified by:

withExclusionRegex in interface Reader

Parameters:

regex - The exclusion regex.

Returns:

this

withCustomPlugin

public ChronicleReader withCustomPlugin(@NotNull
                                        @NotNull ChronicleReaderPlugin customPlugin)

Description copied from interface: Reader

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

Specified by:

withCustomPlugin in interface Reader

Parameters:

customPlugin - The custom plugin.

Returns:

this

withStartIndex

public ChronicleReader withStartIndex(long index)

Description copied from interface: Reader

Sets the start index for this Reader.

Specified by:

withStartIndex in interface Reader

Parameters:

index - The start index.

Returns:

this

tail

public ChronicleReader tail()

Description copied from interface: Reader

Sets the Reader to tail mode.

Specified by:

tail in interface Reader

Returns:

this

historyRecords

public ChronicleReader historyRecords(long maxHistoryRecords)

Description copied from interface: Reader

Sets the maximum number of history records for this Reader.

Specified by:

historyRecords in interface Reader

Parameters:

maxHistoryRecords - The maximum number of history records.

Returns:

this

asMethodReader

public ChronicleReader asMethodReader(@NotNull
                                      @NotNull String methodReaderInterface)

Description copied from interface: Reader

Sets the method reader interface for this Reader.

Specified by:

asMethodReader in interface Reader

Parameters:

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

Returns:

this

showMessageHistory

public ChronicleReader showMessageHistory(boolean showMessageHistory)

Description copied from interface: Reader

Sets whether to show message history for this Reader.

Specified by:

showMessageHistory in interface Reader

Parameters:

showMessageHistory - Whether to show message history.

Returns:

this

withBinarySearch

public ChronicleReader withBinarySearch(@NotNull
                                        @NotNull String binarySearchClass)

Description copied from interface: Reader

Sets the binary search for this Reader.

Specified by:

withBinarySearch in interface Reader

Parameters:

binarySearchClass - The binary search.

Returns:

this

withContentBasedLimiter

public ChronicleReader withContentBasedLimiter(ContentBasedLimiter contentBasedLimiter)

Description copied from interface: Reader

Sets the content-based limiter for this Reader.

Specified by:

withContentBasedLimiter in interface Reader

Parameters:

contentBasedLimiter - The content-based limiter.

Returns:

this

withArg

public ChronicleReader withArg(@NotNull
                               @NotNull String arg)

Description copied from interface: Reader

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

Specified by:

withArg in interface Reader

Parameters:

arg - The argument.

Returns:

this

withLimiterArg

public ChronicleReader withLimiterArg(@NotNull
                                      @NotNull String limiterArg)

Description copied from interface: Reader

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

Specified by:

withLimiterArg in interface Reader

Parameters:

limiterArg - The limiter argument.

Returns:

this

withWireType

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

Description copied from interface: Reader

Sets the wire type for this Reader.

Specified by:

withWireType in interface Reader

Parameters:

wireType - The wire type.

Returns:

this

inReverseOrder

public ChronicleReader inReverseOrder()

suppressDisplayIndex

public ChronicleReader suppressDisplayIndex()

Description copied from interface: Reader

Suppresses the display index for this Reader.

Specified by:

suppressDisplayIndex in interface Reader

Returns:

this

arg

public String arg()

Description copied from interface: Reader

Retrieves the argument for this Reader.

Specified by:

arg in interface Reader

Returns:

The argument.

limiterArg

public String limiterArg()

Description copied from interface: Reader

Retrieves the limiter argument for this Reader.

Specified by:

limiterArg in interface Reader

Returns:

The limiter argument.

methodReaderInterface

public Class<?> methodReaderInterface()

Description copied from interface: Reader

Retrieves the method reader interface for this Reader.

Specified by:

methodReaderInterface in interface Reader

Returns:

The method reader interface.

withDocumentPollMethod

public ChronicleReader withDocumentPollMethod(Function<ExcerptTailer,net.openhft.chronicle.wire.DocumentContext> pollMethod)

withTailerId

public ChronicleReader withTailerId(String tailerId)

stop

public void stop()

Description copied from interface: Reader

Stops the Reader.

Specified by:

stop in interface Reader