com.ning.http.client.providers.netty.future

Class NettyResponseFuture<V>

java.lang.Object

com.ning.http.client.listenable.AbstractListenableFuture<V>

com.ning.http.client.providers.netty.future.NettyResponseFuture<V>

Type Parameters:

V -

All Implemented Interfaces:

ListenableFuture<V>, Future<V>

public final class NettyResponseFuture<V>
extends AbstractListenableFuture<V>

A Future that can be used to track when an asynchronous HTTP request has been fully processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyResponseFuture.STATE

Constructor Summary

Constructors

Constructor and Description
NettyResponseFuture(Uri uri, Request request, AsyncHandler<V> asyncHandler, NettyRequest nettyRequest, int maxRetry, ConnectionPoolPartitioning connectionPoolPartitioning, ProxyServer proxyServer)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(Throwable t) Abort the current processing, and propagate the Throwable to the AsyncHandler or Future
void	attachChannel(org.jboss.netty.channel.Channel channel, boolean reuseChannel)
boolean	canBeReplayed() Return true if the Future can be recovered.
boolean	cancel(boolean force)
void	cancelTimeouts()
boolean	canRetry()
org.jboss.netty.channel.Channel	channel()
void	done() Terminate and if there is no exception, mark this Future as done and release the internal lock.
V	get()
V	get(long l, TimeUnit tu)
boolean	getAndSetAuth(boolean inDigestAuth)
boolean	getAndSetStatusReceived(boolean sr)
AsyncHandler<V>	getAsyncHandler()
SocketAddress	getChannelRemoteAddress()
ConnectionPoolPartitioning	getConnectionPoolPartitioning()
org.jboss.netty.handler.codec.http.HttpHeaders	getHttpHeaders()
long	getLastTouch()
NettyRequest	getNettyRequest()
ProxyServer	getProxyServer()
Request	getRequest()
long	getStart()
NettyResponseFuture.STATE	getState()
Uri	getUri()
boolean	hasExpired() Is the Future still valid
int	incrementAndGetCurrentRedirectCount()
boolean	isCancelled()
boolean	isConnectAllowed()
boolean	isDone()
boolean	isDontWriteBodyBecauseExpectContinue()
boolean	isHeadersAlreadyWrittenOnContinue()
boolean	isIdleConnectionTimeoutReached()
boolean	isInAuth()
boolean	isKeepAlive()
boolean	isRequestTimeoutReached()
boolean	isStreamWasAlreadyConsumed()
boolean	reuseChannel()
void	setAsyncHandler(AsyncHandler<V> asyncHandler)
void	setConnectAllowed(boolean allowConnect)
void	setDontWriteBodyBecauseExpectContinue(boolean dontWriteBodyBecauseExpectContinue)
void	setHeadersAlreadyWrittenOnContinue(boolean headersAlreadyWrittenOnContinue)
void	setHttpHeaders(org.jboss.netty.handler.codec.http.HttpHeaders httpHeaders)
void	setIdleConnectionTimeoutReached()
void	setKeepAlive(boolean keepAlive)
void	setNettyRequest(NettyRequest nettyRequest)
void	setRequest(Request request)
void	setRequestTimeoutReached()
void	setReuseChannel(boolean reuseChannel)
void	setState(NettyResponseFuture.STATE state)
void	setStreamWasAlreadyConsumed(boolean streamWasAlreadyConsumed)
void	setTimeoutsHolder(TimeoutsHolder timeoutsHolder)
void	setUri(Uri uri)
String	toString()
void	touch() Touch the current instance to prevent external service to times out.

Methods inherited from class com.ning.http.client.listenable.AbstractListenableFuture

addListener, runListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyResponseFuture

public NettyResponseFuture(Uri uri,
                   Request request,
                   AsyncHandler<V> asyncHandler,
                   NettyRequest nettyRequest,
                   int maxRetry,
                   ConnectionPoolPartitioning connectionPoolPartitioning,
                   ProxyServer proxyServer)

Method Detail

isDone

public boolean isDone()

isCancelled

public boolean isCancelled()

cancel

public boolean cancel(boolean force)

get

public V get()
      throws InterruptedException,
             ExecutionException

Throws:

InterruptedException

ExecutionException

get

public V get(long l,
    TimeUnit tu)
      throws InterruptedException,
             TimeoutException,
             ExecutionException

Throws:

InterruptedException

TimeoutException

ExecutionException

done

public final void done()

Description copied from interface: ListenableFuture

Terminate and if there is no exception, mark this Future as done and release the internal lock.

abort

public final void abort(Throwable t)

Description copied from interface: ListenableFuture

Abort the current processing, and propagate the Throwable to the AsyncHandler or Future

touch

public void touch()

Description copied from interface: ListenableFuture

Touch the current instance to prevent external service to times out.

getUri

public Uri getUri()

setUri

public void setUri(Uri uri)

getConnectionPoolPartitioning

public ConnectionPoolPartitioning getConnectionPoolPartitioning()

getProxyServer

public ProxyServer getProxyServer()

setAsyncHandler

public void setAsyncHandler(AsyncHandler<V> asyncHandler)

hasExpired

public boolean hasExpired()

Is the Future still valid

Returns:

true if response has expired and should be terminated.

setRequestTimeoutReached

public void setRequestTimeoutReached()

isRequestTimeoutReached

public boolean isRequestTimeoutReached()

setIdleConnectionTimeoutReached

public void setIdleConnectionTimeoutReached()

isIdleConnectionTimeoutReached

public boolean isIdleConnectionTimeoutReached()

cancelTimeouts

public void cancelTimeouts()

getRequest

public final Request getRequest()

getNettyRequest

public final NettyRequest getNettyRequest()

setNettyRequest

public final void setNettyRequest(NettyRequest nettyRequest)

getAsyncHandler

public final AsyncHandler<V> getAsyncHandler()

isKeepAlive

public final boolean isKeepAlive()

setKeepAlive

public final void setKeepAlive(boolean keepAlive)

getHttpHeaders

public final org.jboss.netty.handler.codec.http.HttpHeaders getHttpHeaders()

setHttpHeaders

public final void setHttpHeaders(org.jboss.netty.handler.codec.http.HttpHeaders httpHeaders)

incrementAndGetCurrentRedirectCount

public int incrementAndGetCurrentRedirectCount()

setTimeoutsHolder

public void setTimeoutsHolder(TimeoutsHolder timeoutsHolder)

isInAuth

public boolean isInAuth()

getAndSetAuth

public boolean getAndSetAuth(boolean inDigestAuth)

getState

public NettyResponseFuture.STATE getState()

setState

public void setState(NettyResponseFuture.STATE state)

getAndSetStatusReceived

public boolean getAndSetStatusReceived(boolean sr)

isStreamWasAlreadyConsumed

public boolean isStreamWasAlreadyConsumed()

setStreamWasAlreadyConsumed

public void setStreamWasAlreadyConsumed(boolean streamWasAlreadyConsumed)

getLastTouch

public long getLastTouch()

setHeadersAlreadyWrittenOnContinue

public void setHeadersAlreadyWrittenOnContinue(boolean headersAlreadyWrittenOnContinue)

isHeadersAlreadyWrittenOnContinue

public boolean isHeadersAlreadyWrittenOnContinue()

setDontWriteBodyBecauseExpectContinue

public void setDontWriteBodyBecauseExpectContinue(boolean dontWriteBodyBecauseExpectContinue)

isDontWriteBodyBecauseExpectContinue

public boolean isDontWriteBodyBecauseExpectContinue()

setReuseChannel

public void setReuseChannel(boolean reuseChannel)

isConnectAllowed

public boolean isConnectAllowed()

setConnectAllowed

public void setConnectAllowed(boolean allowConnect)

attachChannel

public void attachChannel(org.jboss.netty.channel.Channel channel,
                 boolean reuseChannel)

channel

public org.jboss.netty.channel.Channel channel()

reuseChannel

public boolean reuseChannel()

canRetry

public boolean canRetry()

getChannelRemoteAddress

public SocketAddress getChannelRemoteAddress()

setRequest

public void setRequest(Request request)

canBeReplayed

public boolean canBeReplayed()

Return true if the Future can be recovered. There is some scenario where a connection can be closed by an unexpected IOException, and in some situation we can recover from that exception.

Returns:

true if that Future cannot be recovered.

getStart

public long getStart()

toString

public String toString()

Overrides:

toString in class Object