depends.org.apache.http.nio.protocol

类 BasicAsyncRequestProducer

java.lang.Object

depends.org.apache.http.nio.protocol.BasicAsyncRequestProducer

所有已实现的接口:

HttpAsyncRequestProducer, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
public class BasicAsyncRequestProducer
extends java.lang.Object
implements HttpAsyncRequestProducer

Basic implementation of HttpAsyncRequestProducer. 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 enclosed HttpEntity.

从以下版本开始:

4.2

另请参阅:

HttpAsyncContentProducer

构造器概要

构造器

限定符	构造器和说明
protected	BasicAsyncRequestProducer(HttpHost target, HttpEntityEnclosingRequest request, HttpAsyncContentProducer producer) Creates a producer that can be used to transmit the given request message.
	BasicAsyncRequestProducer(HttpHost target, HttpRequest request) Creates a producer that can be used to transmit the given request message.

方法概要

方法

限定符和类型	方法和说明
void	close()
void	failed(java.lang.Exception ex) Invoked to signal that the response processing terminated abnormally.
HttpRequest	generateRequest() Invoked to generate a HTTP request message head.
HttpHost	getTarget() Invoked to obtain the request target host.
boolean	isRepeatable() Determines whether or not this producer is capable of producing HTTP request messages more than once.
void	produceContent(ContentEncoder encoder, IOControl ioctrl) Invoked to write out a chunk of content to the ContentEncoder.
void	requestCompleted(HttpContext context) Invoked to signal that the request has been fully written out.
void	resetRequest() Invoked to reset the producer to its initial state.

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

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

构造器详细资料

BasicAsyncRequestProducer

protected BasicAsyncRequestProducer(HttpHost target,
                         HttpEntityEnclosingRequest request,
                         HttpAsyncContentProducer producer)

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

参数:

target - target host.

request - request message.

producer - request content producer.

BasicAsyncRequestProducer

public BasicAsyncRequestProducer(HttpHost target,
                         HttpRequest request)

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

参数:

target - target host.

request - request message.

方法详细资料

generateRequest

public HttpRequest generateRequest()

从接口复制的说明: HttpAsyncRequestProducer

Invoked to generate a HTTP request message head. The message is expected to implement the HttpEntityEnclosingRequest interface if it is to enclose a content entity. The HttpAsyncRequestProducer.produceContent( ContentEncoder, IOControl) method will not be invoked if HttpEntityEnclosingRequest.getEntity() returns null.

指定者:

generateRequest 在接口中 HttpAsyncRequestProducer

返回:

HTTP request message.

getTarget

public HttpHost getTarget()

从接口复制的说明: HttpAsyncRequestProducer

Invoked to obtain the request target host.

指定者:

getTarget 在接口中 HttpAsyncRequestProducer

produceContent

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

从接口复制的说明: HttpAsyncRequestProducer

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 在接口中 HttpAsyncRequestProducer

参数:

encoder - content encoder.

ioctrl - I/O control of the underlying connection.

抛出:

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

requestCompleted

public void requestCompleted(HttpContext context)

从接口复制的说明: HttpAsyncRequestProducer

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

指定者:

requestCompleted 在接口中 HttpAsyncRequestProducer

参数:

context - HTTP context

failed

public void failed(java.lang.Exception ex)

从接口复制的说明: HttpAsyncRequestProducer

Invoked to signal that the response processing terminated abnormally.

指定者:

failed 在接口中 HttpAsyncRequestProducer

参数:

ex - exception

isRepeatable

public boolean isRepeatable()

从接口复制的说明: HttpAsyncRequestProducer

Determines whether or not this producer is capable of producing HTTP request messages more than once.

指定者:

isRepeatable 在接口中 HttpAsyncRequestProducer

resetRequest

public void resetRequest()
                  throws java.io.IOException

从接口复制的说明: HttpAsyncRequestProducer

Invoked to reset the producer to its initial state. Repeatable request producers are expected to release currently tlb resources that are no longer needed or re-acquire resources needed to repeat the process.

指定者:

resetRequest 在接口中 HttpAsyncRequestProducer

抛出:

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

close

public void close()
           throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException