net.openhft.chronicle.wire

Class BinaryWriteDocumentContext

java.lang.Object

net.openhft.chronicle.wire.BinaryWriteDocumentContext

All Implemented Interfaces:

Closeable, AutoCloseable, DocumentContext, SourceContext, WriteDocumentContext

public class BinaryWriteDocumentContext
extends Object
implements WriteDocumentContext

A context used for writing documents in a binary format. This class provides facilities to start, query, and manage the state of binary documents that are currently being written. The binary format uses headers to denote metadata, data length, and completion status.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected long	position
protected int	tmpHeader
protected Wire	wire

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

NOOP

Constructor Summary

Constructors

Constructor and Description
BinaryWriteDocumentContext(Wire wire) Constructs a new context for writing binary documents using the specified wire.

Method Summary

Modifier and Type	Method and Description
boolean	chainedElement() Returns true if this WriteDocumentContext is a chained element.
void	chainedElement(boolean chainedElement) Marks this WriteDocumentContext as a chained element.
protected boolean	checkResetOpened()
void	close() Closes the DocumentContext and releases any held resources.
long	index() Obtains the index of the last read operation from this source context.
boolean	isEmpty() Checks if the writing context is empty.
boolean	isMetaData() Checks it the DocumentContext is metadata.
boolean	isNotComplete()
boolean	isPresent() Checks if the DocumentContext is present.
protected long	position() Retrieves the current position in the wire where the document starts.
void	reset() Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it.
void	rollbackIfNotComplete() Call this if any incomplete message should be rolled back at this point, it it wasn't complete by now.
void	rollbackOnClose() Invoked to signal an error condition in the current context.
int	sourceId() Retrieves the source ID associated with this context.
void	start(boolean metaData) Initializes the context for starting a new binary write.
Wire	wire() Returns the Wire associated with the Document.

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

isData, isOpen

Field Detail

wire

protected Wire wire

position

protected long position

tmpHeader

protected int tmpHeader

count

protected int count

Constructor Detail

BinaryWriteDocumentContext

public BinaryWriteDocumentContext(Wire wire)

Constructs a new context for writing binary documents using the specified wire.

Parameters:

wire - The wire instance to be used for the writing process.

Method Detail

start

public void start(boolean metaData)

Initializes the context for starting a new binary write. This will setup necessary headers and markers to facilitate the write.

Specified by:

start in interface WriteDocumentContext

Parameters:

metaData - A flag indicating whether the write includes metadata.

isEmpty

public boolean isEmpty()

Description copied from interface: WriteDocumentContext

Checks if the writing context is empty.

Specified by:

isEmpty in interface WriteDocumentContext

Returns:

true if the context is empty; otherwise, false.

isMetaData

public boolean isMetaData()

Description copied from interface: DocumentContext

Checks it the DocumentContext is metadata. If it is, true is returned, otherwise false.

Specified by:

isMetaData in interface DocumentContext

Returns:

true if the entry is metadata

close

public void close()

Description copied from interface: DocumentContext

Closes the DocumentContext and releases any held resources. It is crucial to ensure that this method is invoked after the context's operations are completed to prevent any potential resource leaks or data corruption.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DocumentContext

rollbackIfNotComplete

public void rollbackIfNotComplete()

Description copied from interface: DocumentContext

Call this if any incomplete message should be rolled back at this point, it it wasn't complete by now.

Specified by:

rollbackIfNotComplete in interface DocumentContext

rollbackOnClose

public void rollbackOnClose()

Description copied from interface: DocumentContext

Invoked to signal an error condition in the current context. This ensures that upon closing the context, any changes made during its lifecycle are rolled back rather than committing a potentially erroneous state.

Specified by:

rollbackOnClose in interface DocumentContext

reset

public void reset()

Description copied from interface: DocumentContext

Cleans up the DocumentContext by invoking the close method, then discarding any lingering state associated with it. This provides a way to ensure the context is in a fresh state and free of any residual data or settings.

Specified by:

reset in interface DocumentContext

checkResetOpened

protected boolean checkResetOpened()

chainedElement

public boolean chainedElement()

Description copied from interface: WriteDocumentContext

Returns true if this WriteDocumentContext is a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

Returns:

true if this WriteDocumentContext is a chained element; otherwise, false.

chainedElement

public void chainedElement(boolean chainedElement)

Description copied from interface: WriteDocumentContext

Marks this WriteDocumentContext as a chained element.

Specified by:

chainedElement in interface WriteDocumentContext

Parameters:

chainedElement - A boolean value indicating if the context is a chained element.

isPresent

public boolean isPresent()

Description copied from interface: DocumentContext

Checks if the DocumentContext is present. If it is, true is returned, otherwise false.

Specified by:

isPresent in interface DocumentContext

Returns:

true if the entry is present

wire

public Wire wire()

Description copied from interface: DocumentContext

Returns the Wire associated with the Document. It is possible that null is returned, depending on the implementation.

Specified by:

wire in interface DocumentContext

Returns:

the Wire associated with the Document.

position

protected long position()

Retrieves the current position in the wire where the document starts.

Returns:

The position in the wire where the current document starts.

index

public long index()

Description copied from interface: SourceContext

Obtains the index of the last read operation from this source context. This is particularly useful to track the reading progress and can act as a checkpoint or reference point. Note: This method is specifically intended for read contexts and might not be relevant for other context types.

Specified by:

index in interface SourceContext

Returns:

The index corresponding to the last read operation.

sourceId

public int sourceId()

Description copied from interface: SourceContext

Retrieves the source ID associated with this context. A unique identifier that represents the source from which data or operations might be fetched or to which data might be written. If a valid source ID has not been established or isn't available, it defaults to returning -1.

Specified by:

sourceId in interface SourceContext

Returns:

The unique identifier for this source context, or -1 if not available.

isNotComplete

public boolean isNotComplete()

Specified by:

isNotComplete in interface DocumentContext

Returns:

whether the NOT_COMPLETE flag has been set.