net.openhft.chronicle.wire

Class BinaryWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.BinaryWire

All Implemented Interfaces:

DocumentWritten, InternalWire, MarshallableIn, MarshallableOut, RollbackIfNotCompleteNotifier, Wire, WireCommon, WireIn, WireOut

public class BinaryWire
extends AbstractWire
implements Wire

Primary implementation of the binary wire format. The binary form is optimised for performance and size, often omitting field names in favour of numeric identifiers or relying on the DTO's field order for field-less serialisation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BinaryWire.BinaryValueIn Represents a binary input value and provides methods to read and manage the state of this binary input.
protected class	BinaryWire.BinaryValueOut Extends the FixedBinaryValueOut class to support binary value outputs with additional logic for converting and writing different types of numbers, namely integers and longs.
protected class	BinaryWire.FixedBinaryValueOut Implementation of the ValueOut interface, providing methods to write values in a fixed binary format.

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

Modifier and Type	Field and Description
protected @NotNull BinaryWire.BinaryValueIn	valueIn

Fields inherited from class net.openhft.chronicle.wire.AbstractWire

bytes, classLookup, commentListener, DEFAULT_USE_PADDING, parent, use8bit

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

MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors

Constructor and Description
BinaryWire() Constructs a BinaryWire with default settings and elastic on-heap bytes.
BinaryWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Constructs a BinaryWire with default settings.
BinaryWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean fixed, boolean numericFields, boolean fieldLess, int compressedSize, String compression) Constructs a BinaryWire with specified configurations.
BinaryWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean fixed, boolean numericFields, boolean fieldLess, int compressedSize, String compression, boolean supportDelta) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected @NotNull StringBuilder	acquireStringBuilder() Acquires and clears the internal StringBuilder for use.
DocumentContext	acquireWritingDocument(boolean metaData) Acquire an existing document context for writing if one is open.
@NotNull WireOut	addPadding(int paddingToAdd) Adds padding to the wire.
protected void	anchor(@NotNull WireOut wire) Anchor support is not implemented for binary wires.
static @NotNull BinaryWire	binaryOnly(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Creates and returns a new instance of BinaryWire with the delta support disabled.
void	clear() Clears the underlying bytes and resets valueIn and valueOut to their initial states.
void	consumePadding() Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
void	copyOne(@NotNull WireOut wire) Copies one unit of data from this BinaryWire to the provided WireOut instance.
void	copyTo(@NotNull WireOut wire) Efficiently copies the remaining content.
protected void	fieldAnchor(@NotNull WireOut wire) Placeholder or handler for field anchor processing in the WireOut stream.
boolean	fieldLess() Checks and returns if this BinaryWire instance is field-less.
protected @NotNull BinaryWire.FixedBinaryValueOut	getFixedBinaryValueOut(boolean fixed) Factory hook for subclasses.
Boolean	getOverrideSelfDescribing() Returns the override flag controlling whether objects are written in self-describing form.
@NotNull ValueIn	getValueIn() Obtains the value associated with a field or event for more advanced use cases.
@NotNull ValueOut	getValueOut() Retrieves the interface for defining the output of a value that will be written to the stream.
boolean	isBinary() Determine whether direct access to the underlying byte() makes sense or should it be treated as text
@NotNull net.openhft.chronicle.core.values.BooleanValue	newBooleanReference() Creates and returns a new BooleanValue.
@NotNull net.openhft.chronicle.core.values.IntArrayValues	newIntArrayReference() Creates and returns a new IntArrayValues.
@NotNull net.openhft.chronicle.core.values.IntValue	newIntReference() Creates and returns a new IntValue.
@NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference	newLongArrayReference() Creates and returns a new LongArrayValues.
@NotNull net.openhft.chronicle.core.values.LongValue	newLongReference() Creates and returns a new LongValue.
@NotNull net.openhft.chronicle.core.values.TwoLongValue	newTwoLongReference() Creates and returns a new TwoLongValue.
protected int	peekCode() Peeks the code from the current position without advancing the read pointer.
@NotNull ValueIn	read() Read the next value when field ordering is not known.
@NotNull ValueIn	read(@NotNull String fieldName) Look up a field by name.
@NotNull ValueIn	read(@NotNull StringBuilder name) Reads the next field identifier into name.
@NotNull ValueIn	read(@NotNull WireKey key) Look up a value using a WireKey.
protected <T> ValueIn	read2(CharSequence keyName, int keyCode, T defaultSource, @NotNull Function<T,Object> defaultLookup, @NotNull net.openhft.chronicle.wire.ValueInState curr, @NotNull StringBuilder sb, CharSequence name) A secondary method to continue the field search process, specifically to handle cases where the field may have been missed in a previous pass or if the field still hasn't been found.
@NotNull Wire	readComment(@NotNull StringBuilder s) If the next token is BinaryWireCode.COMMENT the UTF-8 text is read into s; otherwise s is cleared.
<K> K	readEvent(@NotNull Class<K> expectedClass) Reads the next event identifier, which may be encoded as a short string embedded in the field code, a longer string or a numeric ID, and converts it to expectedClass.
@NotNull ValueIn	readEventName(@NotNull StringBuilder name) Reads the next field identifier into name.
long	readEventNumber() Reads a BinaryWireCode.FIELD_NUMBER followed by a stop-bit encoded integer representing a method or event identifier.
protected @NotNull StringBuilder	readFieldNumber(CharSequence keyName, int keyCode, @NotNull StringBuilder sb, long fieldId) Reads a field number from the wire and populates the provided StringBuilder.
@NotNull DocumentContext	readingDocument() Start a reading document context.
@NotNull DocumentContext	readingDocument(long readLocation) Start a reading document context from a specific position.
@NotNull String	readingPeekYaml() Typicality used for debugging, this method does not progress the read position and should only be used when inside a reading document.
void	readWithLength(@NotNull WireOut wire, int len) Reads data of a specified length from the bytes stream and writes to the WireOut stream while interpreting the type of data (Map, Sequence, or Object).
void	reset() Resets this wire to its initial state, clearing bytes and document contexts so the instance can be reused.
void	rollbackIfNotComplete() Rolls back the current operation if it is not complete.
BinaryWire	setOverrideSelfDescribing(Boolean overrideSelfDescribing) Overrides how type information is written for objects serialised by this wire.
@NotNull String	toString() Converts the current state of the bytes storage to a debug string.
protected static void	unexpectedCode() Throw an IORuntimeException for an unexpected code.
protected void	unknownCode(@NotNull WireOut wire) Throw an IllegalArgumentException if a code cannot be recognised.
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Determines whether a given object should use the self-describing message format.
@NotNull ValueOut	write() Writes an empty field marker to the stream.
@NotNull ValueOut	write(@NotNull CharSequence key) Writes a CharSequence key to the stream.
@NotNull ValueOut	write(@NotNull WireKey key) Writes a WireKey to the stream.
protected net.openhft.chronicle.bytes.Bytes<?>	writeCode(int code) Writes a byte code to the byte buffer.
@NotNull Wire	writeComment(CharSequence s) Writes a comment to the wire.
void	writeEndEvent()
ValueOut	writeEventId(int methodId) Writes an event identifier to the stream.
ValueOut	writeEventId(String name, int methodId) Writes an event identifier with a name to the stream.
@NotNull ValueOut	writeEventName(@NotNull CharSequence name) Writes a CharSequence key to the stream.
@NotNull ValueOut	writeEventName(@NotNull WireKey key) Writes a key to the stream.
void	writeStartEvent() Start an event object, mostly for internal use.
@NotNull DocumentContext	writingDocument(boolean metaData) Begin writing a document context.
boolean	writingIsComplete() Checks if the current writing operation is complete.

Methods inherited from class net.openhft.chronicle.wire.AbstractWire

bytes, bytesComment, classLookup, classLookup, commentListener, endOfWire, enterHeader, forceNotInsideHeader, generateTuples, generateTuples, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readFirstHeader, readFirstHeader, readMetaDataHeader, updateFirstHeader, updateFirstHeader, updateHeader, usePadding, usePadding, writeEndOfWire, writeFirstHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

generateTuples, generateTuples, headerNumber, newYamlWireOnHeap

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

commentListener, endEvent, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readFirstHeader, readFirstHeader, 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

dropDefault, endOfWire, enterHeader, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEvent, writeFirstHeader, writeNotCompleteDocument, writingDocument

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

bytes, bytesComment, classLookup, classLookup, headerNumber, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, usePadding, usePadding

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

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

Field Detail

valueIn

@NotNull
protected final @NotNull BinaryWire.BinaryValueIn valueIn

Constructor Detail

BinaryWire

public BinaryWire()

Constructs a BinaryWire with default settings and elastic on-heap bytes.

BinaryWire

public BinaryWire(@NotNull
                  @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Constructs a BinaryWire with default settings.

Parameters:

bytes - the bytes to be processed by this wire

BinaryWire

public BinaryWire(@NotNull
                  @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                  boolean fixed,
                  boolean numericFields,
                  boolean fieldLess,
                  int compressedSize,
                  String compression)

Constructs a BinaryWire with specified configurations.

Parameters:

bytes - The bytes to be processed by this wire

fixed - Indicates whether the value output is fixed

numericFields - Indicates if fields are represented numerically

fieldLess - Indicates if fields are absent

compressedSize - Threshold size for compression

compression - Type of compression (e.g., "binary")

BinaryWire

@Deprecated
public BinaryWire(@NotNull
                              @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                              boolean fixed,
                              boolean numericFields,
                              boolean fieldLess,
                              int compressedSize,
                              String compression,
                              boolean supportDelta)

Deprecated.

Same as the main constructor but with a legacy supportDelta parameter which is ignored as delta wire format is not supported.

Parameters:

bytes - The bytes to be processed by this wire

fixed - Indicates whether the value output is fixed

numericFields - Indicates if fields are represented numerically

fieldLess - Indicates if fields are absent

compressedSize - Threshold size for compression

compression - Type of compression (e.g., "binary")

supportDelta - must be false

Method Detail

binaryOnly

@NotNull
public static @NotNull BinaryWire binaryOnly(@NotNull
                                                      @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Creates and returns a new instance of BinaryWire with the delta support disabled.

Parameters:

bytes - The bytes to be processed by this wire

Returns:

A new instance of BinaryWire

reset

public void reset()

Resets this wire to its initial state, clearing bytes and document contexts so the instance can be reused.

Specified by:

reset in interface WireCommon

rollbackIfNotComplete

public void rollbackIfNotComplete()

Description copied from interface: RollbackIfNotCompleteNotifier

Rolls back the current operation if it is not complete. If the current document or operation managed by this notifier is in an incomplete state (for example as indicated by DocumentContext.isNotComplete()), this method should attempt to roll back any changes made within the current context, effectively discarding them. If rollback is not supported or not applicable, an UnsupportedOperationException may be thrown.

Specified by:

rollbackIfNotComplete in interface RollbackIfNotCompleteNotifier

isBinary

public boolean isBinary()

Description copied from interface: WireCommon

Determine whether direct access to the underlying byte() makes sense or should it be treated as text

Specified by:

isBinary in interface WireCommon

Returns:

Is this a binary protocol

getOverrideSelfDescribing

public Boolean getOverrideSelfDescribing()

Returns the override flag controlling whether objects are written in self-describing form. The values mean:

• null – use each object's own setting
• true – always write type information
• false – never write type information

setOverrideSelfDescribing

public BinaryWire setOverrideSelfDescribing(Boolean overrideSelfDescribing)

Overrides how type information is written for objects serialised by this wire.

Parameters:

overrideSelfDescribing - see getOverrideSelfDescribing()

Returns:

this for chaining

acquireStringBuilder

@NotNull
protected @NotNull StringBuilder acquireStringBuilder()

Acquires and clears the internal StringBuilder for use. This method is used to avoid frequent instantiation of new StringBuilder objects, improving performance.

Returns:

A cleared instance of the internal StringBuilder.

getFixedBinaryValueOut

@NotNull
protected @NotNull BinaryWire.FixedBinaryValueOut getFixedBinaryValueOut(boolean fixed)

Factory hook for subclasses. Returns fixedValueOut when fixed is true; otherwise a fresh BinaryWire.BinaryValueOut.

clear

public void clear()

Clears the underlying bytes and resets valueIn and valueOut to their initial states.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireIn

Specified by:

clear in interface WireOut

Overrides:

clear in class AbstractWire

fieldLess

public boolean fieldLess()

Checks and returns if this BinaryWire instance is field-less.

Returns:

true if the BinaryWire is field-less, false otherwise.

writingDocument

@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)

Begin writing a document context. See WireOut.writingDocument(boolean). Returns a BinaryWriteDocumentContext.

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

metaData - If true, the returned document context will be used for writing metadata.

Returns:

A context for the document being written.

acquireWritingDocument

public DocumentContext acquireWritingDocument(boolean metaData)

Acquire an existing document context for writing if one is open. See WireOut.acquireWritingDocument(boolean). Returns a BinaryWriteDocumentContext.

Specified by:

acquireWritingDocument in interface DocumentWritten

Specified by:

acquireWritingDocument in interface MarshallableOut

Specified by:

acquireWritingDocument in interface WireOut

Parameters:

metaData - If true, the returned context will be used for writing metadata.

Returns:

A context for the document being written.

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument()

Start a reading document context. See WireIn.readingDocument(). Returns a BinaryReadDocumentContext.

Specified by:

readingDocument in interface MarshallableIn

Specified by:

readingDocument in interface WireIn

Returns:

the document context

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)

Start a reading document context from a specific position. See WireIn.readingDocument(long). Returns a BinaryReadDocumentContext.

Specified by:

readingDocument in interface WireIn

Parameters:

readLocation - The position from which to start reading the document.

Returns:

the document context associated with the specific read location.

readingPeekYaml

@NotNull
public @NotNull String readingPeekYaml()

Typicality used for debugging, this method does not progress the read position and should only be used when inside a reading document.

Specified by:

readingPeekYaml in interface WireIn

Returns:

when readReading a document returns the current document as a YAML String, if you are not currently reading a document, and empty string will be return.

copyTo

public void copyTo(@NotNull
                   @NotNull WireOut wire)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Efficiently copies the remaining content. If wire is also a BinaryWire, bytes are copied directly; otherwise each token is decoded and re-encoded.

Specified by:

copyTo in interface WireIn

Parameters:

wire - The WireOut instance where the content will be copied to.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

copyOne

public void copyOne(@NotNull
                    @NotNull WireOut wire)
             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Copies one unit of data from this BinaryWire to the provided WireOut instance.

Parameters:

wire - The destination WireOut instance.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if the operation encounters an error during marshalling.

unexpectedCode

protected static void unexpectedCode()
                              throws net.openhft.chronicle.core.io.IORuntimeException

Throw an IORuntimeException for an unexpected code.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

anchor

protected void anchor(@NotNull
                      @NotNull WireOut wire)

Anchor support is not implemented for binary wires. This method always throws via unexpectedCode().

Parameters:

wire - The wire output stream.

fieldAnchor

protected void fieldAnchor(@NotNull
                           @NotNull WireOut wire)

Placeholder or handler for field anchor processing in the WireOut stream. This implementation throws an exception indicating it's unexpected in this context.

Parameters:

wire - The wire output stream.

readWithLength

public void readWithLength(@NotNull
                           @NotNull WireOut wire,
                           int len)
                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads data of a specified length from the bytes stream and writes to the WireOut stream while interpreting the type of data (Map, Sequence, or Object).

Parameters:

wire - The wire output stream to write data to.

len - The length of data to be read.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an issue during marshalling.

unknownCode

protected void unknownCode(@NotNull
                           @NotNull WireOut wire)
                    throws IllegalArgumentException

Throw an IllegalArgumentException if a code cannot be recognised.

Throws:

IllegalArgumentException

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull String fieldName)

Look up a field by name.

Specified by:

read in interface WireIn

Parameters:

fieldName - The name of the field to read.

Returns:

The value of the specified field, encapsulated in a ValueIn instance.

read

@NotNull
public @NotNull ValueIn read()

Read the next value when field ordering is not known.

Specified by:

read in interface WireIn

Returns:

The value of the next field, encapsulated in a ValueIn instance.

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull WireKey key)

Look up a value using a WireKey.

Specified by:

read in interface WireIn

Parameters:

key - The WireKey that should match the next field.

Returns:

The value of the matched field, encapsulated in a ValueIn instance.

read2

protected <T> ValueIn read2(CharSequence keyName,
                            int keyCode,
                            T defaultSource,
                            @NotNull
                            @NotNull Function<T,Object> defaultLookup,
                            @NotNull
                            @NotNull net.openhft.chronicle.wire.ValueInState curr,
                            @NotNull
                            @NotNull StringBuilder sb,
                            CharSequence name)

A secondary method to continue the field search process, specifically to handle cases where the field may have been missed in a previous pass or if the field still hasn't been found. It will revert to the default value if the field cannot be located.

Type Parameters:

T - The type of the default source.

Parameters:

keyName - The name of the key to be searched for.

keyCode - The code corresponding to the key.

defaultSource - The source to revert to if the key isn't found.

