net.openhft.chronicle.wire

Class BinaryWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.BinaryWire

All Implemented Interfaces:

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

public class BinaryWire
extends AbstractWire
implements Wire

This Wire is a binary translation of TextWire which is a sub set of YAML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BinaryWire.BinaryValueIn
protected class	BinaryWire.BinaryValueOut
protected class	BinaryWire.FixedBinaryValueOut

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(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
BinaryWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean fixed, boolean numericFields, boolean fieldLess, int compressedSize, String compression, boolean supportDelta)

Method Summary

Modifier and Type	Method and Description
protected @NotNull StringBuilder	acquireStringBuilder()
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
@NotNull WireOut	addPadding(int paddingToAdd)
protected void	anchor(@NotNull WireOut wire)
static @NotNull BinaryWire	binaryOnly(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
void	clear() Resets the state of the underlying Bytes stored by the wire.
void	consumePadding()
void	copyOne(@NotNull WireOut wire)
void	copyTo(@NotNull WireOut wire)
protected void	fieldAnchor(@NotNull WireOut wire)
boolean	fieldLess()
protected @NotNull BinaryWire.BinaryValueIn	getBinaryValueIn()
protected @NotNull BinaryWire.FixedBinaryValueOut	getFixedBinaryValueOut(boolean fixed)
Boolean	getOverrideSelfDescribing()
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
@NotNull ValueOut	getValueOut() Obtain the value out
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()
@NotNull ValueIn	read() Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull String fieldName)
@NotNull ValueIn	read(@NotNull StringBuilder name) Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull WireKey key) Read the field if present which must match the 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)
@NotNull Wire	readComment(@NotNull StringBuilder s)
<K> K	readEvent(@NotNull Class<K> expectedClass) Read a field which might be an object of any type.
@NotNull ValueIn	readEventName(@NotNull StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
long	readEventNumber()
protected @NotNull StringBuilder	readFieldAnchor(@NotNull StringBuilder sb)
protected @NotNull StringBuilder	readFieldNumber(CharSequence keyName, int keyCode, @NotNull StringBuilder sb, long fieldId)
@NotNull DocumentContext	readingDocument() equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
@NotNull DocumentContext	readingDocument(long readLocation)
@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)
void	reset() Reset the state of the wire
BinaryWire	setOverrideSelfDescribing(Boolean overrideSelfDescribing)
@NotNull String	toString()
protected static void	unexpectedCode()
protected void	unknownCode(@NotNull WireOut wire)
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Should this wire write the object as a Marshallable or BytesMarshallable
@NotNull ValueOut	write() Write an empty filed marker
@NotNull ValueOut	write(@NotNull CharSequence key)
@NotNull ValueOut	write(@NotNull WireKey key) Write a key for wires that support fields.
protected net.openhft.chronicle.bytes.Bytes<?>	writeCode(int code)
@NotNull Wire	writeComment(CharSequence s)
void	writeEndEvent()
ValueOut	writeEventId(int methodId)
ValueOut	writeEventId(String name, int methodId)
@NotNull ValueOut	writeEventName(@NotNull CharSequence name)
@NotNull ValueOut	writeEventName(@NotNull WireKey key) Always write a key.
void	writeStartEvent() Start an event object, mostly for internal use.
@NotNull DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful
boolean	writingIsComplete()

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

bytes, bytesComment, classLookup, classLookup, commentListener, endOfWire, enterHeader, forceNotInsideHeader, 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

fromFile, headerNumber, newYamlWireOnHeap

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

asText, 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, 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(@NotNull
                  @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

BinaryWire

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

Method Detail

binaryOnly

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

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

Specified by:

reset in interface WireCommon

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:

null is no override, true is always use self describing, false is never use self describing.

setOverrideSelfDescribing

public BinaryWire setOverrideSelfDescribing(Boolean overrideSelfDescribing)

Parameters:

overrideSelfDescribing - null is no override, true is always use self describing, false is never use self describing.

acquireStringBuilder

@NotNull
protected @NotNull StringBuilder acquireStringBuilder()

getFixedBinaryValueOut

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

getBinaryValueIn

@NotNull
protected @NotNull BinaryWire.BinaryValueIn getBinaryValueIn()

clear

public void clear()

Description copied from interface: WireCommon

Resets the state of the underlying Bytes stored by the wire.

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

writingDocument

@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

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

Returns:

a document context used for witting

acquireWritingDocument

public 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

Specified by:

acquireWritingDocument in interface WireOut

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument()

Description copied from interface: WireIn

equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression

Specified by:

readingDocument in interface MarshallableIn

Specified by:

readingDocument in interface WireIn

Returns:

the document context

readingDocument

@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

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

Specified by:

copyTo in interface WireIn

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

copyOne

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

unexpectedCode

protected static void unexpectedCode()

anchor

protected void anchor(@NotNull
                      @NotNull WireOut wire)

fieldAnchor

protected void fieldAnchor(@NotNull
                           @NotNull WireOut wire)

readWithLength

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

unknownCode

protected void unknownCode(@NotNull
                           @NotNull WireOut wire)

read

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

Specified by:

read in interface WireIn

read

@NotNull
public @NotNull ValueIn read()

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

read

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

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

Specified by:

read in interface WireIn

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)

readEventNumber

public long readEventNumber()

Specified by:

readEventNumber in interface WireIn

Overrides:

readEventNumber in class AbstractWire

Returns:

field number or Long.MIN_VALUE if no number.

readEventName

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

Description copied from interface: WireIn

Read a field, or string which is always written, even for formats which might drop the field such as RAW.

Specified by:

readEventName in interface WireIn

read

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

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

getValueIn

@NotNull
public @NotNull ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in for advanced use (typically after a call to readEvent above)

Specified by:

getValueIn in interface WireIn

readComment

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

Specified by:

readComment in interface WireIn

readEvent

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

Description copied from interface: WireIn

Read a field which might be an object of any type.

Use getValueIn() to read the value for this event

Specified by:

readEvent in interface WireIn

Parameters:

expectedClass - to use as a hint, or Object.class if no hint available.

Returns:

an instance of expectedClass

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

peekCode

protected int peekCode()

readFieldAnchor

@NotNull
protected @NotNull StringBuilder readFieldAnchor(@NotNull
                                                          @NotNull StringBuilder sb)

readFieldNumber

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

write

@NotNull
public @NotNull ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

writeEventName

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

Description copied from interface: WireOut

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

Specified by:

writeEventName in interface WireOut

writeEventName

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

Specified by:

writeEventName in interface WireOut

writeEventId

public ValueOut writeEventId(int methodId)

Specified by:

writeEventId in interface WireOut

writeEventId

public ValueOut writeEventId(String name,
                             int methodId)

Specified by:

writeEventId in interface WireOut

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

Write a key for wires that support fields.

Specified by:

write in interface WireOut

write

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

Specified by:

write in interface WireOut

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public @NotNull Wire writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

writeCode

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

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

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)

Description copied from interface: WireCommon

Should this wire write the object as a Marshallable or BytesMarshallable

Specified by:

useSelfDescribingMessage in interface WireCommon

Returns:

use Marshallable

writingIsComplete

public boolean writingIsComplete()

Specified by:

writingIsComplete in interface WireOut

Returns:

true unless there is an incomplete/chained message