net.openhft.chronicle.wire

Interface MarshallableOut

All Known Subinterfaces:

Wire, WireOut

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, DeferredTypeWire, HashWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MarshallableOut

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MarshallableOut.Padding

Method Summary

Modifier and Type	Method and Description
default <T> T	methodWriter(boolean metaData, Class<T> tClass, Class... additional) Proxy an interface so each message called is written to a file for method.
default <T> T	methodWriter(Class<T> tClass, Class... additional) Proxy an interface so each message called is written to a file for replay.
default <T> VanillaMethodWriterBuilder<T>	methodWriterBuilder(Class<T> tClass)
default MarshallableOut.Padding	padToCacheAlignMode() adds padding to align to cache lines.
default boolean	recordHistory()
default void	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
default <T> void	writeDocument(T t, BiConsumer<ValueOut,T> writer) Write an object with a custom marshalling.
default void	writeDocument(WriteMarshallable writer) Write the Marshallable as a document/message
default void	writeMap(Map<?,?> map) Write a Map as a marshallable
default void	writeMessage(WireKey key, Object value) Wrie a key and value which could be a scalar or a marshallable.
default void	writeText(CharSequence text)
default DocumentContext	writingDocument() Start a document which is completed when DocumentContext.close() is called.
DocumentContext	writingDocument(boolean metaData)

Method Detail

writingDocument

@NotNull
default 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.
 }
 

Throws:

UnrecoverableTimeoutException

writingDocument

DocumentContext writingDocument(boolean metaData)
                         throws UnrecoverableTimeoutException

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

writeDocument

default void writeDocument(@NotNull
                           WriteMarshallable writer)
                    throws UnrecoverableTimeoutException

Write the Marshallable as a document/message

Parameters:

writer - to write

Throws:

UnrecoverableTimeoutException

writeBytes

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

Parameters:

marshallable - to write to excerpt.

Throws:

UnrecoverableTimeoutException

writeDocument

default <T> void writeDocument(T t,
                               @NotNull
                               BiConsumer<ValueOut,T> writer)
                        throws UnrecoverableTimeoutException

Write an object with a custom marshalling.

Parameters:

t - to write

writer - using this code

Throws:

UnrecoverableTimeoutException

writeText

default void writeText(@NotNull
                       CharSequence text)
                throws UnrecoverableTimeoutException

Parameters:

text - to write a message

Throws:

UnrecoverableTimeoutException

writeMap

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

Write a Map as a marshallable

Throws:

UnrecoverableTimeoutException

methodWriter

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

Proxy an interface so each message called is written to a file 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

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

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

additional - any additional interfaces

Returns:

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

methodWriterBuilder

@NotNull
default <T> VanillaMethodWriterBuilder<T> methodWriterBuilder(@NotNull
                                                                       Class<T> tClass)

padToCacheAlignMode

@NotNull
default MarshallableOut.Padding padToCacheAlignMode()

adds padding to align to cache lines. So that wire header messages don't straggle cache lines

Returns:

the state of padding