defaultLookup - The function used to derive a default value based on the defaultSource.

curr - The current state of ValueIn.

sb - The StringBuilder used for string manipulations during search.

name - The actual name of the field being sought.

Returns:

Returns a ValueIn object which represents the found or default value.

readEventNumber

public long readEventNumber()

Reads a BinaryWireCode.FIELD_NUMBER followed by a stop-bit encoded integer representing a method or event identifier. Returns Long.MIN_VALUE if the next token is not a field number.

Specified by:

readEventNumber in interface WireIn

Overrides:

readEventNumber in class AbstractWire

Returns:

The next event number or Long.MIN_VALUE if no number is present.

readEventName

@NotNull
public @NotNull ValueIn readEventName(@NotNull
                                               @NotNull StringBuilder name)

Reads the next field identifier into name. Returns valueIn if a field was found or defaultValueIn if not.

Specified by:

readEventName in interface WireIn

Parameters:

name - The StringBuilder that holds the name of the field or string.

Returns:

The value of the field or string, encapsulated in a ValueIn instance.

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull StringBuilder name)

Reads the next field identifier into name. Returns valueIn if present or defaultValueIn otherwise.

Specified by:

read in interface WireIn

Parameters:

name - The name of the field to read.

Returns:

The value of the specified field, encapsulated in a ValueIn instance.

getValueIn

@NotNull
public @NotNull ValueIn getValueIn()

Description copied from interface: WireIn

Obtains the value associated with a field or event for more advanced use cases. Typically used after a call to WireIn.readEvent(Class).

Specified by:

getValueIn in interface WireIn

Returns:

The value of the field or event, encapsulated in a ValueIn instance.

readComment

@NotNull
public @NotNull Wire readComment(@NotNull
                                          @NotNull StringBuilder s)

If the next token is BinaryWireCode.COMMENT the UTF-8 text is read into s; otherwise s is cleared.

Specified by:

readComment in interface WireIn

Parameters:

s - StringBuilder to which the comment will be appended.

Returns:

the WireIn instance for method chaining.

readEvent

@Nullable
public <K> K readEvent(@NotNull
                                 @NotNull Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the next event identifier, which may be encoded as a short string embedded in the field code, a longer string or a numeric ID, and converts it to expectedClass. Returns null if the stream is exhausted or the code does not denote an event key.

Specified by:

readEvent in interface WireIn

Type Parameters:

K - The type of object expected.

Parameters:

expectedClass - The class type hint of the expected object. If no hint is available, use Object.class.

Returns:

An instance of the specified expectedClass.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

consumePadding

public void consumePadding()

Description copied from interface: WireIn

Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.

Specified by:

consumePadding in interface WireIn

peekCode

protected int peekCode()

Peeks the code from the current position without advancing the read pointer.

Returns:

The unsigned byte at the current read position.

readFieldNumber

@NotNull
protected @NotNull StringBuilder readFieldNumber(CharSequence keyName,
                                                          int keyCode,
                                                          @NotNull
                                                          @NotNull StringBuilder sb,
                                                          long fieldId)

Reads a field number from the wire and populates the provided StringBuilder.

Parameters:

keyName - The key name of the field to be matched against.

keyCode - The key code of the field to be matched against.

sb - The StringBuilder to be populated with the read field number.

fieldId - The ID of the field read from the wire.

Returns:

The populated StringBuilder with the read field number.

write

@NotNull
public @NotNull ValueOut write()

Description copied from interface: WireOut

Writes an empty field marker to the stream.

Specified by:

write in interface WireOut

Returns:

An interface to further define the output for the written value.

writeEventName

@NotNull
public @NotNull ValueOut writeEventName(@NotNull
                                                 @NotNull WireKey key)

Description copied from interface: WireOut

Writes a key to the stream. For RAW types, the label will be in text. This can be read using readEventName().

Specified by:

writeEventName in interface WireOut

Parameters:

key - The key to write to the stream.

Returns:

An interface to further define the output for the written value.

writeEventName

@NotNull
public @NotNull ValueOut writeEventName(@NotNull
                                                 @NotNull CharSequence name)

Description copied from interface: WireOut

Writes a CharSequence key to the stream.

Specified by:

writeEventName in interface WireOut

Parameters:

name - The CharSequence key to write to the stream.

Returns:

An interface to further define the output for the written value.

writeEventId

public ValueOut writeEventId(int methodId)

Description copied from interface: WireOut

Writes an event identifier to the stream.

Specified by:

writeEventId in interface WireOut

Parameters:

methodId - The ID of the method representing the event.

Returns:

An interface to further define the output for the written value.

writeEventId

public ValueOut writeEventId(String name,
                             int methodId)

Description copied from interface: WireOut

Writes an event identifier with a name to the stream.

Specified by:

writeEventId in interface WireOut

Parameters:

name - The name of the event.

methodId - The ID of the method representing the event.

Returns:

An interface to further define the output for the written value.

writeStartEvent

public void writeStartEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

writeStartEvent in interface WireOut

writeEndEvent

public void writeEndEvent()

Specified by:

writeEndEvent in interface WireOut

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull WireKey key)

