HttpAsyncService@Deprecated @Contract(threading=IMMUTABLE_CONDITIONAL) public class AsyncNHttpServiceHandler extends NHttpHandlerBase implements NHttpServiceHandler
ConsumingNHttpEntity and ProducingNHttpEntity interfaces.
When using this class, 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 enclose a content entity, 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.
Individual NHttpRequestHandlers do not have to submit a response
immediately. They can defer transmission of the HTTP response back to the
client without blocking the I/O thread and to delegate the processing the
HTTP request to a worker thread. The worker thread in its turn can use an
instance of NHttpResponseTrigger passed as a parameter to submit
a response as at a later point of time once the response becomes available.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AsyncNHttpServiceHandler.ServerConnState
Deprecated.
|
| Modifier and Type | Field and Description |
|---|---|
protected HttpExpectationVerifier |
expectationVerifier
Deprecated.
|
protected NHttpRequestHandlerResolver |
handlerResolver
Deprecated.
|
protected HttpResponseFactory |
responseFactory
Deprecated.
|
allocator, CONN_STATE, connStrategy, eventListener, httpProcessor, params| Constructor and Description |
|---|
AsyncNHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
ByteBufferAllocator allocator,
HttpParams params)
Deprecated.
|
AsyncNHttpServiceHandler(HttpProcessor httpProcessor,
HttpResponseFactory responseFactory,
ConnectionReuseStrategy connStrategy,
HttpParams params)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
closed(NHttpServerConnection conn)
Deprecated.
Triggered when the connection is closed.
|
void |
connected(NHttpServerConnection conn)
Deprecated.
Triggered when a new incoming connection is created.
|
void |
exception(NHttpServerConnection conn,
HttpException httpex)
Deprecated.
Triggered when an HTTP protocol violation occurs while receiving
an HTTP request.
|
void |
exception(NHttpServerConnection conn,
IOException ex)
Deprecated.
Triggered when an I/O error occurs while reading from or writing
to the underlying channel.
|
void |
inputReady(NHttpServerConnection conn,
ContentDecoder decoder)
Deprecated.
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)
Deprecated.
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)
Deprecated.
Triggered when a new HTTP request is received.
|
protected void |
responseComplete(HttpResponse response,
HttpContext context)
Deprecated.
Signals that this response has been fully sent.
|
void |
responseReady(NHttpServerConnection conn)
Deprecated.
Triggered when the connection is ready to accept a new HTTP response.
|
void |
setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
Deprecated.
|
void |
setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)
Deprecated.
|
void |
timeout(NHttpServerConnection conn)
Deprecated.
Triggered when no input is detected on this connection over the
maximum period of inactivity.
|
canResponseHaveBody, closeConnection, getParams, handleTimeout, setEventListener, shutdownConnectionprotected final HttpResponseFactory responseFactory
protected NHttpRequestHandlerResolver handlerResolver
protected HttpExpectationVerifier expectationVerifier
public AsyncNHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, ByteBufferAllocator allocator, HttpParams params)
public AsyncNHttpServiceHandler(HttpProcessor httpProcessor, HttpResponseFactory responseFactory, ConnectionReuseStrategy connStrategy, HttpParams params)
public void setExpectationVerifier(HttpExpectationVerifier expectationVerifier)
public void setHandlerResolver(NHttpRequestHandlerResolver handlerResolver)
public void connected(NHttpServerConnection conn)
NHttpServiceHandlerconnected in interface NHttpServiceHandlerconn - new incoming connection HTTP connection.public void requestReceived(NHttpServerConnection conn)
NHttpServiceHandler
If the request received encloses a request entity this method will
be followed a series of
NHttpServiceHandler.inputReady(NHttpServerConnection, ContentDecoder) calls
to transfer the request content.
requestReceived in interface NHttpServiceHandlerconn - HTTP connection that contains a new HTTP requestNHttpServerConnectionpublic void closed(NHttpServerConnection conn)
NHttpServiceHandlerclosed in interface NHttpServiceHandlerconn - closed HTTP connection.public void exception(NHttpServerConnection conn, HttpException httpex)
NHttpServiceHandlerexception in interface NHttpServiceHandlerconn - HTTP connection that caused an HTTP protocol violationhttpex - HTTP protocol violation exceptionpublic void exception(NHttpServerConnection conn, IOException ex)
NHttpServiceHandlerexception in interface NHttpServiceHandlerconn - HTTP connection that caused an I/O errorex - I/O exceptionpublic void timeout(NHttpServerConnection conn)
NHttpServiceHandlertimeout in interface NHttpServiceHandlerconn - HTTP connection that caused timeout condition.public void inputReady(NHttpServerConnection conn, ContentDecoder decoder)
NHttpServiceHandler
If the content consumer is unable to process the incoming content,
input event notifications can be temporarily suspended using
IOControl interface.
inputReady in interface NHttpServiceHandlerconn - HTTP connection that can produce a new portion of the
incoming request content.decoder - The content decoder to use to read content.NHttpServerConnection,
ContentDecoder,
IOControlpublic void responseReady(NHttpServerConnection conn)
NHttpServiceHandlerresponseReady in interface NHttpServiceHandlerconn - HTTP connection that contains an HTTP responseNHttpServerConnectionpublic void outputReady(NHttpServerConnection conn, ContentEncoder encoder)
NHttpServiceHandler
If the content producer is unable to generate the outgoing content,
output event notifications can be temporarily suspended using
IOControl interface.
outputReady in interface NHttpServiceHandlerconn - HTTP connection that can accommodate a new portion
of the outgoing response content.encoder - The content encoder to use to write content.NHttpServerConnection,
ContentEncoder,
IOControlprotected void responseComplete(HttpResponse response, HttpContext context)
Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.