depends.org.apache.http.nio.protocol

类 BasicAsyncResponseProducer

java.lang.Object

depends.org.apache.http.nio.protocol.BasicAsyncResponseProducer

所有已实现的接口:

HttpAsyncResponseProducer, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
public class BasicAsyncResponseProducer
extends java.lang.Object
implements HttpAsyncResponseProducer

Basic implementation of HttpAsyncResponseProducer. The producer can make use of the HttpAsyncContentProducer interface to efficiently stream out message content to the underlying non-blocking HTTP connection, if it is implemented by the HttpEntity inclosed in the response.

从以下版本开始:

4.2

另请参阅:

HttpAsyncContentProducer

构造器概要

构造器

限定符	构造器和说明
	BasicAsyncResponseProducer(HttpResponse response) Creates a producer that can be used to transmit the given response message.
protected	BasicAsyncResponseProducer(HttpResponse response, HttpAsyncContentProducer producer) Creates a producer that can be used to transmit the given response message.

方法概要

方法

限定符和类型	方法和说明
void	close()
void	failed(java.lang.Exception ex) Invoked to signal that the response processing terminated abnormally.
HttpResponse	generateResponse() Invoked to generate a HTTP response message head.
void	produceContent(ContentEncoder encoder, IOControl ioctrl) Invoked to write out a chunk of content to the ContentEncoder.
void	responseCompleted(HttpContext context) Invoked to signal that the response has been fully written out.

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

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

构造器详细资料

BasicAsyncResponseProducer

protected BasicAsyncResponseProducer(HttpResponse response,
                          HttpAsyncContentProducer producer)

Creates a producer that can be used to transmit the given response message. The given content producer will be used to stream out message content. Please note that the response message is expected to enclose an HttpEntity whose properties are consistent with the behavior of the content producer.

参数:

response - response message.

producer - response content producer.

BasicAsyncResponseProducer

public BasicAsyncResponseProducer(HttpResponse response)

Creates a producer that can be used to transmit the given response message. If the response message encloses an HttpEntity it is also expected to implement HttpAsyncContentProducer.

参数:

response - response message.

方法详细资料

generateResponse

public HttpResponse generateResponse()

从接口复制的说明: HttpAsyncResponseProducer

Invoked to generate a HTTP response message head.

指定者:

generateResponse 在接口中 HttpAsyncResponseProducer

返回:

HTTP response message.

produceContent

public void produceContent(ContentEncoder encoder,
                  IOControl ioctrl)
                    throws java.io.IOException

从接口复制的说明: HttpAsyncResponseProducer

Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the producer is temporarily unable to produce more content.

When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

Please note that the ContentEncoder object is 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.

指定者:

produceContent 在接口中 HttpAsyncResponseProducer

参数:

encoder - content encoder.

ioctrl - I/O control of the underlying connection.

抛出:

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

responseCompleted

public void responseCompleted(HttpContext context)

从接口复制的说明: HttpAsyncResponseProducer

Invoked to signal that the response has been fully written out.

指定者:

responseCompleted 在接口中 HttpAsyncResponseProducer

参数:

context - HTTP context

failed

public void failed(java.lang.Exception ex)

从接口复制的说明: HttpAsyncResponseProducer

Invoked to signal that the response processing terminated abnormally.

指定者:

failed 在接口中 HttpAsyncResponseProducer

参数:

ex - exception

close

public void close()
           throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException