net.openhft.chronicle.wire

Interface MarshallableOut

All Superinterfaces:

DocumentWritten

All Known Subinterfaces:

ChronicleChannel, InternalChronicleChannel, 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 MarshallableOut
extends DocumentWritten

Anything you can write Marshallable objects to.

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
static MarshallableOutBuilder	builder(URL url)
default <T> T	methodWriter(boolean metaData, @NotNull Class<T> tClass, Class... additional) Deprecated. use methodWriterBuilder with Stream.of(additional).forEach(builder::addInterface);
default <T> T	methodWriter(@NotNull Class<T> tClass, Class... additional) Proxy an interface so each message called is written for replay.
default <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	methodWriterBuilder(boolean metaData, @NotNull Class<T> tClass) Proxy an interface so each message called is written to a file for method.
default <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	methodWriterBuilder(@NotNull Class<T> tClass) Return a builder for a proxy an interface so each message called is written for method.
default boolean	recordHistory()
default void	writeBytes(@NotNull net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
default <T> void	writeDocument(T t, @NotNull BiConsumer<ValueOut,T> writer) Write an object with a custom marshalling.
default void	writeDocument(@NotNull WriteMarshallable writer) Write the Marshallable as a document/message
default void	writeMap(@NotNull Map<?,?> map) Write a Map as a marshallable
default void	writeMessage(String eventName, Object value)
default void	writeMessage(WireKey key, Object value) Wrie a key and value which could be a scalar or a marshallable.
default void	writeText(@NotNull CharSequence text)
default @NotNull DocumentContext	writingDocument() Start a document which is completed when DocumentContext.close() is called.
DocumentContext	writingDocument(boolean metaData) Start a new DocumentContext, must always call close() when done.

Method Detail

builder

static MarshallableOutBuilder builder(URL url)

writingDocument

@NotNull
default @NotNull DocumentContext writingDocument()
                                                   throws UnrecoverableTimeoutException

Start a document which is completed when DocumentContext.close() is called. You can use a

 try(DocumentContext dc = appender.writingDocument()) {
      dc.wire().write("message").text("Hello World");
 }
 

WARNING : any data written inside the writingDocument(), should be performed as quickly as possible because a write lock is held until the DocumentContext is closed by the try-with-resources, this blocks other appenders and tailers.

 try (DocumentContext dc = appender.writingDocument()) {
      // this should be performed as quickly as possible because a write lock is held until
 the
      // DocumentContext is closed by the try-with-resources,  this blocks other appenders
      and tailers.
 }
 

Specified by:

writingDocument in interface DocumentWritten

Returns:

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

Throws:

UnrecoverableTimeoutException

writingDocument

DocumentContext writingDocument(boolean metaData)
                         throws UnrecoverableTimeoutException

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

Specified by:

writingDocument in interface DocumentWritten

Throws:

UnrecoverableTimeoutException

acquireWritingDocument

DocumentContext acquireWritingDocument(boolean metaData)
                                throws UnrecoverableTimeoutException

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

Specified by:

acquireWritingDocument in interface DocumentWritten

Throws:

UnrecoverableTimeoutException

recordHistory

default boolean recordHistory()

Returns:

true if this output is configured to expect the history of the message to be written to.

writeMessage

default void writeMessage(WireKey key,
                          Object value)
                   throws UnrecoverableTimeoutException

Wrie a key and value which could be a scalar or a marshallable.

Parameters:

key - to write

value - to write with it.

Throws:

UnrecoverableTimeoutException

writeMessage

default void writeMessage(String eventName,
                          Object value)
                   throws UnrecoverableTimeoutException

Throws:

UnrecoverableTimeoutException

writeDocument

default void writeDocument(@NotNull
                           @NotNull WriteMarshallable writer)
                    throws UnrecoverableTimeoutException,
                           net.openhft.chronicle.core.io.InvalidMarshallableException

Write the Marshallable as a document/message

Parameters:

writer - to write

Throws:

UnrecoverableTimeoutException

net.openhft.chronicle.core.io.InvalidMarshallableException

writeBytes

default void writeBytes(@NotNull
                        @NotNull net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
                 throws UnrecoverableTimeoutException,
                        net.openhft.chronicle.core.io.InvalidMarshallableException

Parameters:

marshallable - to write to excerpt.

Throws:

UnrecoverableTimeoutException

net.openhft.chronicle.core.io.InvalidMarshallableException

writeDocument

default <T> void writeDocument(T t,
                               @NotNull
                               @NotNull BiConsumer<ValueOut,T> writer)
                        throws UnrecoverableTimeoutException,
                               net.openhft.chronicle.core.io.InvalidMarshallableException

Write an object with a custom marshalling.

Parameters:

t - to write

writer - using this code

Throws:

UnrecoverableTimeoutException

net.openhft.chronicle.core.io.InvalidMarshallableException

writeText

default void writeText(@NotNull
                       @NotNull CharSequence text)
                throws UnrecoverableTimeoutException

Parameters:

text - to write a message

Throws:

UnrecoverableTimeoutException

writeMap

default void writeMap(@NotNull
                      @NotNull Map<?,?> map)
               throws UnrecoverableTimeoutException

Write a Map as a marshallable

Throws:

UnrecoverableTimeoutException

methodWriter

@NotNull
default <T> T methodWriter(@NotNull
                                    @NotNull Class<T> tClass,
                                    Class... additional)

Proxy an interface so each message called is written for replay.

Parameters:

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

methodWriter

@Deprecated
 @NotNull
default <T> T methodWriter(boolean metaData,
                                                 @NotNull
                                                 @NotNull Class<T> tClass,
                                                 Class... additional)

Deprecated. use methodWriterBuilder with Stream.of(additional).forEach(builder::addInterface);

Proxy an interface so each message called is written for method.

Parameters:

metaData - true if you wish to write every method as meta data

tClass - primary interface

additional - any additional interfaces

Returns:

a proxy which implements the primary interface (additional interfaces have to be cast)

methodWriterBuilder

@NotNull
default <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                                                     @NotNull Class<T> tClass)

Return a builder for a proxy an interface so each message called is written for method.

Parameters:

tClass - primary interface

Returns:

a builder for a proxy which implements the interface

methodWriterBuilder

@NotNull
default <T> @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> methodWriterBuilder(boolean metaData,
                                                                                                     @NotNull
                                                                                                     @NotNull Class<T> tClass)

Proxy an interface so each message called is written to a file for method.

Parameters:

metaData - true if you wish to write every method as meta data

tClass - primary interface

Returns:

a proxy which implements the interface