org.eclipse.jetty.client.util

Class TimedResponseListener

java.lang.Object

org.eclipse.jetty.client.util.TimedResponseListener

All Implemented Interfaces:

Runnable, EventListener, Response.BeginListener, Response.CompleteListener, Response.ContentListener, Response.FailureListener, Response.HeadersListener, Response.Listener, Response.ResponseListener, Response.SuccessListener, Schedulable

public class TimedResponseListener
extends Object
implements Response.Listener, Schedulable, Runnable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Response.Listener

Response.Listener.Empty

Constructor Summary

Constructors

Constructor and Description
TimedResponseListener(long timeout, TimeUnit unit, Request request)
TimedResponseListener(long timeout, TimeUnit unit, Request request, Response.CompleteListener delegate)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel()
void	onBegin(Response response) Callback method invoked when the response line containing HTTP version, HTTP status code and reason has been received and parsed.
void	onComplete(Result result) Callback method invoked when the request and the response have been processed, either successfully or not.
void	onContent(Response response, ByteBuffer content) Callback method invoked when the response content has been received.
void	onFailure(Response response, Throwable failure) Callback method invoked when the response has failed in the process of being received
void	onHeaders(Response response) Callback method invoked when the response headers have been received and parsed.
void	onSuccess(Response response) Callback method invoked when the whole response has been successfully received.
void	run()
boolean	schedule(Scheduler scheduler)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedResponseListener

public TimedResponseListener(long timeout,
                     TimeUnit unit,
                     Request request)

TimedResponseListener

public TimedResponseListener(long timeout,
                     TimeUnit unit,
                     Request request,
                     Response.CompleteListener delegate)

Method Detail

onBegin

public void onBegin(Response response)

Description copied from interface: Response.BeginListener

Callback method invoked when the response line containing HTTP version, HTTP status code and reason has been received and parsed.

This method is the best approximation to detect when the first bytes of the response arrived to the client.

Specified by:

onBegin in interface Response.BeginListener

Parameters:

response - the response containing the response line data

onHeaders

public void onHeaders(Response response)

Description copied from interface: Response.HeadersListener

Callback method invoked when the response headers have been received and parsed.

Specified by:

onHeaders in interface Response.HeadersListener

Parameters:

response - the response containing the response line data and the headers

onContent

public void onContent(Response response,
             ByteBuffer content)

Description copied from interface: Response.ContentListener

Callback method invoked when the response content has been received. This method may be invoked multiple times, and the content buffer must be consumed before returning from this method.

Specified by:

onContent in interface Response.ContentListener

Parameters:

response - the response containing the response line data and the headers

content - the content bytes received

onSuccess

public void onSuccess(Response response)

Description copied from interface: Response.SuccessListener

Callback method invoked when the whole response has been successfully received.

Specified by:

onSuccess in interface Response.SuccessListener

Parameters:

response - the response containing the response line data and the headers

onFailure

public void onFailure(Response response,
             Throwable failure)

Description copied from interface: Response.FailureListener

Callback method invoked when the response has failed in the process of being received

Specified by:

onFailure in interface Response.FailureListener

Parameters:

response - the response containing data up to the point the failure happened

failure - the failure happened

onComplete

public void onComplete(Result result)

Description copied from interface: Response.CompleteListener

Callback method invoked when the request and the response have been processed, either successfully or not.

The result parameter contains the request, the response, and eventual failures.

Requests may complete after response, for example in case of big uploads that are discarded or read asynchronously by the server. This method is always invoked after Response.SuccessListener.onSuccess(Response) or Response.FailureListener.onFailure(Response, Throwable), and only when request indicates that it is completed.

Specified by:

onComplete in interface Response.CompleteListener

Parameters:

result - the result of the request / response exchange

schedule

public boolean schedule(Scheduler scheduler)

Specified by:

schedule in interface Schedulable

run

public void run()

Specified by:

run in interface Runnable

cancel

public boolean cancel()

Specified by:

cancel in interface Schedulable