Reader (OpenHFT/Chronicle-Queue 5.23ea3 API)

All Known Implementing Classes:

ChronicleReader
```
public interface Reader
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`arg()`
`Reader`	`asMethodReader(@Nullable String methodReaderInterface)` specify method reader interface to use
`static Reader`	`create()`
`void`	`execute()`
`Reader`	`historyRecords(long maxHistoryRecords)`
`String`	`limiterArg()`
`Class<?>`	`methodReaderInterface()`
`Reader`	`showMessageHistory(boolean showMessageHistory)`
`void`	`stop()`
`Reader`	`suppressDisplayIndex()`
`Reader`	`tail()`
`Reader`	`withArg(@NotNull String arg)`
`Reader`	`withBasePath(@NotNull Path path)`
`Reader`	`withBinarySearch(@NotNull String binarySearch)`
`ChronicleReader`	`withContentBasedLimiter(ContentBasedLimiter contentBasedLimiter)`
`Reader`	`withCustomPlugin(@NotNull ChronicleReaderPlugin customPlugin)`
`Reader`	`withExclusionRegex(@NotNull String regex)`
`Reader`	`withInclusionRegex(@NotNull String regex)`
`Reader`	`withLimiterArg(@NotNull String limiterArg)`
`Reader`	`withMessageSink(@NotNull Consumer<String> messageSink)`
`Reader`	`withStartIndex(long index)`
`Reader`	`withWireType(@NotNull net.openhft.chronicle.wire.WireType wireType)`

Method Detail

execute
```
void execute()
```

stop
```
void stop()
```

withMessageSink

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

withBasePath

Reader withBasePath(@NotNull
                    @NotNull Path path)

withInclusionRegex

Reader withInclusionRegex(@NotNull
                          @NotNull String regex)

withExclusionRegex

Reader withExclusionRegex(@NotNull
                          @NotNull String regex)

withCustomPlugin

Reader withCustomPlugin(@NotNull
                        @NotNull ChronicleReaderPlugin customPlugin)

withStartIndex
```
Reader withStartIndex(long index)
```

withContentBasedLimiter

ChronicleReader withContentBasedLimiter(ContentBasedLimiter contentBasedLimiter)

withArg

Reader withArg(@NotNull
               @NotNull String arg)

withLimiterArg

Reader withLimiterArg(@NotNull
                      @NotNull String limiterArg)

tail
```
Reader tail()
```

historyRecords

Reader historyRecords(long maxHistoryRecords)

asMethodReader
```
Reader asMethodReader(@Nullable
                      @Nullable String methodReaderInterface)
```
specify method reader interface to use

Parameters:

methodReaderInterface - interface class name. If null, a dummy reader is created TODO: x.23 this argument will become @NonNull

Returns:

this

withWireType

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

suppressDisplayIndex
```
Reader suppressDisplayIndex()
```

withBinarySearch

Reader withBinarySearch(@NotNull
                        @NotNull String binarySearch)

showMessageHistory

Reader showMessageHistory(boolean showMessageHistory)

arg
```
String arg()
```

limiterArg
```
String limiterArg()
```

methodReaderInterface
```
Class<?> methodReaderInterface()
```

create
```
static Reader create()
```

Interface Reader

Method Summary

Method Detail

execute

stop

withMessageSink

withBasePath

withInclusionRegex

withExclusionRegex

withCustomPlugin

withStartIndex

withContentBasedLimiter

withArg

withLimiterArg

tail

historyRecords

asMethodReader

withWireType

suppressDisplayIndex

withBinarySearch

showMessageHistory

arg

limiterArg

methodReaderInterface

create