depends.org.apache.http.nio.protocol

类 HttpAsyncService

java.lang.Object

depends.org.apache.http.nio.protocol.HttpAsyncService

所有已实现的接口:

NHttpServerEventHandler

@Immutable
public class HttpAsyncService
extends java.lang.Object
implements NHttpServerEventHandler

HttpAsyncService is a fully asynchronous HTTP server side protocol handler based on the non-blocking (NIO) I/O model. HttpAsyncServerProtocolHandler translates individual events fired through the NHttpServerEventHandler interface into logically related HTTP message exchanges.

Upon receiving an incoming request HttpAsyncService verifies the message for compliance with the server expectations using HttpAsyncExpectationVerifier, if provided, and then HttpAsyncRequestHandlerMapper is used to map the request to a particular HttpAsyncRequestHandler intended to handle the request with the given URI. The protocol handler uses the selected HttpAsyncRequestHandler instance to process the incoming request and to generate an outgoing response.

HttpAsyncService relies on HttpProcessor to generate mandatory protocol headers for all outgoing messages and apply common, cross-cutting message transformations to all incoming and outgoing messages, whereas individual HttpAsyncRequestHandlers are expected to implement application specific content generation and processing.

Individual HttpAsyncRequestHandlers do not have to submit a response immediately. They can defer transmission of an HTTP response back to the client without blocking the I/O thread by delegating the process of request handling to another service or a worker thread. HTTP response can be submitted as a later a later point of time once response content becomes available.

从以下版本开始:

4.2

构造器概要

构造器

构造器和说明
HttpAsyncService(HttpProcessor httpProcessor, ConnectionReuseStrategy connStrategy, HttpAsyncRequestHandlerResolver handlerResolver, HttpParams params) 已过时。 (4.3) use HttpAsyncService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpAsyncRequestHandlerMapper, HttpAsyncExpectationVerifier)
HttpAsyncService(HttpProcessor httpProcessor, ConnectionReuseStrategy connStrategy, HttpResponseFactory responseFactory, HttpAsyncRequestHandlerMapper handlerMapper, HttpAsyncExpectationVerifier expectationVerifier) Creates new instance of HttpAsyncServerProtocolHandler.
HttpAsyncService(HttpProcessor httpProcessor, ConnectionReuseStrategy connStrategy, HttpResponseFactory responseFactory, HttpAsyncRequestHandlerResolver handlerResolver, HttpAsyncExpectationVerifier expectationVerifier, HttpParams params) 已过时。 (4.3) use HttpAsyncService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpAsyncRequestHandlerMapper, HttpAsyncExpectationVerifier)
HttpAsyncService(HttpProcessor httpProcessor, HttpAsyncRequestHandlerMapper handlerMapper) Creates new instance of HttpAsyncServerProtocolHandler.

方法概要

方法

限定符和类型	方法和说明
void	closed(NHttpServerConnection conn) Triggered when the connection is closed.
void	connected(NHttpServerConnection conn) Triggered when a new incoming connection is created.
void	endOfInput(NHttpServerConnection conn) Triggered when the connection is closed by the opposite end point (half-closed).
void	exception(NHttpServerConnection conn, java.lang.Exception cause) Triggered if an error occurs during the HTTP exchange.
protected HttpAsyncResponseProducer	handleException(java.lang.Exception ex, HttpContext context)
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.
protected void	log(java.lang.Exception ex) This method can be used to log I/O exception thrown while closing Closeable objects (such as HttpConnection).
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.
void	responseReady(NHttpServerConnection conn) Triggered when the connection is ready to accept a new HTTP response.
void	timeout(NHttpServerConnection conn) Triggered when no input is detected on this connection over the maximum period of inactivity.

从类继承的方法 java.lang.Object

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

构造器详细资料

HttpAsyncService

@Deprecated
public HttpAsyncService(HttpProcessor httpProcessor,
                           ConnectionReuseStrategy connStrategy,
                           HttpResponseFactory responseFactory,
                           HttpAsyncRequestHandlerResolver handlerResolver,
                           HttpAsyncExpectationVerifier expectationVerifier,
                           HttpParams params)

已过时。 (4.3) use HttpAsyncService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpAsyncRequestHandlerMapper, HttpAsyncExpectationVerifier)

Creates new instance of HttpAsyncServerProtocolHandler.

参数:

httpProcessor - HTTP protocol processor (required).

connStrategy - Connection re-use strategy (required).

responseFactory - HTTP response factory (required).

handlerResolver - Request handler resolver.

expectationVerifier - Request expectation verifier (optional).

params - HTTP parameters (required).

HttpAsyncService

@Deprecated
public HttpAsyncService(HttpProcessor httpProcessor,
                           ConnectionReuseStrategy connStrategy,
                           HttpAsyncRequestHandlerResolver handlerResolver,
                           HttpParams params)

已过时。 (4.3) use HttpAsyncService(HttpProcessor, ConnectionReuseStrategy, HttpResponseFactory, HttpAsyncRequestHandlerMapper, HttpAsyncExpectationVerifier)

Creates new instance of HttpAsyncServerProtocolHandler.

参数:

httpProcessor - HTTP protocol processor (required).

connStrategy - Connection re-use strategy (required).

handlerResolver - Request handler resolver.

params - HTTP parameters (required).

HttpAsyncService

public HttpAsyncService(HttpProcessor httpProcessor,
                ConnectionReuseStrategy connStrategy,
                HttpResponseFactory responseFactory,
                HttpAsyncRequestHandlerMapper handlerMapper,
                HttpAsyncExpectationVerifier expectationVerifier)

Creates new instance of HttpAsyncServerProtocolHandler.

参数:

httpProcessor - HTTP protocol processor.

connStrategy - Connection re-use strategy. If null DefaultConnectionReuseStrategy.INSTANCE will be used.

responseFactory - HTTP response factory. If null DefaultHttpResponseFactory.INSTANCE will be used.

handlerMapper - Request handler mapper.

expectationVerifier - Request expectation verifier. May be null.

从以下版本开始:

4.3

HttpAsyncService

public HttpAsyncService(HttpProcessor httpProcessor,
                HttpAsyncRequestHandlerMapper handlerMapper)

Creates new instance of HttpAsyncServerProtocolHandler.

参数:

httpProcessor - HTTP protocol processor.

handlerMapper - Request handler mapper.

从以下版本开始:

4.3

方法详细资料

connected

public void connected(NHttpServerConnection conn)

从接口复制的说明: NHttpServerEventHandler

Triggered when a new incoming connection is created.

指定者:

connected 在接口中 NHttpServerEventHandler

参数:

conn - new incoming connection HTTP connection.

closed

public void closed(NHttpServerConnection conn)

从接口复制的说明: NHttpServerEventHandler

Triggered when the connection is closed.

指定者:

closed 在接口中 NHttpServerEventHandler

参数:

conn - closed HTTP connection.

exception

public void exception(NHttpServerConnection conn,
             java.lang.Exception cause)

从接口复制的说明: NHttpServerEventHandler

Triggered if an error occurs during the HTTP exchange.

指定者:

exception 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that caused an I/O error

cause - exception

requestReceived

public void requestReceived(NHttpServerConnection conn)
                     throws java.io.IOException,
                            HttpException

从接口复制的说明: NHttpServerEventHandler

Triggered when a new HTTP request is received. The connection passed as a parameter to this method is guaranteed to return a valid HTTP request object.

If the request received encloses a request entity this method will be followed a series of NHttpServerEventHandler.inputReady(NHttpServerConnection, ContentDecoder) calls to transfer the request content.

指定者:

requestReceived 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that contains a new HTTP request

抛出:

java.io.IOException

HttpException

另请参阅:

NHttpServerConnection

inputReady

public void inputReady(NHttpServerConnection conn,
              ContentDecoder decoder)
                throws java.io.IOException,
                       HttpException

从接口复制的说明: NHttpServerEventHandler

Triggered when the underlying channel is ready for reading a new portion of the request entity through the corresponding content decoder.

If the content consumer is unable to process incoming content, input event notifications can be temporarily suspended using IOControl interface (super interface of NHttpServerConnection).

Please note that the NHttpServerConnection and ContentDecoder objects are not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on extension thread to resume input event notifications when the handler is capable of processing more content.

指定者:

inputReady 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that can produce a new portion of the incoming request content.

decoder - The content decoder to use to read content.

抛出:

java.io.IOException

HttpException

另请参阅:

NHttpServerConnection, ContentDecoder, IOControl

responseReady

public void responseReady(NHttpServerConnection conn)
                   throws java.io.IOException,
                          HttpException

从接口复制的说明: NHttpServerEventHandler

Triggered when the connection is ready to accept a new HTTP response. The protocol handler does not have to submit a response if it is not ready.

指定者:

responseReady 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that contains an HTTP response

抛出:

java.io.IOException

HttpException

另请参阅:

NHttpServerConnection

outputReady

public void outputReady(NHttpServerConnection conn,
               ContentEncoder encoder)
                 throws java.io.IOException

从接口复制的说明: NHttpServerEventHandler

Triggered when the underlying channel is ready for writing a next portion of the response entity through the corresponding content encoder.

If the content producer is unable to generate outgoing content, output event notifications can be temporarily suspended using IOControl interface (super interface of NHttpServerConnection).

Please note that the NHttpServerConnection and ContentEncoder objects are not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on extension thread to resume output event notifications when more content is made available.

指定者:

outputReady 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that can accommodate a new portion of the outgoing response content.

encoder - The content encoder to use to write content.

抛出:

java.io.IOException

另请参阅:

NHttpServerConnection, ContentEncoder, IOControl

endOfInput

public void endOfInput(NHttpServerConnection conn)
                throws java.io.IOException

从接口复制的说明: NHttpServerEventHandler

Triggered when the connection is closed by the opposite end point (half-closed).

指定者:

endOfInput 在接口中 NHttpServerEventHandler

参数:

conn - half-closed HTTP connection.

抛出:

java.io.IOException

timeout

public void timeout(NHttpServerConnection conn)
             throws java.io.IOException

从接口复制的说明: NHttpServerEventHandler

Triggered when no input is detected on this connection over the maximum period of inactivity.

指定者:

timeout 在接口中 NHttpServerEventHandler

参数:

conn - HTTP connection that caused timeout condition.

抛出:

java.io.IOException

log

protected void log(java.lang.Exception ex)

This method can be used to log I/O exception thrown while closing Closeable objects (such as HttpConnection).

参数:

ex - I/O exception thrown by Closeable.close()

handleException

protected HttpAsyncResponseProducer handleException(java.lang.Exception ex,
                                        HttpContext context)