public interface HttpAsyncResponseProducer extends Closeable
HttpAsyncResponseProducer
is a callback interface whose methods
get invoked to generate an HTTP response message and to stream message
content to a non-blocking HTTP connection on the server side.Modifier and Type | Method and Description |
---|---|
void |
failed(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.
|
HttpResponse generateResponse()
void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException
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.
encoder
- content encoder.ioctrl
- I/O control of the underlying connection.IOException
- in case of an I/O errorvoid responseCompleted(HttpContext context)
context
- HTTP contextvoid failed(Exception ex)
ex
- exceptionCopyright © 2010 - 2020 Adobe. All Rights Reserved