org.apache.http.nio.protocol
Interface HttpAsyncResponseConsumer<T>

Type Parameters:
T - the result type of response processing.
All Superinterfaces:
Cancellable, Closeable
All Known Subinterfaces:
HttpAsyncRequestExecutionHandler<T>
All Known Implementing Classes:
AbstractAsyncResponseConsumer, BasicAsyncRequestExecutionHandler, BasicAsyncResponseConsumer

public interface HttpAsyncResponseConsumer<T>
extends Closeable, Cancellable

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.

Since:
4.2

Method Summary
 void consumeContent(ContentDecoder decoder, IOControl ioctrl)
          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

responseReceived

void responseReceived(HttpResponse response)
                      throws IOException,
                             HttpException
Invoked when a HTTP response message is received. Please note that the consumeContent(ContentDecoder, IOControl) method will be invoked only if the response messages has a content entity enclosed.

Parameters:
response - HTTP response message.
Throws:
HttpException - in case of HTTP protocol violation
IOException - in case of an I/O error

consumeContent

void consumeContent(ContentDecoder decoder,
                    IOControl ioctrl)
                    throws IOException
Invoked to process a chunk of content from the 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.

Parameters:
decoder - content decoder.
ioctrl - I/O control of the underlying connection.
Throws:
IOException - in case of an I/O error

responseCompleted

void responseCompleted(HttpContext context)
Invoked to signal that the response has been fully processed.

Parameters:
context - HTTP context

failed

void failed(Exception ex)
Invoked to signal that the response processing terminated abnormally.

Parameters:
ex - exception

getException

Exception getException()
Returns an exception in case of an abnormal termination. This method returns null if the response processing is still ongoing or if it completed successfully.

See Also:
isDone()

getResult

T getResult()
Returns a result of the response processing, when available. This method returns null if the response processing is still ongoing.

See Also:
isDone()

isDone

boolean isDone()
Determines whether or not the response processing completed. If the response processing terminated normally getResult() can be used to obtain the result. If the response processing terminated abnormally getException() can be used to obtain the cause.



Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.