net.openhft.chronicle.wire

Interface WireOut

All Superinterfaces:

DocumentWritten, MarshallableOut, WireCommon

All Known Subinterfaces:

Wire

All Known Implementing Classes:

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

public interface WireOut
extends WireCommon, MarshallableOut

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WireOut.EndOfWire

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
@NotNull WireOut	addPadding(int paddingToAdd)
void	clear() This will reset the positions and the header number.
default @NotNull WireOut	dropDefault(boolean dropDefault)
default WireOut.EndOfWire	endOfWire(boolean writeEOF, long timeout, TimeUnit timeUnit, long lastPosition) Check if end of wire marker is present, optionally writing it unless one is already written.
long	enterHeader(long safeLength)
@NotNull ValueOut	getValueOut() Obtain the value out
ObjectOutput	objectOutput()
default @NotNull WireOut	padToCacheAlign() If near the end of a cache line, pad it so a following 4-byte int value will not split a cache line.
void	updateFirstHeader() update the first header after writing.
void	updateHeader(long position, boolean metaData, int expectedHeader)
@NotNull ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence key)
@NotNull ValueOut	write(WireKey key) Write a key for wires that support fields.
default @NotNull WireOut	writeAlignTo(int alignment, int plus)
default <K,V> void	writeAllAsMap(Class<K> kClass, Class<V> vClass, @NotNull Map<K,V> map)
@NotNull WireOut	writeComment(CharSequence s)
default void	writeDocument(boolean metaData, @NotNull WriteMarshallable writer) This will increment the headerNumber as appropriate if successful
void	writeEndEvent()
boolean	writeEndOfWire(long timeout, TimeUnit timeUnit, long lastPosition) Write the end of wire marker, unless one is already written.
default ValueOut	writeEvent(Class expectedType, Object eventKey)
default ValueOut	writeEventId(int methodId)
default ValueOut	writeEventId(String name, int methodId)
default ValueOut	writeEventName(CharSequence key)
default @NotNull ValueOut	writeEventName(WireKey key) Always write a key.
boolean	writeFirstHeader() Start the first header, if there is none This will increment the headerNumber as appropriate if successful
default void	writeNotCompleteDocument(boolean metaData, @NotNull WriteMarshallable writer) This will increment the headerNumber as appropriate if successful This is used in networking, but no longer used in queue.
void	writeStartEvent() Start an event object, mostly for internal use.
default @NotNull DocumentContext	writingDocument() Start a document which is completed when DocumentContext.close() is called.
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful
default boolean	writingIsComplete()

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.MarshallableOut

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

Method Detail

write

@NotNull
@NotNull ValueOut write()

Write an empty filed marker

writeEventName

@NotNull
default @NotNull ValueOut writeEventName(WireKey key)

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

writeEventName

default ValueOut writeEventName(CharSequence key)

writeEvent

default ValueOut writeEvent(Class expectedType,
                            Object eventKey)

writeEventId

default ValueOut writeEventId(int methodId)

writeEventId

default ValueOut writeEventId(String name,
                              int methodId)

write

@NotNull
@NotNull ValueOut write(WireKey key)

Write a key for wires that support fields.

write

ValueOut write(CharSequence key)

getValueOut

@NotNull
@NotNull ValueOut getValueOut()

Obtain the value out

objectOutput

ObjectOutput objectOutput()

writeComment

@NotNull
@NotNull WireOut writeComment(CharSequence s)

addPadding

@NotNull
@NotNull WireOut addPadding(int paddingToAdd)

padToCacheAlign

@NotNull
default @NotNull WireOut padToCacheAlign()

If near the end of a cache line, pad it so a following 4-byte int value will not split a cache line.

Returns:

this

writeAlignTo

@NotNull
default @NotNull WireOut writeAlignTo(int alignment,
                                               int plus)

clear

void clear()

This will reset the positions and the header number.

Specified by:

clear in interface WireCommon

writeDocument

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

This will increment the headerNumber as appropriate if successful

writingDocument

DocumentContext writingDocument(boolean metaData)

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Parameters:

metaData - if true the document context will be used for writing meta data, otherwise data

Returns:

a document context used for witting

writingDocument

@NotNull
default @NotNull DocumentContext writingDocument()

Description copied from interface: MarshallableOut

Start a document which is completed when DocumentContext.close() is called. You can use a

 try(DocumentContext dc = appender.writingDocument()) {
      dc.wire().write("message").text("Hello World");
 }
 

WARNING : any data written inside the writingDocument(), should be performed as quickly as possible because a write lock is held until the DocumentContext is closed by the try-with-resources, this blocks other appenders and tailers.

 try (DocumentContext dc = appender.writingDocument()) {
      // this should be performed as quickly as possible because a write lock is held until
 the
      // DocumentContext is closed by the try-with-resources,  this blocks other appenders
      and tailers.
 }
 

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Returns:

a context to use in a try-with-resource block

acquireWritingDocument

DocumentContext acquireWritingDocument(boolean metaData)

Description copied from interface: MarshallableOut

Start or reuse an existing a DocumentContext, optionally call close() when done.

Specified by:

acquireWritingDocument in interface DocumentWritten

Specified by:

acquireWritingDocument in interface MarshallableOut

writeNotCompleteDocument

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

This will increment the headerNumber as appropriate if successful

This is used in networking, but no longer used in queue.

Parameters:

metaData - true if the write should write metaData rather than data

writer - writes bytes to the wire

updateHeader

void updateHeader(long position,
                  boolean metaData,
                  int expectedHeader)
           throws StreamCorruptedException

Throws:

StreamCorruptedException

enterHeader

long enterHeader(long safeLength)

writeFirstHeader

boolean writeFirstHeader()

Start the first header, if there is none This will increment the headerNumber as appropriate if successful

Note: the file might contain other data and the caller has to check this.

Returns:

true if the header needs to be written, false if there is a data already

updateFirstHeader

void updateFirstHeader()

update the first header after writing.

writeEndOfWire

boolean writeEndOfWire(long timeout,
                       TimeUnit timeUnit,
                       long lastPosition)

Write the end of wire marker, unless one is already written. This will increment the headerNumber as appropriate if successful

Parameters:

timeout - throw TimeoutException if it could not write the marker in time.

timeUnit - of the timeout

lastPosition - the end of the wire

Returns:

{code true} if did this method wrote EOF, false if it was already there.

endOfWire

default WireOut.EndOfWire endOfWire(boolean writeEOF,
                                    long timeout,
                                    TimeUnit timeUnit,
                                    long lastPosition)

Check if end of wire marker is present, optionally writing it unless one is already written. This will increment the headerNumber as appropriate if successful

Parameters:

writeEOF - if true, write end of wire marker unless already exists

timeout - throw TimeoutException if it could not write the marker in time.

timeUnit - of the timeout

lastPosition - the end of the wire

Returns:

WireOut.EndOfWire enum corresponding to EOF presence

writeStartEvent

void writeStartEvent()

Start an event object, mostly for internal use.

writeEndEvent

void writeEndEvent()

writeAllAsMap

default <K,V> void writeAllAsMap(Class<K> kClass,
                                 Class<V> vClass,
                                 @NotNull
                                 @NotNull Map<K,V> map)

dropDefault

@NotNull
default @NotNull WireOut dropDefault(boolean dropDefault)

writingIsComplete

default boolean writingIsComplete()

Returns:

true unless there is an incomplete/chained message