net.openhft.chronicle.wire

Interface MarshallableOut

public interface MarshallableOut

Created by peter.lawrey on 06/02/2016. Anything you can write Marshallable objects to.

Method Summary

Modifier and Type	Method and Description
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> MethodWriterBuilder<T>	methodWriterBuilder(Class<T> tClass)
boolean	recordHistory()
default void	writeBytes(net.openhft.chronicle.bytes.WriteBytesMarshallable marshallable)
default <T> void	writeDocument(T t, java.util.function.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)
DocumentContext	writingDocument() Start a document which is completed when DocumentContext.close() is called.

Method Detail

writingDocument

DocumentContext writingDocument()

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");
 }
 

Returns:

the DocumentContext

recordHistory

boolean recordHistory()

Returns:

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

writeMessage

default void writeMessage(WireKey key,
                          Object value)

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

Parameters:

key - to write

value - to write with it.

writeDocument

default void writeDocument(WriteMarshallable writer)

Write the Marshallable as a document/message

Parameters:

writer - to write

writeBytes

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

Parameters:

marshallable - to write to excerpt.

writeDocument

default <T> void writeDocument(T t,
                               java.util.function.BiConsumer<ValueOut,T> writer)

Write an object with a custom marshalling.

Parameters:

t - to write

writer - using this code

writeText

default void writeText(CharSequence text)

Parameters:

text - to write a message

writeMap

default void writeMap(Map<?,?> map)

Write a Map as a marshallable

methodWriter

default <T> T methodWriter(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)

methodWriterBuilder

default <T> MethodWriterBuilder<T> methodWriterBuilder(Class<T> tClass)