Description copied from interface: WireOut

Writes a WireKey to the stream. This method is typically used for wires that support fields with structured keys.

Specified by:

write in interface WireOut

Parameters:

key - The WireKey to write to the stream.

Returns:

An interface to further define the output for the written value.

write

@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull CharSequence key)

Description copied from interface: WireOut

Writes a CharSequence key to the stream. This provides flexibility to write non-standard keys to the wire.

Specified by:

write in interface WireOut

Parameters:

key - The CharSequence key to write to the stream.

Returns:

An interface to further define the output for the written value.

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Retrieves the interface for defining the output of a value that will be written to the stream.

Specified by:

getValueOut in interface WireOut

Returns:

The interface to further define the output for the written value.

writeComment

@NotNull
public @NotNull Wire writeComment(CharSequence s)

Description copied from interface: WireOut

Writes a comment to the wire. Comments may be useful for debugging or providing context within the wire stream.

Specified by:

writeComment in interface WireOut

Parameters:

s - The comment to be written to the stream.

Returns:

This WireOut instance for method chaining.

addPadding

@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)

Description copied from interface: WireOut

Adds padding to the wire. This is particularly useful for aligning data.

Specified by:

addPadding in interface WireOut

Parameters:

paddingToAdd - The amount of padding to add.

Returns:

This WireOut instance for method chaining.

writeCode

protected net.openhft.chronicle.bytes.Bytes<?> writeCode(int code)

Writes a byte code to the byte buffer.

Parameters:

code - The byte code to write.

Returns:

Returns the byte buffer after writing the code.

toString

@NotNull
public @NotNull String toString()

Converts the current state of the bytes storage to a debug string.

This method provides a string representation of the bytes, useful for debugging purposes.

Overrides:

toString in class Object

Returns:

A string representation of the bytes.

newLongReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.LongValue newLongReference()

Description copied from interface: WireCommon

Creates and returns a new LongValue. The LongValue implementation that is returned depends on the wire implementation.

Specified by:

newLongReference in interface WireCommon

Returns:

a new LongValue

newBooleanReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.BooleanValue newBooleanReference()

Description copied from interface: WireCommon

Creates and returns a new BooleanValue. The BooleanValue implementation that is returned depends on the wire implementation.

Specified by:

newBooleanReference in interface WireCommon

Returns:

a new BooleanValue.

newTwoLongReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.TwoLongValue newTwoLongReference()

Description copied from interface: WireCommon

Creates and returns a new TwoLongValue. The TwoLongValue implementation that is returned depends on the wire implementation.

Specified by:

newTwoLongReference in interface WireCommon

Returns:

a new TwoLongValue

newIntReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.IntValue newIntReference()

Description copied from interface: WireCommon

Creates and returns a new IntValue. The IntValue implementation that is returned depends on the wire implementation.

Specified by:

newIntReference in interface WireCommon

Returns:

a new IntValue.

newLongArrayReference

@NotNull
public @NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference newLongArrayReference()

Description copied from interface: WireCommon

Creates and returns a new LongArrayValues. The LongArrayValues implementation that is returned depends on the wire implementation.

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a new LongArrayValues

newIntArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.IntArrayValues newIntArrayReference()

Description copied from interface: WireCommon

Creates and returns a new IntArrayValues. The IntArrayValues implementation that is returned depends on the wire implementation.

Specified by:

newIntArrayReference in interface WireCommon

Returns:

a new IntArrayValues

useSelfDescribingMessage

public boolean useSelfDescribingMessage(@NotNull
                                        @NotNull net.openhft.chronicle.bytes.CommonMarshallable object)

Determines whether a given object should use the self-describing message format.

This method first checks if an override value for self-describing is set. If not, it uses the self-describing value from the provided object.

Specified by:

useSelfDescribingMessage in interface WireCommon

Parameters:

object - The object whose self-describing status needs to be checked.

Returns:

true if the object should use the self-describing message format, false otherwise.

writingIsComplete

public boolean writingIsComplete()

Description copied from interface: RollbackIfNotCompleteNotifier

Checks if the current writing operation is complete. Returns true by default, indicating completion. Implementations should override this to reflect the actual completion status of their write operation (for example, the inverse of DocumentContext.isNotComplete()).

Specified by:

writingIsComplete in interface RollbackIfNotCompleteNotifier

Specified by:

writingIsComplete in interface WireOut

Returns:

true unless there is an incomplete/chained message