|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- the result type of response processing.public interface HttpAsyncResponseConsumer<T>
HttpAsyncResponseConsumer
is a callback interface whose methods
get invoked to process an HTTP response message and to stream message
content from a non-blocking HTTP connection on the client side.
Method Summary | |
---|---|
void |
consumeContent(ContentDecoder decoder,
IOControl ioControl)
Invoked to process a chunk of content from the ContentDecoder . |
void |
failed(Exception ex)
Invoked to signal that the response processing terminated abnormally. |
Exception |
getException()
Returns an exception in case of an abnormal termination. |
T |
getResult()
Returns a result of the response processing, when available. |
boolean |
isDone()
Determines whether or not the response processing completed. |
void |
responseCompleted(HttpContext context)
Invoked to signal that the response has been fully processed. |
void |
responseReceived(HttpResponse response)
Invoked when a HTTP response message is received. |
Methods inherited from interface java.io.Closeable |
---|
close |
Methods inherited from interface org.apache.http.concurrent.Cancellable |
---|
cancel |
Method Detail |
---|
void responseReceived(HttpResponse response) throws IOException, HttpException
consumeContent(ContentDecoder, IOControl)
method
will be invoked only if the response messages has a content entity
enclosed.
response
- HTTP response message.
HttpException
- in case of HTTP protocol violation
IOException
- in case of an I/O errorvoid consumeContent(ContentDecoder decoder, IOControl ioControl) throws IOException
ContentDecoder
.
The IOControl
interface can be used to suspend input event
notifications if the consumer is temporarily unable to process content.
The consumer can use the ContentDecoder.isCompleted()
method
to find out whether or not the message content has been fully consumed.
Please note that the ContentDecoder
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 input event notifications when the consumer is capable of
processing more content.
decoder
- content decoder.ioControl
- 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
- exceptionException getException()
null
if the response processing is still ongoing
or if it completed successfully.
isDone()
T getResult()
null
if the response processing is still ongoing.
isDone()
boolean isDone()
getResult()
can be used to obtain the result. If the response processing terminated
abnormally getException()
can be used to obtain the cause.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |