net.openhft.chronicle.wire

Interface WireIn

All Superinterfaces:

MarshallableIn, WireCommon

All Known Subinterfaces:

Wire

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire, YamlWire, YamlWireOut

public interface WireIn
extends WireCommon, MarshallableIn

Defines the standard interface for reading sequentially from a Bytes stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WireIn.HeaderType Enumeration representing possible header types that can be read from a WireIn instance.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.MarshallableIn

MARSHALLABLE_IN_INTERN_SIZE

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the WireIn, effectively resetting its state.
void	commentListener(Consumer<CharSequence> commentListener) Sets a listener that gets notified whenever a comment is encountered during reading.
void	consumePadding() Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
void	copyTo(@NotNull WireOut wire) Copies the content from the current WireIn source to the provided WireOut destination.
default void	endEvent() Marks the end of an event or method flow.
@NotNull ValueIn	getValueIn() Obtains the value associated with a field or event for more advanced use cases.
default boolean	hasMetaDataPrefix() Checks if the current position in the stream has a metadata prefix.
default boolean	hasMore() This consumes any padding before checking if readRemaining() > 0
default boolean	hintReadInputOrder() Provides a hint about the order in which the input should be read.
default boolean	isEmpty() Checks if the WireIn is empty.
default boolean	isEndEvent() Checks if the current position in the stream represents the end of an event or method flow.
default boolean	isNotEmptyAfterPadding() This consumes any padding before checking if readRemaining() > 0
ObjectInput	objectInput() Returns the ObjectInput associated with this WireIn for serialization operations.
default void	rawReadData(@NotNull ReadMarshallable marshallable) Performs a raw data read operation.
@NotNull ValueIn	read() Reads the next field if present, or returns an empty string if not present.
default @NotNull ValueIn	read(String fieldName) Reads the next field based on the provided field name.
@NotNull ValueIn	read(@NotNull StringBuilder name) Reads a specific field based on the provided field name.
@NotNull ValueIn	read(@NotNull WireKey key) Reads the next field if present.
default @NotNull WireIn	readAlignTo(int alignment) Adjusts the read position of the WireIn to align with the specified boundary.
default <K,V> @NotNull Map<K,V>	readAllAsMap(Class<K> kClass, @NotNull Class<V> vClass, @NotNull Map<K,V> map) Reads all available entries and populates the provided map with these entries.
void	readAndSetLength(long position) Reads and sets the length of the data or metadata at the specified position.
@NotNull WireIn	readComment(@NotNull StringBuilder sb) Reads a comment from the Wire data and appends it to the provided StringBuilder.
default boolean	readDataHeader() Consume a header if one is available.
@NotNull WireIn.HeaderType	readDataHeader(boolean includeMetaData) Attempts to read a header for data or metadata, based on the provided parameter.
default boolean	readDocument(long position, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer) Reads a document from a specific position, consuming both its metadata and data sections.
default boolean	readDocument(@Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer) Reads a document, consuming both its metadata and data sections.
<K> K	readEvent(Class<K> expectedClass) Reads a field which may contain an object of any specified type.
default @NotNull ValueIn	readEventName(@NotNull StringBuilder name) Reads a field or string, ensuring the value is always read.
long	readEventNumber() Reads the next event number.
void	readFirstHeader() Reads the first header in the stream.
void	readFirstHeader(long timeout, TimeUnit timeUnit) Reads the first header in the stream with a timeout.
@NotNull DocumentContext	readingDocument() equivalent to readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
DocumentContext	readingDocument(long readLocation) Provides a context for reading a document starting at a specific position.
String	readingPeekYaml() Peeks at the content in the current WireIn instance and returns it as a YAML string.
void	readMetaDataHeader() Reads the metadata header from the current position in the stream.
default void	startEvent() Marks the start of an event or method flow.

Methods inherited from interface net.openhft.chronicle.wire.WireCommon

bytes, bytesComment, classLookup, classLookup, headerNumber, headerNumber, isBinary, newBooleanReference, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, reset, usePadding, usePadding, useSelfDescribingMessage

Methods inherited from interface net.openhft.chronicle.wire.MarshallableIn

methodReader, methodReaderBuilder, readBytes, readBytes, readDocument, readMap, readText, readText

Method Detail

readAllAsMap

@NotNull
default <K,V> @NotNull Map<K,V> readAllAsMap(Class<K> kClass,
                                                      @NotNull
                                                      @NotNull Class<V> vClass,
                                                      @NotNull
                                                      @NotNull Map<K,V> map)
                                               throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads all available entries and populates the provided map with these entries. Each entry in the wire source is read as a key-value pair where the key is of type K and the value is of type V.

Type Parameters:

K - The type of keys in the map.

V - The type of values in the map.

Parameters:

kClass - The class type of the key.

vClass - The class type of the value.

map - The map to populate with read entries.

Returns:

The populated map.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

copyTo

void copyTo(@NotNull
            @NotNull WireOut wire)
     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Copies the content from the current WireIn source to the provided WireOut destination.

Parameters:

wire - The WireOut instance where the content will be copied to.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

read

@NotNull
@NotNull ValueIn read()

Reads the next field if present, or returns an empty string if not present.

Returns:

The value of the next field, encapsulated in a ValueIn instance.

read

@NotNull
@NotNull ValueIn read(@NotNull
                               @NotNull WireKey key)

Reads the next field if present. The field should match the provided WireKey.

Parameters:

key - The WireKey that should match the next field.

Returns:

The value of the matched field, encapsulated in a ValueIn instance.

read

@NotNull
default @NotNull ValueIn read(String fieldName)

Reads the next field based on the provided field name.

Parameters:

fieldName - The name of the field to read.

Returns:

The value of the specified field, encapsulated in a ValueIn instance.

readEventNumber

long readEventNumber()

Reads the next event number. If no number is present, returns Long.MIN_VALUE.

Returns:

The next event number or Long.MIN_VALUE if no number is present.

readEventName

@NotNull
default @NotNull ValueIn readEventName(@NotNull
                                                @NotNull StringBuilder name)

Reads a field or string, ensuring the value is always read. This method is specifically designed to ensure reading even for formats that might potentially omit the field, such as RAW.

Parameters:

name - The StringBuilder that holds the name of the field or string.

Returns:

The value of the field or string, encapsulated in a ValueIn instance.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If the bytes fail to be parsed.

read

@NotNull
@NotNull ValueIn read(@NotNull
                               @NotNull StringBuilder name)

Reads a specific field based on the provided field name. If the field is not present, it returns an empty string.

Parameters:

name - The name of the field to read.

Returns:

The value of the specified field, encapsulated in a ValueIn instance.

readEvent

@Nullable
<K> K readEvent(Class<K> expectedClass)
                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a field which may contain an object of any specified type.

Type Parameters:

K - The type of object expected.

Parameters:

expectedClass - The class type hint of the expected object. If no hint is available, use Object.class.

Returns:

An instance of the specified expectedClass.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

getValueIn

@NotNull
@NotNull ValueIn getValueIn()

Obtains the value associated with a field or event for more advanced use cases. Typically used after a call to readEvent(Class).

Returns:

The value of the field or event, encapsulated in a ValueIn instance.

objectInput

ObjectInput objectInput()

Returns the ObjectInput associated with this WireIn for serialization operations.

Returns:

the ObjectInput instance.

readComment

@NotNull
@NotNull WireIn readComment(@NotNull
                                     @NotNull StringBuilder sb)

Reads a comment from the Wire data and appends it to the provided StringBuilder.

Parameters:

sb - StringBuilder to which the comment will be appended.

Returns:

the WireIn instance for method chaining.

clear

void clear()

Clears the WireIn, effectively resetting its state.

Specified by:

clear in interface WireCommon

hasMore

default boolean hasMore()

This consumes any padding before checking if readRemaining() > 0

NOTE: This method only works inside a document. Call it just before a document and it won't know not to read the read in case there is padding.

Returns:

if there is more data to be read in this document.

isNotEmptyAfterPadding

default boolean isNotEmptyAfterPadding()

This consumes any padding before checking if readRemaining() > 0

NOTE: This method only works inside a document. Call it just before a document and it won't know not to read the read in case there is padding.

Returns:

if there is more data to be read in this document.

isEmpty

default boolean isEmpty()

Checks if the WireIn is empty.

Returns:

true if empty, otherwise false.

readAlignTo

@NotNull
default @NotNull WireIn readAlignTo(int alignment)

Adjusts the read position of the WireIn to align with the specified boundary. Typically used for cases where data is structured in blocks of fixed sizes, ensuring proper alignment.

Parameters:

alignment - The byte boundary to which the read position should align.

Returns:

the WireIn instance for method chaining.

readDocument

default boolean readDocument(@Nullable
                             @Nullable ReadMarshallable metaDataConsumer,
                             @Nullable
                             @Nullable ReadMarshallable dataConsumer)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a document, consuming both its metadata and data sections.

Parameters:

metaDataConsumer - Consumer that processes the metadata section of the document.

dataConsumer - Consumer that processes the main data section of the document.

Returns:

true if the document was successfully read, otherwise false.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during marshalling.

readDocument

default boolean readDocument(long position,
                             @Nullable
                             @Nullable ReadMarshallable metaDataConsumer,
                             @Nullable
                             @Nullable ReadMarshallable dataConsumer)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads a document from a specific position, consuming both its metadata and data sections.

Parameters:

position - The position from which to start reading the document.

metaDataConsumer - Consumer that processes the metadata section of the document.

dataConsumer - Consumer that processes the main data section of the document.

Returns:

true if the document was successfully read from the given position, otherwise false.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during marshalling.

rawReadData

default void rawReadData(@NotNull
                         @NotNull ReadMarshallable marshallable)
                  throws net.openhft.chronicle.core.io.InvalidMarshallableException

Performs a raw data read operation.

Parameters:

marshallable - Data to be read in its raw form.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during marshalling.

readingDocument

@NotNull
@NotNull DocumentContext readingDocument()

equivalent to readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression

Specified by:

readingDocument in interface MarshallableIn

Returns:

the document context

readingDocument

DocumentContext readingDocument(long readLocation)

Provides a context for reading a document starting at a specific position.

Parameters:

readLocation - The position from which to start reading the document.

Returns:

the document context associated with the specific read location.

consumePadding

void consumePadding()

Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.

commentListener

void commentListener(Consumer<CharSequence> commentListener)

Sets a listener that gets notified whenever a comment is encountered during reading.

Parameters:

commentListener - The consumer that handles and processes the comments.

readDataHeader

default boolean readDataHeader()
                        throws EOFException

Consume a header if one is available.

Returns:

true, if a message can be read between readPosition and readLimit, else false if no header is ready.

Throws:

EOFException - if the end of wire marker is reached.

readDataHeader

@NotNull
@NotNull WireIn.HeaderType readDataHeader(boolean includeMetaData)
                                            throws EOFException

Attempts to read a header for data or metadata, based on the provided parameter.

Parameters:

includeMetaData - If true, metadata headers are included in the read attempt.

Returns:

The type of header that was read.

Throws:

EOFException - if an end-of-file marker is encountered.

readAndSetLength

void readAndSetLength(long position)

Reads and sets the length of the data or metadata at the specified position.

Parameters:

position - The position from which to start reading the length.

readFirstHeader

void readFirstHeader(long timeout,
                     TimeUnit timeUnit)
              throws TimeoutException,
                     StreamCorruptedException

Reads the first header in the stream with a timeout.

Parameters:

timeout - Maximum time to wait for a header to be available.

timeUnit - The unit of time for the timeout.

Throws:

TimeoutException - If no header is read within the given timeout.

StreamCorruptedException - If there is an error in reading the header due to stream corruption.

readFirstHeader

void readFirstHeader()
              throws StreamCorruptedException

Reads the first header in the stream.

Throws:

StreamCorruptedException - If there is an error in reading the header due to stream corruption.

readMetaDataHeader

void readMetaDataHeader()

Reads the metadata header from the current position in the stream.

readingPeekYaml

String readingPeekYaml()

Peeks at the content in the current WireIn instance and returns it as a YAML string.

Returns:

A String containing a YAML representation of the peeked content.

startEvent

default void startEvent()

Marks the start of an event or method flow.

isEndEvent

default boolean isEndEvent()

Checks if the current position in the stream represents the end of an event or method flow.

Returns:

true if the current position is the end of an event, otherwise false.

endEvent

default void endEvent()

Marks the end of an event or method flow.

hintReadInputOrder

default boolean hintReadInputOrder()

Provides a hint about the order in which the input should be read.

Returns:

true if the input should be read in a specific order, otherwise false.

hasMetaDataPrefix

default boolean hasMetaDataPrefix()

Checks if the current position in the stream has a metadata prefix.

Returns:

true if there's a metadata prefix at the current position, otherwise false.