net.openhft.chronicle.wire

Interface DocumentWritten

All Known Subinterfaces:

ChronicleChannel, InternalChronicleChannel, MarshallableOut, MethodWriterWithContext, Wire, WireOut

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, HashWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire, YamlWire, YamlWireOut

public interface DocumentWritten

Represents an entity that supports writing documents. The interface provides methods to initiate and manage the context in which documents are written. It is crucial to manage the lifecycle of the DocumentContext correctly, either by using try-with-resources or explicitly invoking the close() method.

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Obtains a DocumentContext for writing.
DocumentContext	writingDocument() Creates a new DocumentContext for writing a document.
DocumentContext	writingDocument(boolean metaData) Initiates a new DocumentContext for writing, with an option to include metadata.

Method Detail

writingDocument

DocumentContext writingDocument()

Creates a new DocumentContext for writing a document. This context is designed for use within a try-with-resource block to ensure proper resource management.

Returns:

A fresh DocumentContext for writing.

writingDocument

DocumentContext writingDocument(boolean metaData)
                         throws UnrecoverableTimeoutException

Initiates a new DocumentContext for writing, with an option to include metadata. It is imperative to always invoke the close() method on the context after completing the write operation.

Parameters:

metaData - A boolean indicating if metadata should be included during writing.

Returns:

A fresh DocumentContext tailored to the metadata preference.

Throws:

UnrecoverableTimeoutException - If the operation times out in an unrecoverable manner.

acquireWritingDocument

DocumentContext acquireWritingDocument(boolean metaData)
                                throws UnrecoverableTimeoutException

Obtains a DocumentContext for writing. This method either initiates a new context or reuses an existing one. Depending on the use case, calling the close() method on the context might be optional.

Parameters:

metaData - A boolean indicating if metadata should be included during writing.

Returns:

An existing or new DocumentContext tailored to the metadata preference.

Throws:

UnrecoverableTimeoutException - If the operation times out in an unrecoverable manner.