|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.nio.protocol.NHttpHandlerBase
org.apache.http.nio.protocol.AsyncNHttpServiceHandler
public class AsyncNHttpServiceHandler
HTTP service handler implementation that works with
ConsumingNHttpEntity
and ProducingNHttpEntity
. The contents
of HTTP headers are stored in memory, HTTP entities are streamed directly
from the entities to the underlying channel (and vice versa).
When using this, it is important to ensure that entities supplied for writing
implement ProducingNHttpEntity. Doing so will allow the entity to be written
out asynchronously. If entities supplied for writing do not implement
ProducingNHttpEntity, a delegate is added that buffers the entire contents in
memory. Additionally, the buffering might take place in the I/O thread, which
could cause I/O to block temporarily. For best results, ensure that all
entities set on HttpResponses
from
NHttpRequestHandlers
implement
ProducingNHttpEntity.
If incoming requests are entity requests, NHttpRequestHandlers are expected
to return a ConsumingNHttpEntity for reading the content. After the entity is
finished reading the data,
NHttpRequestHandler.handle(HttpRequest, HttpResponse, NHttpResponseTrigger, HttpContext)
is called to generate a response.
Nested Class Summary | |
---|---|
protected static class |
AsyncNHttpServiceHandler.ServerConnState
|
Field Summary | |
---|---|
protected HttpExpectationVerifier |
expectationVerifier
|
protected NHttpRequestHandlerResolver |
handlerResolver
|
protected HttpResponseFactory |
responseFactory
|
Fields inherited from class org.apache.http.nio.protocol.NHttpHandlerBase |
---|
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params |
Constructor Summary | |
---|---|
AsyncNHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
HttpParams params)
|
|
AsyncNHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
HttpParams params)
|
Method Summary | |
---|---|
void |
closed(NHttpServerConnection conn)
Triggered when the connection is closed. |
void |
connected(NHttpServerConnection conn)
Triggered when a new incoming connection is created. |
void |
exception(NHttpServerConnection conn,
HttpException httpex)
Triggered when an HTTP protocol violation occurs while receiving an HTTP request. |
void |
exception(NHttpServerConnection conn,
java.io.IOException ex)
Triggered when an I/O error occurrs while reading from or writing to the underlying channel. |
void |
inputReady(NHttpServerConnection conn,
ContentDecoder decoder)
Triggered when the underlying channel is ready for reading a new portion of the request entity through the corresponding content decoder. |
void |
outputReady(NHttpServerConnection conn,
ContentEncoder encoder)
Triggered when the underlying channel is ready for writing a next portion of the response entity through the corresponding content encoder. |
void |
requestReceived(NHttpServerConnection conn)
Triggered when a new HTTP request is received. |
protected void |
responseComplete(HttpResponse response,
HttpContext context)
Signals that this response has been fully sent. |
void |
responseReady(NHttpServerConnection conn)
Triggered when the connection is ready to send an HTTP response. |
void |
setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
|
void |
setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)
|
void |
timeout(NHttpServerConnection conn)
Triggered when no input is detected on this connection over the maximum period of inactivity. |
Methods inherited from class org.apache.http.nio.protocol.NHttpHandlerBase |
---|
canResponseHaveBody, closeConnection, getParams, handleTimeout, setEventListener, shutdownConnection |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final HttpResponseFactory responseFactory
protected NHttpRequestHandlerResolver handlerResolver
protected HttpExpectationVerifier expectationVerifier
Constructor Detail |
---|
public AsyncNHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
public AsyncNHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, HttpParams params)
Method Detail |
---|
public void setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
public void setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)
public void connected(NHttpServerConnection conn)
NHttpServiceHandler
connected
in interface NHttpServiceHandler
conn
- new incoming connection HTTP connection.public void requestReceived(NHttpServerConnection conn)
NHttpServiceHandler
NHttpServiceHandler.inputReady(NHttpServerConnection, ContentDecoder)
calls
to transfer the request content.
requestReceived
in interface NHttpServiceHandler
conn
- HTTP connection that contains a new HTTP requestNHttpServerConnection
public void closed(NHttpServerConnection conn)
NHttpServiceHandler
closed
in interface NHttpServiceHandler
conn
- closed HTTP connection.public void exception(NHttpServerConnection conn, HttpException httpex)
NHttpServiceHandler
exception
in interface NHttpServiceHandler
conn
- HTTP connection that caused an HTTP protocol violationhttpex
- HTTP protocol violation exceptionpublic void exception(NHttpServerConnection conn, java.io.IOException ex)
NHttpServiceHandler
exception
in interface NHttpServiceHandler
conn
- HTTP connection that caused an I/O errorex
- I/O exceptionpublic void timeout(NHttpServerConnection conn)
NHttpServiceHandler
timeout
in interface NHttpServiceHandler
conn
- HTTP connection that caused timeout condition.public void inputReady(NHttpServerConnection conn, ContentDecoder decoder)
NHttpServiceHandler
IOControl.suspendInput()
.
inputReady
in interface NHttpServiceHandler
conn
- HTTP connection that can produce a new portion of the
incoming request content.decoder
- The content decoder to use to read content.NHttpConnection
,
ContentDecoder
public void responseReady(NHttpServerConnection conn)
NHttpServiceHandler
responseReady
in interface NHttpServiceHandler
conn
- HTTP connection that contains an HTTP responseNHttpServerConnection
public void outputReady(NHttpServerConnection conn, ContentEncoder encoder)
NHttpServiceHandler
IOControl.suspendOutput()
.
outputReady
in interface NHttpServiceHandler
conn
- HTTP connection that can accommodate a new portion
of the outgoing response content.encoder
- The content encoder to use to write content.NHttpConnection
,
ContentEncoder
protected void responseComplete(HttpResponse response, HttpContext context)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |