net.openhft.chronicle.wire

Interface DocumentWritten

All Known Subinterfaces:

ChronicleChannel, InternalChronicleChannel, MarshallableOut, MethodWriterWithContext, Wire, WireOut

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, BufferedChronicleChannel, CSVWire, DelegateChronicleChannel, EchoChannel, FileMarshallableOut, HashWire, HTTPMarshallableOut, JSONWire, QueryWire, RawWire, ReadAnyWire, StringConsumerMarshallableOut, TCPChronicleChannel, TextWire, WireExchanger, YamlWire, YamlWireOut

public interface DocumentWritten

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
DocumentContext	writingDocument()
DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.

Method Detail

writingDocument

DocumentContext writingDocument()

Returns:

a context to use in a try-with-resource block

writingDocument

DocumentContext writingDocument(boolean metaData)
                         throws UnrecoverableTimeoutException

Start a new DocumentContext, must always call close() when done.

Throws:

UnrecoverableTimeoutException

acquireWritingDocument

DocumentContext acquireWritingDocument(boolean metaData)
                                throws UnrecoverableTimeoutException

Start or reuse an existing a DocumentContext, optionally call close() when done.

Throws:

UnrecoverableTimeoutException