net.openhft.chronicle.wire

Class WireToOutputStream

java.lang.Object

net.openhft.chronicle.wire.WireToOutputStream

public class WireToOutputStream
extends Object

Provides a bridge to write structured data in Chronicle Wire format to a standard Java OutputStream.

The class facilitates writing data to an OutputStream using the Wire format. It uses an intermediate Bytes buffer to temporarily hold data in the Wire format before flushing it to the actual OutputStream. The provided OutputStream is not closed by this class

Constructor Summary

Constructors

Constructor and Description
WireToOutputStream(WireType wireType, OutputStream os) Creates a new bridge for the given wire type and output stream.

Method Summary

Modifier and Type	Method and Description
void	flush() Writes the data currently in the wire buffer to the underlying output stream.
Wire	getWire() Returns the internal Wire prepared for a new message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WireToOutputStream

public WireToOutputStream(WireType wireType,
                          OutputStream os)

Creates a new bridge for the given wire type and output stream.

Parameters:

wireType - the WireType used to serialise data into the internal buffer (for example Binary, Text or JSON).

os - the OutputStream to which length-prefixed messages will be written when flush() is called. This stream is not closed by this class.

Method Detail

getWire

public Wire getWire()

Returns the internal Wire prepared for a new message.

The backing buffer is cleared before the wire is returned. Any data not yet flushed will be lost.

Returns:

the cleared Wire ready for serialisation.

flush

public void flush()
           throws IOException

Writes the data currently in the wire buffer to the underlying output stream.

A four byte length is written first, followed by the serialised bytes. The content remains in the buffer until getWire() is called.

Throws:

IOException - if an I/O error occurs while writing.