net.openhft.chronicle.wire

Class WireToOutputStream

java.lang.Object

net.openhft.chronicle.wire.WireToOutputStream

public class WireToOutputStream
extends Object

This class bridges between a Wire object and a traditional 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.

Constructor Summary

Constructors

Constructor and Description
WireToOutputStream(WireType wireType, OutputStream os) Constructs a new instance with the specified WireType and OutputStream.

Method Summary

Modifier and Type	Method and Description
void	flush() Flushes the data in Wire format to the underlying OutputStream.
Wire	getWire() Retrieves the Wire object for writing data.

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)

Constructs a new instance with the specified WireType and OutputStream.

Parameters:

wireType - The type of Wire to be used.

os - The OutputStream to which the data in Wire format will be written.

Method Detail

getWire

public Wire getWire()

Retrieves the Wire object for writing data.

This method also clears any previous data in the Wire.

Returns:

The Wire object to be used for writing data.

flush

public void flush()
           throws IOException

Flushes the data in Wire format to the underlying OutputStream.

The method writes the length of the data followed by the actual data to the OutputStream. After the flush, the internal buffer is ready to hold new data.

Throws:

IOException - If an I/O error occurs.