net.officefloor.plugin.socket.server.protocol

Interface WriteBuffer

All Known Implementing Classes:

ArrayWriteBuffer, BufferWriteBuffer

public interface WriteBuffer

Buffer with data to write.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Obtains the data to write.
ByteBuffer	getDataBuffer() Obtains the buffered data to write.
WriteBufferEnum	getType() Obtains the type of this WriteBuffer.
int	length() Obtains the number of bytes in the data to write.

Method Detail

getType

WriteBufferEnum getType()

Obtains the type of this WriteBuffer.

Returns:

Type of this WriteBuffer.

getData

byte[] getData()

Obtains the data to write.

Returns:

Data to write. null if containing data in ByteBuffer.

length

int length()

Obtains the number of bytes in the data to write.

Returns:

Number of bytes in the data to write. -1 if providing data through ByteBuffer.

getDataBuffer

ByteBuffer getDataBuffer()

Obtains the buffered data to write.

This allows the ConnectionHandler to cache content in direct ByteBuffer instances to write to the client.

Returns:

ByteBuffer containing data to write.