net.openhft.chronicle.wire

Class AbstractWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

All Implemented Interfaces:

MarshallableIn, MarshallableOut, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

AbstractAnyWire, BinaryWire, RawWire, TextWire

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

MarshallableOut.Padding

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ASSERTIONS
protected net.openhft.chronicle.bytes.Bytes<?>	bytes
protected net.openhft.chronicle.core.pool.ClassLookup	classLookup
protected Object	parent
protected boolean	use8bit

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

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

Constructor Summary

Constructors

Constructor and Description
AbstractWire(net.openhft.chronicle.bytes.Bytes bytes, boolean use8bit)

Method Summary

Modifier and Type	Method and Description
net.openhft.chronicle.bytes.Bytes<?>	bytes()
net.openhft.chronicle.bytes.BytesComment<?>	bytesComment()
net.openhft.chronicle.core.pool.ClassLookup	classLookup()
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Define how classes should be looked up.
void	clear() reset the state of the current wire for reuse.
boolean	endUse() Check the Wire was not used by another thread.
void	forceNotInsideHeader() used by write bytes when doing a rollback
long	headerNumber()
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() Obtain the parent class of this wire if there is one
void	parent(Object parent) Assign a parent object to this wire for later retrieval.
net.openhft.chronicle.threads.Pauser	pauser()
void	pauser(net.openhft.chronicle.threads.Pauser pauser)
void	readAndSetLength(long position)
WireIn.HeaderType	readDataHeader(boolean includeMetaData)
long	readEventNumber()
void	readFirstHeader(long timeout, TimeUnit timeUnit)
void	readMetaDataHeader()
boolean	startUse() Used to check that the wire is being used by only one thread
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.
void	writeEndOfWire(long timeout, TimeUnit timeUnit, long lastPosition) Write the end of wire marker, unless one is already written.
boolean	writeFirstHeader() Start the first header, if there is none This will increment the headerNumber as appropriate if successful
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.

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

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

asText, consumePadding, copyTo, getValueIn, hasMore, isEmpty, isNotEmptyAfterPadding, rawReadData, read, read, read, read, readAlignTo, readAllAsMap, readComment, readDataHeader, readDocument, readDocument, readEvent, readEventName, readingDocument, readingDocument, readingPeekYaml

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

addPadding, dropDefault, endEvent, getValueOut, padToCacheAlign, startEvent, write, write, write, writeAlignTo, writeAllAsMap, writeComment, writeDocument, writeEvent, writeEventId, writeEventName, writeEventName, writeHeader, writeHeaderOfUnknownLength, writeNotCompleteDocument, writingDocument, writingDocument

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

newBooleanReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference

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

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

Field Detail

ASSERTIONS

protected static final boolean ASSERTIONS

bytes

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

use8bit

protected final boolean use8bit

classLookup

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

parent

protected Object parent

Constructor Detail

AbstractWire

public AbstractWire(@NotNull
                    net.openhft.chronicle.bytes.Bytes bytes,
                    boolean use8bit)

Method Detail

isInsideHeader

public boolean isInsideHeader()

pauser

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

Specified by:

pauser in interface WireCommon

Returns:

pauser used.

pauser

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

Specified by:

pauser in interface WireCommon

Parameters:

pauser - to use for blocking operations.

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

headerNumber

@NotNull
public 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

Define how classes should be looked up.

Specified by:

classLookup in interface WireCommon

Parameters:

classLookup - to use

classLookup

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

Specified by:

classLookup in interface WireCommon

Returns:

the current implementation for looking up classes.

bytes

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

Specified by:

bytes in interface WireCommon

Returns:

the underlying Bytes

bytesComment

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

Specified by:

bytesComment in interface WireCommon

Returns:

the bytes90 but only for comment

readDataHeader

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

Specified by:

readDataHeader in interface WireIn

Throws:

EOFException

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(long timeout,
                            TimeUnit timeUnit)
                     throws TimeoutException,
                            StreamCorruptedException

Specified by:

readFirstHeader in interface WireIn

Throws:

TimeoutException

StreamCorruptedException

writeHeaderOfUnknownLength

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

Description copied from interface: WireOut

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

Specified by:

writeHeaderOfUnknownLength in interface WireOut

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.

tryWriteHeader

public long tryWriteHeader(int safeLength)

Description copied from interface: WireOut

Makes a single attempt to try and write the header.

Specified by:

tryWriteHeader in interface WireOut

Parameters:

safeLength - assume this safe length

Returns:

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

updateHeader

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

Description copied from interface: WireOut

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

Specified by:

updateHeader in interface WireOut

Parameters:

position - returned by writeHeader

metaData - whether the message is meta data or not.

Throws:

StreamCorruptedException - if the steam has become corrupted

EOFException

writeFirstHeader

public boolean writeFirstHeader()

Description copied from interface: WireOut

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

update the first header after writing.

Specified by:

updateFirstHeader in interface WireOut

writeEndOfWire

public void 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

parent

public Object parent()

Description copied from interface: WireCommon

Obtain the parent class of this wire if there is one

Specified by:

parent in interface WireCommon

Returns:

the parent or null if none was assigned.

parent

public void parent(Object parent)

Description copied from interface: WireCommon

Assign a parent object to this wire for later retrieval.

Specified by:

parent in interface WireCommon

Parameters:

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

startUse

public boolean startUse()

Description copied from interface: WireCommon

Used to check that the wire is being used by only one thread

Specified by:

startUse in interface WireCommon

Returns:

true always, so it can be used in an assert line

endUse

public boolean endUse()

Description copied from interface: WireCommon

Check the Wire was not used by another thread.

Specified by:

endUse in interface WireCommon

Returns:

true always, so it can be used in an assert line

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