net.openhft.chronicle.wire

Interface WireOut

All Superinterfaces:

WireCommon

All Known Subinterfaces:

Wire

All Known Implementing Classes:

BinaryWire, 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 (for internal use)
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, java.util.function.Consumer<WireOut> writer)
default ValueOut	writeEventName(WireKey key) Always write a key.
default void	writeNotReadyDocument(boolean metaData, java.util.function.Consumer<WireOut> writer)
ValueOut	writeValue() write a field less value.

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.

writeValue

@NotNull
ValueOut writeValue()

write a field less value.

getValueOut

@NotNull
ValueOut getValueOut()

Obtain the value out (for internal use)

writeComment

@NotNull
WireOut writeComment(CharSequence s)

addPadding

@NotNull
WireOut addPadding(int paddingToAdd)

writeAlignTo

default WireOut writeAlignTo(int alignment)

writeDocument

default void writeDocument(boolean metaData,
                           @NotNull
                           java.util.function.Consumer<WireOut> writer)

writeNotReadyDocument

default void writeNotReadyDocument(boolean metaData,
                                   @NotNull
                                   java.util.function.Consumer<WireOut> writer)