com.bytelightning.opensource.pokerface

Class AbsClientRequestConsumer

java.lang.Object

com.bytelightning.opensource.pokerface.AbsClientRequestConsumer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

Direct Known Subclasses:

RequestForFileConsumer, RequestForScriptConsumer, RequestForTargetConsumer

public abstract class AbsClientRequestConsumer
extends Object
implements org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

Abstract base class to consume a request from the client / browser. Every request from a client will cause an instance of this class to be created.

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferIOController	buffer
protected org.apache.http.protocol.HttpContext	context
protected static org.slf4j.Logger	Logger
protected ResponseProducer	producer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbsClientRequestConsumer(org.apache.http.protocol.HttpContext context, BufferIOController buffer, ResponseProducer producer) Primary constructor

Method Summary

Modifier and Type	Method and Description
void	close() This specialization currently does nothing.
void	consumeContent(org.apache.http.nio.ContentDecoder decoder, org.apache.http.nio.IOControl ioctrl) This method is only called if the request had content (e.g.
void	failed(Exception exception)
Exception	getException()
ResponseProducer	getResult() Returns the ResponseProducer that will ultimately send the result of this request/response transaction back to the client.
boolean	isDone()
void	requestCompleted(org.apache.http.protocol.HttpContext context) Invoked once the request has been fully received by this server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer

requestReceived

Field Detail

Logger

protected static final org.slf4j.Logger Logger

context

protected final org.apache.http.protocol.HttpContext context

buffer

protected final BufferIOController buffer

producer

protected volatile ResponseProducer producer

Constructor Detail

AbsClientRequestConsumer

protected AbsClientRequestConsumer(org.apache.http.protocol.HttpContext context,
                                   BufferIOController buffer,
                                   ResponseProducer producer)

Primary constructor

Parameters:

context - The context of this http transaction.

buffer - An asynchronous friendly buffer to hold any incoming request content

producer - The ResponseProducer that is responsible for handling our response back to the requesting client.

Method Detail

consumeContent

public void consumeContent(org.apache.http.nio.ContentDecoder decoder,
                           org.apache.http.nio.IOControl ioctrl)
                    throws IOException

This method is only called if the request had content (e.g. POST). It reads the incoming request data and stores it in it's buffer to be read asynchronously by some other object (typically a RequestProducer).

Specified by:

consumeContent in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

Throws:

IOException

requestCompleted

public void requestCompleted(org.apache.http.protocol.HttpContext context)

Invoked once the request has been fully received by this server. This method also sets the writeCompleted flag on it's buffer (if it has one).

Specified by:

requestCompleted in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

getResult

public ResponseProducer getResult()

Returns the ResponseProducer that will ultimately send the result of this request/response transaction back to the client.

Specified by:

getResult in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

isDone

public boolean isDone()

Specified by:

isDone in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

getException

public Exception getException()

Specified by:

getException in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

failed

public void failed(Exception exception)

Specified by:

failed in interface org.apache.http.nio.protocol.HttpAsyncRequestConsumer<ResponseProducer>

close

public void close()
           throws IOException

This specialization currently does nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException