public class BasicAsyncRequestProducer extends Object implements HttpAsyncRequestProducer
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
.HttpAsyncContentProducer
Constructor and Description |
---|
BasicAsyncRequestProducer(HttpHost target,
HttpRequest request)
Creates a producer that can be used to transmit the given request
message.
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
void |
failed(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.
|
String |
toString() |
public BasicAsyncRequestProducer(HttpHost target, HttpRequest request)
HttpEntity
it is also expected to implement HttpAsyncContentProducer
.target
- target host.request
- request message.public HttpRequest generateRequest()
HttpAsyncRequestProducer
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
in interface HttpAsyncRequestProducer
public HttpHost getTarget()
HttpAsyncRequestProducer
getTarget
in interface HttpAsyncRequestProducer
public void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException
HttpAsyncRequestProducer
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 other thread
to resume output event notifications when more content is made available.
produceContent
in interface HttpAsyncRequestProducer
encoder
- content encoder.ioctrl
- I/O control of the underlying connection.IOException
- in case of an I/O errorpublic void requestCompleted(HttpContext context)
HttpAsyncRequestProducer
requestCompleted
in interface HttpAsyncRequestProducer
context
- HTTP contextpublic void failed(Exception ex)
HttpAsyncRequestProducer
failed
in interface HttpAsyncRequestProducer
ex
- exceptionpublic boolean isRepeatable()
HttpAsyncRequestProducer
isRepeatable
in interface HttpAsyncRequestProducer
public void resetRequest() throws IOException
HttpAsyncRequestProducer
resetRequest
in interface HttpAsyncRequestProducer
IOException
- in case of an I/O errorpublic void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved