net.openhft.chronicle.wire

Interface WireOut

All Superinterfaces:

MarshallableOut, WireCommon

All Known Subinterfaces:

Wire

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, DeferredTypeWire, HashWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire

public interface WireOut
extends WireCommon, MarshallableOut

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

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

Nested Class Summary

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

MarshallableOut.Padding

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SAFE_LENGTH
static long	TRY_WRITE_HEADER_FAILED

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
void	clear() This will reset the positions and the header number.
default WireOut	dropDefault(boolean dropDefault)
void	endEvent()
ValueOut	getValueOut() Obtain the value out
ObjectOutput	objectOutput()
default 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	startEvent() Start an event object, mostly for internal use.
long	tryWriteHeader(int safeLength) Makes a single attempt to try and write the header.
void	updateFirstHeader() update the first header after writing.
void	updateHeader(long position, boolean metaData) Change the header from NOT_COMPLETE | UNKNOWN_LENGTH to metaData * META_DATA | length.
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence key)
ValueOut	write(WireKey key) Write a key for wires that support fields.
default WireOut	writeAlignTo(int alignment, int plus)
default <K,V> void	writeAllAsMap(Class<K> kClass, Class<V> vClass, Map<K,V> map)
WireOut	writeComment(CharSequence s)
default void	writeDocument(boolean metaData, WriteMarshallable writer) This will increment the headerNumber as appropriate if successful
void	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	writeEventName(CharSequence key)
default 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 long	writeHeader(long timeout, TimeUnit timeUnit, net.openhft.chronicle.core.values.LongValue lastPosition, Sequence sequence) Write a new header, an unknown length, handling timeouts and the end of wire marker.
long	writeHeaderOfUnknownLength(int safeLength, long timeout, TimeUnit timeUnit, net.openhft.chronicle.core.values.LongValue lastPosition, Sequence sequence) Write a message of unknown length, handling timeouts and the end of wire marker.
default long	writeHeaderOfUnknownLength(long timeout, TimeUnit timeUnit, net.openhft.chronicle.core.values.LongValue lastPosition, Sequence sequence)
default void	writeNotCompleteDocument(boolean metaData, WriteMarshallable writer) Deprecated.
default 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

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

bytes, bytesComment, classLookup, classLookup, endUse, headerNumber, headerNumber, newBooleanReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, startUse

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

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

Field Detail

TRY_WRITE_HEADER_FAILED

static final long TRY_WRITE_HEADER_FAILED

See Also:

Constant Field Values

DEFAULT_SAFE_LENGTH

static final int DEFAULT_SAFE_LENGTH

See Also:

Constant Field Values

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

writeEventName

default ValueOut writeEventName(CharSequence key)

writeEvent

default ValueOut writeEvent(Class expectedType,
                            Object eventKey)

writeEventId

default ValueOut writeEventId(int methodId)

write

@NotNull
ValueOut write(WireKey key)

Write a key for wires that support fields.

write

ValueOut write(CharSequence key)

getValueOut

@NotNull
ValueOut getValueOut()

Obtain the value out

objectOutput

ObjectOutput objectOutput()

writeComment

@NotNull
WireOut writeComment(CharSequence s)

addPadding

@NotNull
WireOut addPadding(int paddingToAdd)

padToCacheAlign

@NotNull
default 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 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
                           WriteMarshallable writer)

This will increment the headerNumber as appropriate if successful

Parameters:

metaData -

writer -

writingDocument

DocumentContext writingDocument(boolean metaData)

This will increment the headerNumber as appropriate if successful

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

writeNotCompleteDocument

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

Deprecated.

This will increment the headerNumber as appropriate if successful This method has been deprecated. Writing an incomplete document with a known length is no longer supported.

Parameters:

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

writer - writes bytes to the wire

writeHeader

default long writeHeader(long timeout,
                         TimeUnit timeUnit,
                         @Nullable
                         net.openhft.chronicle.core.values.LongValue lastPosition,
                         Sequence sequence)
                  throws TimeoutException,
                         EOFException

Write a new header, an unknown length, handling timeouts and the end of wire marker. This will increment the headerNumber as appropriate if successful

Parameters:

timeout - throw a TimeoutException if the header could not be written in this time.

timeUnit - of the timeOut

lastPosition - the last known position

sequence - sequence number access

Returns:

the position of the start of the header

Throws:

TimeoutException - the underlying pauser timed out.

EOFException - the end of wire marker was reached.

updateHeader

void updateHeader(long position,
                  boolean metaData)
           throws StreamCorruptedException,
                  EOFException

Change the header from NOT_COMPLETE | UNKNOWN_LENGTH to metaData * META_DATA | length.

Parameters:

position - returned by writeHeader

metaData - whether the message is meta data or not.

Throws:

StreamCorruptedException - if the steam has become corrupted

EOFException

writeHeaderOfUnknownLength

long writeHeaderOfUnknownLength(int safeLength,
                                long timeout,
                                TimeUnit timeUnit,
                                @Nullable
                                net.openhft.chronicle.core.values.LongValue lastPosition,
                                Sequence sequence)
                         throws TimeoutException,
                                EOFException

Write a message of unknown length, handling timeouts and the end of wire marker. This will increment the headerNumber as appropriate if successful

Parameters:

timeout - throw a TimeoutException if the header could not be written in this time.

timeUnit - of the timeOut

lastPosition - the last known position

Returns:

the position of the start of the header

Throws:

TimeoutException - the underlying pauser timed out.

EOFException - the end of wire marker was reached.

writeHeaderOfUnknownLength

default long writeHeaderOfUnknownLength(long timeout,
                                        TimeUnit timeUnit,
                                        @Nullable
                                        net.openhft.chronicle.core.values.LongValue lastPosition,
                                        Sequence sequence)
                                 throws TimeoutException,
                                        EOFException

Throws:

TimeoutException

EOFException

tryWriteHeader

long tryWriteHeader(int safeLength)

Makes a single attempt to try and write the header.

Parameters:

safeLength - assume this safe length

Returns:

TRY_WRITE_HEADER_FAILED if it failed, otherwise the position of the start of the header

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

void 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

startEvent

void startEvent()

Start an event object, mostly for internal use.

endEvent

void endEvent()

writeAllAsMap

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

dropDefault

@NotNull
default WireOut dropDefault(boolean dropDefault)