com.bytelightning.opensource.pokerface

Class BufferIOController

java.lang.Object

com.bytelightning.opensource.pokerface.BufferIOController

public class BufferIOController
extends Object

This class provides flow control of a shared read/write ByteBuffer which it lazily obtains from a ObjectPool. One will be allocated for each request received from a client and another will be allocated to produce the response back to the client. The flow control methods enable an AbsClientRequestConsumer to read in client request data, which hands off to a TargetRequestProducer who flips the buffer and writes it's content out to the target.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	Logger

Constructor Summary

Constructors

Constructor and Description
BufferIOController(org.apache.commons.pool2.ObjectPool<ByteBuffer> bufferPool) Primary constructor

Method Summary

Modifier and Type	Method and Description
void	close() This method MUST be called to clean up any borrowed ByteBuffers.
boolean	dataRead() This flow control method notifies us that data was read from our buffer (by the 'reading' IOControl).
void	dataWritten() This flow control method notifies us that data was written to our buffer (by the 'writing' IOControl).
ByteBuffer	getByteBuffer() Returns the ByteBuffer, lazily obtaining one from the pool if need be.
protected org.apache.commons.pool2.ObjectPool<ByteBuffer>	getPool() Returns the pool from which this IOEontroller allocates ByteBuffers.
void	setReadingIOControl(org.apache.http.nio.IOControl readingControl) This flow control method notifies us of the IOControl that will be reading from our ByteBuffer.
void	setWritingIOControl(org.apache.http.nio.IOControl writingControl) This flow control method notifies us of the IOControl that will be writing to our ByteBuffer.
void	writeCompleted() This flow control method notifies us that the 'writing' IOControl has finished writing data to our buffer.

Methods inherited from class java.lang.Object

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

Field Detail

Logger

protected static final org.slf4j.Logger Logger

Constructor Detail

BufferIOController

public BufferIOController(org.apache.commons.pool2.ObjectPool<ByteBuffer> bufferPool)

Primary constructor

Parameters:

bufferPool - A reusable pool of ByteBuffers that this object can lazily borrow from (and return to).

Method Detail

close

public void close()

This method MUST be called to clean up any borrowed ByteBuffers.

getPool

protected org.apache.commons.pool2.ObjectPool<ByteBuffer> getPool()

Returns the pool from which this IOEontroller allocates ByteBuffers. Please use this method responsibly!

getByteBuffer

public ByteBuffer getByteBuffer()

Returns the ByteBuffer, lazily obtaining one from the pool if need be.

setWritingIOControl

public void setWritingIOControl(org.apache.http.nio.IOControl writingControl)

This flow control method notifies us of the IOControl that will be writing to our ByteBuffer.

dataWritten

public void dataWritten()

This flow control method notifies us that data was written to our buffer (by the 'writing' IOControl). This gives us the opportunity to suspend the 'writing' IOControl if our buffer is full and to notify the 'reading' IOControl that data is available.

writeCompleted

public void writeCompleted()

This flow control method notifies us that the 'writing' IOControl has finished writing data to our buffer. This also gives us the opportunity to notify the 'reading' IOControl that data is available.

setReadingIOControl

public void setReadingIOControl(org.apache.http.nio.IOControl readingControl)

This flow control method notifies us of the IOControl that will be reading from our ByteBuffer.

dataRead

public boolean dataRead()

This flow control method notifies us that data was read from our buffer (by the 'reading' IOControl). This gives us the opportunity to suspend the 'reading' IOControl if our buffer has been fully drained, and to notify the 'writing' IOControl that it may write more data into the buffer.

Returns:

True if the 'writing' IOControl has notified us that it has completed writing, AND there is no more data in the buffer to be read.