net.officefloor.plugin.stream

Interface WriteBufferReceiver

All Known Subinterfaces:

Connection

All Known Implementing Classes:

ConnectionImpl, MockServerOutputStream, SslConnectionImpl, TcpConnectionHandler

public interface WriteBufferReceiver

Receives the output bytes.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	close() Flags to close the WriteBufferReceiver.
WriteBuffer	createWriteBuffer(byte[] data, int length) Creates a WriteBuffer for the data.
WriteBuffer	createWriteBuffer(ByteBuffer buffer) Creates the WriteBuffer for the ByteBuffer.
Object	getLock() Obtains the lock to synchronize for using this WriteBufferReceiver.
boolean	isClosed() Indicates if the WriteBufferReceiver is closed.
void	writeData(WriteBuffer[] data) Writes data to client of this Connection.

Method Detail

getLock

Object getLock()

Obtains the lock to synchronize for using this WriteBufferReceiver.

Returns:

Lock for this WriteBufferReceiver.

createWriteBuffer

WriteBuffer createWriteBuffer(byte[] data,
                              int length)

Creates a WriteBuffer for the data.

Parameters:

data - Data.

length - Length of data.

Returns:

WriteBuffer.

createWriteBuffer

WriteBuffer createWriteBuffer(ByteBuffer buffer)

Creates the WriteBuffer for the ByteBuffer.

Parameters:

buffer - ByteBuffer.

Returns:

WriteBuffer.

writeData

void writeData(WriteBuffer[] data)
        throws IOException

Writes data to client of this Connection.

Parameters:

data - Data to be written.

Throws:

IOException - If fails to write data.

close

void close()
    throws IOException

Flags to close the WriteBufferReceiver.

Close occurs after all data has been written.

Throws:

IOException - If fails to close.

isClosed

boolean isClosed()

Indicates if the WriteBufferReceiver is closed.

Returns:

true if the WriteBufferReceiver is closed.