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

The defines the stand interface for writing and reading sequentially to/from a Bytes stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WireIn.HeaderType

Field Summary

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

MARSHALLABLE_IN_INTERN_SIZE

Method Summary

Modifier and Type	Method and Description
default @Nullable CharSequence	asText() Deprecated.
void	clear() Resets the state of the underlying Bytes stored by the wire.
void	commentListener(Consumer<CharSequence> commentListener)
void	consumePadding()
void	copyTo(@NotNull WireOut wire)
default void	endEvent()
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
default boolean	hasMetaDataPrefix()
default boolean	hasMore() This consumes any padding before checking if readRemaining() > 0
default boolean	hintReadInputOrder()
default boolean	isEmpty()
default boolean	isEndEvent()
default boolean	isNotEmptyAfterPadding() This consumes any padding before checking if readRemaining() > 0
ObjectInput	objectInput()
default void	rawReadData(@NotNull ReadMarshallable marshallable)
@NotNull ValueIn	read() Read the field if present, or empty string if not present.
default @NotNull ValueIn	read(String fieldName)
@NotNull ValueIn	read(@NotNull StringBuilder name) Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull WireKey key) Read the field if present which must match the WireKey.
default @NotNull WireIn	readAlignTo(int alignment)
default <K,V> @NotNull Map<K,V>	readAllAsMap(Class<K> kClass, @NotNull Class<V> vClass, @NotNull Map<K,V> map)
void	readAndSetLength(long position)
@NotNull WireIn	readComment(@NotNull StringBuilder sb)
default boolean	readDataHeader() Consume a header if one is available.
@NotNull WireIn.HeaderType	readDataHeader(boolean includeMetaData)
default boolean	readDocument(long position, @Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)
default boolean	readDocument(@Nullable ReadMarshallable metaDataConsumer, @Nullable ReadMarshallable dataConsumer)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
default @NotNull ValueIn	readEventName(@NotNull StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
long	readEventNumber()
void	readFirstHeader()
void	readFirstHeader(long timeout, TimeUnit timeUnit)
@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)
String	readingPeekYaml()
void	readMetaDataHeader()
default void	startEvent()

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

copyTo

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

read

@NotNull
@NotNull ValueIn read()

Read the field if present, or empty string if not present.

read

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

Read the field if present which must match the WireKey.

read

@NotNull
default @NotNull ValueIn read(String fieldName)

readEventNumber

long readEventNumber()

Returns:

field number or Long.MIN_VALUE if no number.

readEventName

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

Read a field, or string which is always written, even for formats which might drop the field such as RAW.

read

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

Read the field if present, or empty string if not present.

readEvent

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

Read a field which might be an object of any type.

Use getValueIn() to read the value for this event

Parameters:

expectedClass - to use as a hint, or Object.class if no hint available.

Returns:

an instance of expectedClass

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

getValueIn

@NotNull
@NotNull ValueIn getValueIn()

Obtain the value in for advanced use (typically after a call to readEvent above)

objectInput

ObjectInput objectInput()

readComment

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

clear

void clear()

Description copied from interface: WireCommon

Resets the state of the underlying Bytes stored by the wire.

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()

readAlignTo

@NotNull
default @NotNull WireIn readAlignTo(int alignment)

readDocument

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readDocument

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

rawReadData

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

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)

consumePadding

void consumePadding()

commentListener

void commentListener(Consumer<CharSequence> commentListener)

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

Throws:

EOFException

readAndSetLength

void readAndSetLength(long position)

readFirstHeader

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

Throws:

TimeoutException

StreamCorruptedException

readFirstHeader

void readFirstHeader()
              throws StreamCorruptedException

Throws:

StreamCorruptedException

readMetaDataHeader

void readMetaDataHeader()

asText

@Deprecated
 @Nullable
default @Nullable CharSequence asText()

Deprecated.

readingPeekYaml

String readingPeekYaml()

startEvent

default void startEvent()

isEndEvent

default boolean isEndEvent()

endEvent

default void endEvent()

hintReadInputOrder

default boolean hintReadInputOrder()

hasMetaDataPrefix

default boolean hasMetaDataPrefix()