net.openhft.chronicle.wire

Class AbstractWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAnyWire, BinaryWire, RawWire, YamlWireOut

public abstract class AbstractWire
extends Object
implements Wire

Nested Class Summary

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 net.openhft.chronicle.bytes.Bytes<?>	bytes
protected net.openhft.chronicle.core.pool.ClassLookup	classLookup
protected Consumer<CharSequence>	commentListener
static boolean	DEFAULT_USE_PADDING
protected Object	parent
protected boolean	use8bit

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

MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
@NotNull net.openhft.chronicle.bytes.Bytes<?>	bytes() Returns the underlying Bytes stored by the wire.
net.openhft.chronicle.bytes.HexDumpBytesDescription<?>	bytesComment() Returns the bytes() but only for comment.
net.openhft.chronicle.core.pool.ClassLookup	classLookup() Returns the current ClassLookup implementation being used for class lookup.
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Sets the ClassLookup implementation to be used for class lookup.
void	clear() Resets the state of the underlying Bytes stored by the wire.
void	commentListener(Consumer<CharSequence> commentListener)
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) INTERNAL METHOD, call writingDocument instead
void	forceNotInsideHeader() used by write bytes when doing a rollback
long	headerNumber()
@NotNull Wire	headerNumber(long headerNumber)
void	headNumberCheck(HeadNumberChecker headNumberChecker)
boolean	isInsideHeader()
boolean	notCompleteIsNotPresent() If a message is marked as NOT_COMPLETE is it still present.
void	notCompleteIsNotPresent(boolean notCompleteIsNotPresent)
ObjectInput	objectInput()
ObjectOutput	objectOutput()
Object	parent() Returns the wire parent object.
void	parent(Object parent) Assigns the wire parent object for later retrieval.
net.openhft.chronicle.threads.Pauser	pauser() Returns the current Pauser implementation being used for blocking operations.
void	pauser(net.openhft.chronicle.threads.Pauser pauser) Sets the Pauser implementation to be used for blocking operations.
void	readAndSetLength(long position)
@NotNull WireIn.HeaderType	readDataHeader(boolean includeMetaData)
long	readEventNumber()
void	readFirstHeader()
void	readFirstHeader(long timeout, TimeUnit timeUnit)
void	readMetaDataHeader()
void	updateFirstHeader() INTERNAL METHOD, call writingDocument instead
void	updateFirstHeader(long headerEndPos) INTERNAL METHOD, call writingDocument instead
void	updateHeader(long position, boolean metaData, int expectedHeader) INTERNAL METHOD, call writingDocument instead
boolean	usePadding()
void	usePadding(boolean usePadding)
boolean	writeEndOfWire(long timeout, TimeUnit timeUnit, long lastPosition) Write the end of wire marker, unless one is already written.
boolean	writeFirstHeader() INTERNAL METHOD, call writingDocument instead

Methods inherited from class java.lang.Object

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

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

fromFile, newYamlWireOnHeap

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

asText, consumePadding, copyTo, endEvent, getValueIn, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, rawReadData, read, read, read, read, readAlignTo, readAllAsMap, readComment, readDataHeader, readDocument, readDocument, readEvent, readEventName, readingDocument, readingDocument, readingPeekYaml, 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

acquireWritingDocument, addPadding, dropDefault, getValueOut, padToCacheAlign, write, write, write, writeAlignTo, writeAllAsMap, writeComment, writeDocument, writeEndEvent, writeEvent, writeEventId, writeEventId, writeEventName, writeEventName, writeNotCompleteDocument, writeStartEvent, writingDocument, writingDocument, writingIsComplete

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

isBinary, newBooleanReference, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference, reset, useSelfDescribingMessage

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

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

Field Detail

DEFAULT_USE_PADDING

public static final boolean DEFAULT_USE_PADDING

bytes

@NotNull
protected final @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes

use8bit

protected final boolean use8bit

classLookup

protected net.openhft.chronicle.core.pool.ClassLookup classLookup

parent

protected Object parent

commentListener

protected Consumer<CharSequence> commentListener

Constructor Detail

AbstractWire

protected AbstractWire(@NotNull
                       @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                       boolean use8bit)

Method Detail

isInsideHeader

public boolean isInsideHeader()

pauser

public net.openhft.chronicle.threads.Pauser pauser()

Description copied from interface: WireCommon

Returns the current Pauser implementation being used for blocking operations.

Specified by:

pauser in interface WireCommon

Returns:

the current Pauser implementation being used for blocking operations

pauser

public void pauser(net.openhft.chronicle.threads.Pauser pauser)

Description copied from interface: WireCommon

Sets the Pauser implementation to be used for blocking operations.

Specified by:

pauser in interface WireCommon

Parameters:

pauser - implementation to be used for blocking operations.

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

headerNumber

@NotNull
public @NotNull Wire headerNumber(long headerNumber)

Specified by:

headerNumber in interface Wire

Specified by:

headerNumber in interface WireCommon

headNumberCheck

public void headNumberCheck(HeadNumberChecker headNumberChecker)

