net.openhft.chronicle.wire

Interface Wire

All Superinterfaces:

DocumentWritten, MarshallableIn, MarshallableOut, WireCommon, WireIn, WireOut

All Known Implementing Classes:

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

public interface Wire
extends WireIn, WireOut

The defines the stand interface for writing and reading sequentially to/from a Bytes stream. It is used to write and read data in a wire format.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireIn

WireIn.HeaderType

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireOut

WireOut.EndOfWire

Field Summary

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

MARSHALLABLE_IN_INTERN_SIZE

Method Summary

Modifier and Type	Method and Description
static Wire	fromFile(@NotNull String name) Deprecated.
@NotNull Wire	headerNumber(long headerNumber)
static Wire	newYamlWireOnHeap() Create a YamlWire that write to an on heap Bytes

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

asText, clear, commentListener, consumePadding, copyTo, endEvent, getValueIn, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, read, read, read, read, readAlignTo, readAllAsMap, readAndSetLength, readComment, readDataHeader, readDataHeader, readDocument, readDocument, readEvent, readEventName, readEventNumber, readFirstHeader, readFirstHeader, readingDocument, readingDocument, readingPeekYaml, readMetaDataHeader, startEvent

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

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

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

acquireWritingDocument, addPadding, clear, dropDefault, endOfWire, enterHeader, getValueOut, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, write, write, write, writeAlignTo, writeAllAsMap, writeComment, writeDocument, writeEndEvent, writeEndOfWire, writeEvent, writeEventId, writeEventId, writeEventName, writeEventName, writeFirstHeader, writeNotCompleteDocument, writeStartEvent, writingDocument, writingDocument, writingIsComplete

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

bytes, bytesComment, classLookup, classLookup, 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.MarshallableOut

builder, methodWriter, methodWriter, methodWriterBuilder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

Method Detail

fromFile

@Deprecated
static Wire fromFile(@NotNull
                                 @NotNull String name)
                          throws IOException

Deprecated.

Throws:

IOException

newYamlWireOnHeap

static Wire newYamlWireOnHeap()

Create a YamlWire that write to an on heap Bytes

Returns:

the Wire

headerNumber

@NotNull
@NotNull Wire headerNumber(long headerNumber)

Specified by:

headerNumber in interface WireCommon