Package net.officefloor.server

Interface ResponseWriter

public interface ResponseWriter

Writes the response.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	closeConnection(Throwable failure)	Indicates failure processing connection.
void	execute(SocketRunnable runnable)	Executes the SocketRunnable on the Socket Thread.
StreamBufferPool<ByteBuffer>	getStreamBufferPool()	Obtains the StreamBufferPool.
void	write(ResponseHeaderWriter responseHeaderWriter, StreamBuffer<ByteBuffer> headResponseBuffer)	Writes the StreamBuffer instances as the response.

Method Details

getStreamBufferPool

StreamBufferPool<ByteBuffer> getStreamBufferPool()

Obtains the StreamBufferPool.

Returns:

StreamBufferPool.

execute

void execute(SocketRunnable runnable)

Executes the SocketRunnable on the Socket Thread.

Parameters:

runnable - SocketRunnable.

write

void write(ResponseHeaderWriter responseHeaderWriter,
 StreamBuffer<ByteBuffer> headResponseBuffer)

Writes the StreamBuffer instances as the response.

Parameters:

responseHeaderWriter - ResponseHeaderWriter.

headResponseBuffer - Head StreamBuffer for the linked list of StreamBuffer instances for the response. Once the StreamBuffer is written back to the Socket, it is released back to its StreamBufferPool.

closeConnection

void closeConnection(Throwable failure)

Indicates failure processing connection.

Should there be an unrecoverable failure of the connection, this enables closing the connection.

Parameters:

failure - Cause of the failure.