Package org.jgrapes.io.util

Class ByteBufferOutputStream

java.lang.Object

java.io.OutputStream

org.jgrapes.io.util.ByteBufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ByteBufferOutputStream
extends OutputStream

An OutputStream that is backed by ByteBuffers obtained from a queue.

When a byte buffer is full, a Output event (default) is generated and a new buffer is fetched from the queue.

Constructor Summary

Constructors

Constructor	Description
ByteBufferOutputStream(IOSubchannel channel)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.
ByteBufferOutputStream(IOSubchannel channel, EventPipeline eventPipeline)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the given event pipeline.

Method Summary

Modifier and Type	Method	Description
void	close()	Flushes any remaining data with the end of record flag set (unless suppressEndOfRecord() has been called) and fires a Close event (unless suppressClose() has been called).
void	flush()	Creates and fires a Output event with the buffer being filled if it contains any data.
ByteBufferOutputStream	sendInputEvents()	Causes the data to be fired as Input events rather than the usual Output events.
ByteBufferOutputStream	suppressClose()	Suppresses sending of a close event when the stream is closed.
ByteBufferOutputStream	suppressEndOfRecord()	Suppresses setting the end of record flag when the stream is flushed or closed.
void	write(byte[] data)
void	write(byte[] data, int offset, int length)
void	write(int data)

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

ByteBufferOutputStream

public ByteBufferOutputStream(IOSubchannel channel,
 EventPipeline eventPipeline)

Creates a new instance that uses Output events to dispatch buffers on the given channel, using the given event pipeline.

Parameters:

channel - the channel to fire events on

eventPipeline - the event pipeline used for firing events

ByteBufferOutputStream

public ByteBufferOutputStream(IOSubchannel channel)

Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.

Parameters:

channel - the channel to fire events on

Method Details

sendInputEvents

public ByteBufferOutputStream sendInputEvents()

Causes the data to be fired as Input events rather than the usual Output events.

Returns:

the stream for easy chaining

suppressClose

public ByteBufferOutputStream suppressClose()

Suppresses sending of a close event when the stream is closed.

Returns:

the stream for easy chaining

suppressEndOfRecord

public ByteBufferOutputStream suppressEndOfRecord()

Suppresses setting the end of record flag when the stream is flushed or closed.

Returns:

the stream for easy chaining

See Also:

• IOEvent.isEndOfRecord()

write

public void write(int data)

Specified by:

write in class OutputStream

write

public void write(byte[] data,
 int offset,
 int length)

Overrides:

write in class OutputStream

write

public void write(byte[] data)

Overrides:

write in class OutputStream

flush

public void flush()

Creates and fires a Output event with the buffer being filled if it contains any data.

By default, the Output event is created with the end of record flag set (see IOEvent.isEndOfRecord()) in order to forward the flush as event. This implies that an Output event with no data (but the end of record flag set) may be fired. This behavior can be disabled with suppressEndOfRecord().

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

close

public void close()

Flushes any remaining data with the end of record flag set (unless suppressEndOfRecord() has been called) and fires a Close event (unless suppressClose() has been called).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream