net.openhft.chronicle.wire

Interface WireOut

All Superinterfaces:

WireCommon

All Known Subinterfaces:

InternalWire, Wire

All Known Implementing Classes:

BinaryWire, CSVWire, JSONWire, QueryWire, RawWire, TextWire

public interface WireOut
extends WireCommon

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

Created by peter.lawrey on 12/01/15.

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
ValueOut	getValueOut() Obtain the value out
ValueOut	write() Write an empty filed marker
ValueOut	write(WireKey key) Write a key for wires that support fields.
default WireOut	writeAlignTo(int alignment)
WireOut	writeComment(CharSequence s)
default void	writeDocument(boolean metaData, WriteMarshallable writer)
default ValueOut	writeEventName(WireKey key) Always write a key.
default void	writeNotReadyDocument(boolean metaData, WriteMarshallable writer)
DocumentContext	writingDocument(boolean metaData)

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

bytes, newIntReference, newLongArrayReference, newLongReference

Method Detail

write

@NotNull
ValueOut write()

Write an empty filed marker

writeEventName

@NotNull
default ValueOut writeEventName(WireKey key)

Always write a key. For RAW types, this label with be in text. To read this, use readEventName()

write

@NotNull
ValueOut write(WireKey key)

Write a key for wires that support fields.

getValueOut

@NotNull
ValueOut getValueOut()

Obtain the value out

writeComment

@NotNull
WireOut writeComment(CharSequence s)

addPadding

@NotNull
WireOut addPadding(int paddingToAdd)

writeAlignTo

@NotNull
default WireOut writeAlignTo(int alignment)

writeDocument

default void writeDocument(boolean metaData,
                           @NotNull
                           WriteMarshallable writer)

writingDocument

DocumentContext writingDocument(boolean metaData)

writeNotReadyDocument

default void writeNotReadyDocument(boolean metaData,
                                   @NotNull
                                   WriteMarshallable writer)