depends.org.apache.http.nio.protocol

类 AbstractAsyncRequestConsumer<T>

java.lang.Object

depends.org.apache.http.nio.protocol.AbstractAsyncRequestConsumer<T>

所有已实现的接口:

HttpAsyncRequestConsumer<T>, java.io.Closeable, java.lang.AutoCloseable

直接已知子类:

BasicAsyncRequestConsumer

@ThreadSafe
public abstract class AbstractAsyncRequestConsumer<T>
extends java.lang.Object
implements HttpAsyncRequestConsumer<T>

Abstract HttpAsyncRequestConsumer implementation that relieves its subclasses form having to synchronize access to internal instance variables and provides a number of protected methods that they need to implement.

从以下版本开始:

4.2

构造器概要

构造器

构造器和说明
AbstractAsyncRequestConsumer()

方法概要

方法

限定符和类型	方法和说明
protected abstract T	buildResult(HttpContext context) Invoked to generate a result object from the received HTTP request message.
void	close()
void	consumeContent(ContentDecoder decoder, IOControl ioctrl) Use onContentReceived(ContentDecoder, IOControl) instead.
void	failed(java.lang.Exception ex) Invoked to signal that the request processing terminated abnormally.
java.lang.Exception	getException() Returns an exception in case of an abnormal termination.
T	getResult() Returns a result of the request execution, when available.
boolean	isDone() Determines whether or not the request execution completed.
protected void	onClose() Invoked when the consumer is being closed.
protected abstract void	onContentReceived(ContentDecoder decoder, IOControl ioctrl) Invoked to process a chunk of content from the ContentDecoder.
protected abstract void	onEntityEnclosed(HttpEntity entity, ContentType contentType) Invoked if the request message encloses a content entity.
protected abstract void	onRequestReceived(HttpRequest request) Invoked when a HTTP request message is received.
protected abstract void	releaseResources() Invoked to release all system resources currently tlb.
void	requestCompleted(HttpContext context) Use buildResult(HttpContext) instead.
void	requestReceived(HttpRequest request) Use onRequestReceived(HttpRequest) instead.

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

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

构造器详细资料

AbstractAsyncRequestConsumer

public AbstractAsyncRequestConsumer()

方法详细资料

onRequestReceived

protected abstract void onRequestReceived(HttpRequest request)
                                   throws HttpException,
                                          java.io.IOException

Invoked when a HTTP request message is received. Please note that the onContentReceived(ContentDecoder, IOControl) method will be invoked only for if the request message implements HttpEntityEnclosingRequest interface and has a content entity enclosed.

参数:

request - HTTP request message.

抛出:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

onEntityEnclosed

protected abstract void onEntityEnclosed(HttpEntity entity,
                    ContentType contentType)
                                  throws java.io.IOException

Invoked if the request message encloses a content entity.

参数:

entity - HTTP entity

contentType - expected content category.

抛出:

java.io.IOException - in case of an I/O error

onContentReceived

protected abstract void onContentReceived(ContentDecoder decoder,
                     IOControl ioctrl)
                                   throws java.io.IOException

Invoked to process a chunk of content from the ContentDecoder. The IOControl interface can be used to suspend input events if the consumer is temporarily unable to consume more content.

The consumer can use the ContentDecoder.isCompleted() method to find out whether or not the message content has been fully consumed.

参数:

decoder - content decoder.

ioctrl - I/O control of the underlying connection.

抛出:

java.io.IOException - in case of an I/O error

buildResult

protected abstract T buildResult(HttpContext context)
                          throws java.lang.Exception

Invoked to generate a result object from the received HTTP request message.

参数:

context - HTTP context.

返回:

result of the request processing.

抛出:

java.lang.Exception - in case of an abnormal termination.

releaseResources

protected abstract void releaseResources()

Invoked to release all system resources currently tlb.

onClose

protected void onClose()
                throws java.io.IOException

Invoked when the consumer is being closed.

抛出:

java.io.IOException - may be thrown by subclassses

从以下版本开始:

4.3

requestReceived

public final void requestReceived(HttpRequest request)
                           throws HttpException,
                                  java.io.IOException

Use onRequestReceived(HttpRequest) instead.

指定者:

requestReceived 在接口中 HttpAsyncRequestConsumer<T>

参数:

request - HTTP request message.

抛出:

HttpException - in case of HTTP protocol violation

java.io.IOException - in case of an I/O error

consumeContent

public final void consumeContent(ContentDecoder decoder,
                  IOControl ioctrl)
                          throws java.io.IOException

Use onContentReceived(ContentDecoder, IOControl) instead.

指定者:

consumeContent 在接口中 HttpAsyncRequestConsumer<T>

参数:

decoder - content decoder.

ioctrl - I/O control of the underlying connection.

抛出:

java.io.IOException - in case of an I/O error

requestCompleted

public final void requestCompleted(HttpContext context)

Use buildResult(HttpContext) instead.

指定者:

requestCompleted 在接口中 HttpAsyncRequestConsumer<T>

参数:

context - HTTP context

failed

public final void failed(java.lang.Exception ex)

从接口复制的说明: HttpAsyncRequestConsumer

Invoked to signal that the request processing terminated abnormally.

指定者:

failed 在接口中 HttpAsyncRequestConsumer<T>

参数:

ex - exception

close

public final void close()
                 throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException

getException

public java.lang.Exception getException()

从接口复制的说明: HttpAsyncRequestConsumer

Returns an exception in case of an abnormal termination. This method returns null if the request execution is still ongoing or if it completed successfully.

指定者:

getException 在接口中 HttpAsyncRequestConsumer<T>

另请参阅:

HttpAsyncRequestConsumer.isDone()

getResult

public T getResult()

从接口复制的说明: HttpAsyncRequestConsumer

Returns a result of the request execution, when available. This method returns null if the request execution is still ongoing.

指定者:

getResult 在接口中 HttpAsyncRequestConsumer<T>

另请参阅:

HttpAsyncRequestConsumer.isDone()

isDone

public boolean isDone()

从接口复制的说明: HttpAsyncRequestConsumer

Determines whether or not the request execution completed. If the request processing terminated normally HttpAsyncRequestConsumer.getResult() can be used to obtain the result. If the request processing terminated abnormally HttpAsyncRequestConsumer.getException() can be used to obtain the cause.

指定者:

isDone 在接口中 HttpAsyncRequestConsumer<T>