headerNumber

public long headerNumber()

Specified by:

headerNumber in interface WireCommon

classLookup

public void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)

Description copied from interface: WireCommon

Sets the ClassLookup implementation to be used for class lookup.

Specified by:

classLookup in interface WireCommon

Parameters:

classLookup - implementation to be used for class lookup.

classLookup

public net.openhft.chronicle.core.pool.ClassLookup classLookup()

Description copied from interface: WireCommon

Returns the current ClassLookup implementation being used for class lookup.

Specified by:

classLookup in interface WireCommon

Returns:

the current ClassLookup implementation being used for class lookup

bytes

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

Description copied from interface: WireCommon

Returns the underlying Bytes stored by the wire.

Specified by:

bytes in interface WireCommon

Returns:

the underlying Bytes stored by the wire

bytesComment

public net.openhft.chronicle.bytes.HexDumpBytesDescription<?> bytesComment()

Description copied from interface: WireCommon

Returns the bytes() but only for comment.

Specified by:

bytesComment in interface WireCommon

Returns:

the bytes() but only for comment

commentListener

public void commentListener(Consumer<CharSequence> commentListener)

Specified by:

commentListener in interface WireIn

readDataHeader

@NotNull
public @NotNull WireIn.HeaderType readDataHeader(boolean includeMetaData)

Specified by:

readDataHeader in interface WireIn

readAndSetLength

public void readAndSetLength(long position)

Specified by:

readAndSetLength in interface WireIn

readMetaDataHeader

public void readMetaDataHeader()

Specified by:

readMetaDataHeader in interface WireIn

readFirstHeader

public void readFirstHeader()
                     throws StreamCorruptedException

Specified by:

readFirstHeader in interface WireIn

Throws:

StreamCorruptedException

readFirstHeader

public void readFirstHeader(long timeout,
                            TimeUnit timeUnit)
                     throws TimeoutException,
                            StreamCorruptedException

Specified by:

readFirstHeader in interface WireIn

Throws:

TimeoutException

StreamCorruptedException

enterHeader

public long enterHeader(long safeLength)

Description copied from interface: WireOut

INTERNAL METHOD, call writingDocument instead

Start a header for a document

Specified by:

enterHeader in interface WireOut

Parameters:

safeLength - ensure there is at least this much space

Returns:

the position of the header

updateHeader

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

Description copied from interface: WireOut

INTERNAL METHOD, call writingDocument instead

Update/end a header for a document

Specified by:

updateHeader in interface WireOut

Throws:

StreamCorruptedException

writeFirstHeader

public boolean writeFirstHeader()

Description copied from interface: WireOut

INTERNAL METHOD, call writingDocument instead

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.

Specified by:

writeFirstHeader in interface WireOut

Returns:

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

updateFirstHeader

public void updateFirstHeader()

Description copied from interface: WireOut

INTERNAL METHOD, call writingDocument instead

update the first header after writing.

Specified by:

updateFirstHeader in interface WireOut

updateFirstHeader

public void updateFirstHeader(long headerEndPos)

Description copied from interface: WireOut

INTERNAL METHOD, call writingDocument instead

update the first header after writing headerEndPos bytes.

Specified by:

updateFirstHeader in interface WireOut

writeEndOfWire

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

Description copied from interface: WireOut

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

Specified by:

writeEndOfWire in interface WireOut

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

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

Description copied from interface: WireOut

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

Specified by:

endOfWire in interface WireOut

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

parent

public Object parent()

Description copied from interface: WireCommon

Returns the wire parent object. If the parent was not assigned, null is returned instead.

Specified by:

parent in interface WireCommon

Returns:

the wire parent object or null if none was assigned.

parent

public void parent(Object parent)

Description copied from interface: WireCommon

Assigns the wire parent object for later retrieval.

Specified by:

parent in interface WireCommon

Parameters:

parent - to set, or null if there isn't one.

notCompleteIsNotPresent

public boolean notCompleteIsNotPresent()

Description copied from interface: WireCommon

If a message is marked as NOT_COMPLETE is it still present.

Specified by:

notCompleteIsNotPresent in interface WireCommon

Returns:

true if NOT_COMPLETE messages can be seen, false if they cannot.

notCompleteIsNotPresent

public void notCompleteIsNotPresent(boolean notCompleteIsNotPresent)

Specified by:

notCompleteIsNotPresent in interface WireCommon

objectOutput

public ObjectOutput objectOutput()

Specified by:

objectOutput in interface WireOut

objectInput

public ObjectInput objectInput()

Specified by:

objectInput in interface WireIn

readEventNumber

public long readEventNumber()

Specified by:

readEventNumber in interface WireIn

Returns:

field number or Long.MIN_VALUE if no number.

forceNotInsideHeader

public void forceNotInsideHeader()

used by write bytes when doing a rollback

usePadding

public void usePadding(boolean usePadding)

Specified by:

usePadding in interface WireCommon

usePadding

public boolean usePadding()

Specified by:

usePadding in interface WireCommon