net.openhft.chronicle.wire

Class BinaryWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.BinaryWire

All Implemented Interfaces:

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

MarshallableOut.Padding

Field Summary

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

ASSERTIONS, bytes, classLookup, parent, use8bit

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

MARSHALLABLE_IN_INTERN_SIZE

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

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

Constructor Summary

Constructors

Constructor and Description
BinaryWire(net.openhft.chronicle.bytes.Bytes bytes)
BinaryWire(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
WireOut	addPadding(int paddingToAdd)
static BinaryWire	binaryOnly(net.openhft.chronicle.bytes.Bytes bytes)
void	clear() reset the state of the current wire for reuse.
void	consumePadding()
void	copyOne(WireOut wire)
void	copyTo(WireOut wire)
void	endEvent()
boolean	fieldLess()
protected BinaryWire.BinaryValueIn	getBinaryValueIn()
protected BinaryWire.FixedBinaryValueOut	getFixedBinaryValueOut(boolean fixed)
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
boolean	isTextWire()
net.openhft.chronicle.core.values.BooleanValue	newBooleanReference()
net.openhft.chronicle.core.values.IntValue	newIntReference()
net.openhft.chronicle.bytes.ref.BinaryLongArrayReference	newLongArrayReference()
net.openhft.chronicle.core.values.LongValue	newLongReference()
net.openhft.chronicle.core.values.TwoLongValue	newTwoLongReference()
protected int	peekCode()
ValueIn	read() Read the field if present, or empty string if not present.
ValueIn	read(String fieldName)
ValueIn	read(StringBuilder name) Read the field if present, or empty string if not present.
ValueIn	read(WireKey key) Read the field if present which must match the WireKey.
protected <T> ValueIn	read2(CharSequence keyName, int keyCode, T defaultSource, Function<T,Object> defaultLookup, net.openhft.chronicle.wire.ValueInState curr, StringBuilder sb, CharSequence name)
Wire	readComment(StringBuilder s)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
ValueIn	readEventName(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 StringBuilder	readFieldAnchor(StringBuilder sb)
protected StringBuilder	readFieldNumber(CharSequence keyName, int keyCode, StringBuilder sb, long fieldId)
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
DocumentContext	readingDocument(long readLocation)
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(WireOut wire, int len)
void	startEvent() Start an event object, mostly for internal use.
String	toString()
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence key)
ValueOut	write(WireKey key) Write a key for wires that support fields.
protected net.openhft.chronicle.bytes.Bytes	writeCode(int code)
Wire	writeComment(CharSequence s)
ValueOut	writeEventId(int methodId)
ValueOut	writeEventName(CharSequence name)
ValueOut	writeEventName(WireKey key) Always write a key.
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

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

bytes, bytesComment, classLookup, classLookup, endUse, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readFirstHeader, readFirstHeader, readMetaDataHeader, startUse, updateFirstHeader, updateHeader, writeEndOfWire, writeFirstHeader, writeHeaderOfUnknownLength

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

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

asText, hasMore, isEmpty, isNotEmptyAfterPadding, objectInput, rawReadData, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readFirstHeader, readFirstHeader, readMetaDataHeader

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

methodReader, methodReaderBuilder, peekDocument, readBytes, readBytes, readDocument, readMap, readText, readText

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

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

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

bytes, bytesComment, classLookup, classLookup, endUse, headerNumber, 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

Constructor Detail

BinaryWire

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

BinaryWire

public BinaryWire(@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 BinaryWire binaryOnly(@NotNull
                                             net.openhft.chronicle.bytes.Bytes bytes)

getFixedBinaryValueOut

@NotNull
protected BinaryWire.FixedBinaryValueOut getFixedBinaryValueOut(boolean fixed)

getBinaryValueIn

@NotNull
protected BinaryWire.BinaryValueIn getBinaryValueIn()

clear

public void clear()

Description copied from interface: WireCommon

reset the state of the current wire for reuse.

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 DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

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

readingDocument

@NotNull
public 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 DocumentContext readingDocument(long readLocation)

Specified by:

readingDocument in interface WireIn

readingPeekYaml

@NotNull
public 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
                   WireOut wire)

Specified by:

copyTo in interface WireIn

copyOne

public void copyOne(@NotNull
                    WireOut wire)

readWithLength

public void readWithLength(@NotNull
                           WireOut wire,
                           int len)

read

@NotNull
public ValueIn read(@NotNull
                             String fieldName)

Specified by:

read in interface WireIn

read

@NotNull
public 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 ValueIn read(@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
                            Function<T,Object> defaultLookup,
                            @NotNull
                            net.openhft.chronicle.wire.ValueInState curr,
                            @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 ValueIn readEventName(@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 ValueIn read(@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 ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in (for internal use)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public Wire readComment(@NotNull
                                 StringBuilder s)

Specified by:

readComment in interface WireIn

readEvent

@Nullable
public <K> K readEvent(@NotNull
                                 Class<K> expectedClass)

Description copied from interface: WireIn

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

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

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

peekCode

protected int peekCode()

readFieldAnchor

@NotNull
protected StringBuilder readFieldAnchor(@NotNull
                                                 StringBuilder sb)

readFieldNumber

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

write

@NotNull
public ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

writeEventName

@NotNull
public ValueOut writeEventName(@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 ValueOut writeEventName(@NotNull
                                        CharSequence name)

Specified by:

writeEventName in interface WireOut

writeEventId

public ValueOut writeEventId(int methodId)

Specified by:

writeEventId in interface WireOut

startEvent

public void startEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

startEvent in interface WireOut

endEvent

public void endEvent()

Specified by:

endEvent in interface WireOut

write

@NotNull
public ValueOut write(@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 ValueOut write(@NotNull
                               CharSequence key)

Specified by:

write in interface WireOut

getValueOut

@NotNull
public ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public Wire writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

writeCode

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

toString

@NotNull
public String toString()

Overrides:

toString in class Object

newLongReference

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

Specified by:

newLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newBooleanReference

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

Specified by:

newBooleanReference in interface WireCommon

Returns:

a BooleanValue which appropriate for this wire.

isTextWire

public boolean isTextWire()

Specified by:

isTextWire in interface WireCommon

newTwoLongReference

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

Specified by:

newTwoLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newIntReference

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

Specified by:

newIntReference in interface WireCommon

Returns:

an IntValue which appropriate for this wire.

newLongArrayReference

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

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a LongArrayValue which appropriate for this wire.