Package net.officefloor.server

Interface RequestHandler<R>

public interface RequestHandler<R>

Handles requests.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	closeConnection(java.lang.Throwable exception)	Allows to close connection.
void	execute(SocketRunnable runnable)	Executes the SocketRunnable on the Socket Thread.
StreamBufferPool<java.nio.ByteBuffer>	getStreamBufferPool()	Obtains the StreamBufferPool for thsi RequestHandler.
void	handleRequest(R request)	Handles a request.
boolean	isReadingInput()	Indicates if reading Socket input from client.
void	sendImmediateData(StreamBuffer<java.nio.ByteBuffer> immediateHead)	Sends data immediately.

Method Detail

isReadingInput

boolean isReadingInput()

Indicates if reading Socket input from client.

To avoid out of memory, the reading from the Socket may be halted temporarily. This indicates if actively reading input from the Socket.

Returns:

true if reading Socket input from client.

getStreamBufferPool

StreamBufferPool<java.nio.ByteBuffer> getStreamBufferPool()

Obtains the StreamBufferPool for thsi RequestHandler.

Returns:

StreamBufferPool for thsi RequestHandler.

execute

void execute(SocketRunnable runnable)

Executes the SocketRunnable on the Socket Thread.

Parameters:

runnable - SocketRunnable.

handleRequest

void handleRequest(R request)
            throws java.io.IOException,
                   java.lang.IllegalStateException

Handles a request.

This may only be invoked by the Socket Thread.

Parameters:

request - Request.

Throws:

java.io.IOException - If fails to handle the request.

java.lang.IllegalStateException - If invoked from another Thread.

sendImmediateData

void sendImmediateData(StreamBuffer<java.nio.ByteBuffer> immediateHead)
                throws java.lang.IllegalStateException

Sends data immediately.

This may only be invoked by the Socket Thread.

Parameters:

immediateHead - Head StreamBuffer to linked list of StreamBuffer instances of data to send immediately.

Throws:

java.lang.IllegalStateException - If invoked from another Thread.

closeConnection

void closeConnection(java.lang.Throwable exception)

Allows to close connection.

Parameters:

exception - Optional Exception for the cause of closing the connection. null to indicate normal close.