org.asynchttpclient.netty

Class NettyResponseFuture<V>

java.lang.Object

org.asynchttpclient.netty.NettyResponseFuture<V>

Type Parameters:

V - the result type

All Implemented Interfaces:

Future<V>, ListenableFuture<V>

public final class NettyResponseFuture<V>
extends Object
implements ListenableFuture<V>

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.asynchttpclient.ListenableFuture

ListenableFuture.CompletedFailure<T>

Field Summary

Fields

Modifier and Type	Field and Description
Throwable	pendingException

Constructor Summary

Constructors

Constructor and Description
NettyResponseFuture(Request originalRequest, AsyncHandler<V> asyncHandler, NettyRequest nettyRequest, int maxRetry, ChannelPoolPartitioning connectionPoolPartitioning, ConnectionSemaphore connectionSemaphore, ProxyServer proxyServer)

Method Summary

Modifier and Type	Method and Description
void	abort(Throwable t) Abort the current processing, and propagate the Throwable to the AsyncHandler or Future
void	acquirePartitionLockLazily()
ListenableFuture<V>	addListener(Runnable listener, Executor exec) Adds a listener and executor to the ListenableFuture.
void	attachChannel(io.netty.channel.Channel channel, boolean reuseChannel)
boolean	cancel(boolean force)
void	cancelTimeouts()
io.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)
AsyncHandler<V>	getAsyncHandler()
ChannelState	getChannelState()
ChannelPoolPartitioning	getConnectionPoolPartitioning()
Request	getCurrentRequest()
long	getLastTouch()
NettyRequest	getNettyRequest()
Object	getPartitionKey()
Realm	getProxyRealm()
ProxyServer	getProxyServer()
Realm	getRealm()
long	getStart()
Request	getTargetRequest()
TimeoutsHolder	getTimeoutsHolder()
Uri	getUri()
int	incrementAndGetCurrentRedirectCount()
boolean	incrementRetryAndCheck()
boolean	isAndSetInAuth(boolean set)
boolean	isAndSetInProxyAuth(boolean inProxyAuth)
boolean	isCancelled()
boolean	isConnectAllowed()
boolean	isDone()
boolean	isDontWriteBodyBecauseExpectContinue()
boolean	isHeadersAlreadyWrittenOnContinue()
boolean	isInAuth()
boolean	isInProxyAuth()
boolean	isKeepAlive()
boolean	isReplayPossible() Return true if the Future can be recovered.
boolean	isReuseChannel()
boolean	isStreamConsumed()
void	setAsyncHandler(AsyncHandler<V> asyncHandler)
void	setChannelState(ChannelState channelState)
void	setConnectAllowed(boolean allowConnect)
void	setCurrentRequest(Request currentRequest)
void	setDontWriteBodyBecauseExpectContinue(boolean dontWriteBodyBecauseExpectContinue)
void	setHeadersAlreadyWrittenOnContinue(boolean headersAlreadyWrittenOnContinue)
void	setInAuth(boolean inAuth)
void	setInProxyAuth(boolean inProxyAuth)
void	setKeepAlive(boolean keepAlive)
void	setNettyRequest(NettyRequest nettyRequest)
void	setProxyRealm(Realm proxyRealm)
void	setRealm(Realm realm)
void	setReuseChannel(boolean reuseChannel)
void	setStreamConsumed(boolean streamConsumed)
void	setTargetRequest(Request targetRequest)
void	setTimeoutsHolder(TimeoutsHolder timeoutsHolder)
Object	takePartitionKeyLock()
CompletableFuture<V>	toCompletableFuture()
String	toString()
void	touch() Touch the current instance to prevent external service to times out.

Methods inherited from class java.lang.Object

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

Field Detail

pendingException

public Throwable pendingException

Constructor Detail

NettyResponseFuture

public NettyResponseFuture(Request originalRequest,
                           AsyncHandler<V> asyncHandler,
                           NettyRequest nettyRequest,
                           int maxRetry,
                           ChannelPoolPartitioning connectionPoolPartitioning,
                           ConnectionSemaphore connectionSemaphore,
                           ProxyServer proxyServer)

Method Detail

takePartitionKeyLock

public Object takePartitionKeyLock()

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

cancel

public boolean cancel(boolean force)

Specified by:

cancel in interface Future<V>

get

public V get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<V>

Throws:

InterruptedException

ExecutionException

get

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

Specified by:

get in interface Future<V>

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.

Specified by:

done in interface ListenableFuture<V>

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

Specified by:

abort in interface ListenableFuture<V>

Parameters:

t - the exception

touch

public void touch()

Description copied from interface: ListenableFuture

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

Specified by:

touch in interface ListenableFuture<V>

addListener

public ListenableFuture<V> addListener(Runnable listener,
                                       Executor exec)

Description copied from interface: ListenableFuture

Adds a listener and executor to the ListenableFuture. The listener will be passed to the executor for execution when the Future's computation is complete.
Executor can be null, in that case executor will be executed in the thread where completion happens.
There is no guaranteed ordering of execution of listeners, they may get called in the order they were added and they may get called out of order, but any listener added through this method is guaranteed to be called once the computation is complete.

Specified by:

addListener in interface ListenableFuture<V>

Parameters:

listener - the listener to run when the computation is complete.

exec - the executor to run the listener in.

Returns:

this Future

toCompletableFuture

public CompletableFuture<V> toCompletableFuture()

Specified by:

toCompletableFuture in interface ListenableFuture<V>

getUri

public Uri getUri()

getConnectionPoolPartitioning

public ChannelPoolPartitioning getConnectionPoolPartitioning()

getProxyServer

public ProxyServer getProxyServer()

setAsyncHandler

public void setAsyncHandler(AsyncHandler<V> asyncHandler)

cancelTimeouts

public void cancelTimeouts()

getTargetRequest

public final Request getTargetRequest()

getCurrentRequest

public final Request getCurrentRequest()

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)

incrementAndGetCurrentRedirectCount

public int incrementAndGetCurrentRedirectCount()

setTimeoutsHolder

public void setTimeoutsHolder(TimeoutsHolder timeoutsHolder)

getTimeoutsHolder

public TimeoutsHolder getTimeoutsHolder()

isInAuth

public boolean isInAuth()

setInAuth

public void setInAuth(boolean inAuth)

isAndSetInAuth

public boolean isAndSetInAuth(boolean set)

isInProxyAuth

public boolean isInProxyAuth()

setInProxyAuth

public void setInProxyAuth(boolean inProxyAuth)

isAndSetInProxyAuth

public boolean isAndSetInProxyAuth(boolean inProxyAuth)

getChannelState

public ChannelState getChannelState()

setChannelState

public void setChannelState(ChannelState channelState)

isStreamConsumed

public boolean isStreamConsumed()

setStreamConsumed

public void setStreamConsumed(boolean streamConsumed)

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(io.netty.channel.Channel channel,
                          boolean reuseChannel)

channel

public io.netty.channel.Channel channel()

isReuseChannel

public boolean isReuseChannel()

incrementRetryAndCheck

public boolean incrementRetryAndCheck()

setTargetRequest

public void setTargetRequest(Request targetRequest)

setCurrentRequest

public void setCurrentRequest(Request currentRequest)

isReplayPossible

public boolean isReplayPossible()

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()

getPartitionKey

public Object getPartitionKey()

acquirePartitionLockLazily

public void acquirePartitionLockLazily()
                                throws IOException

Throws:

IOException

getRealm

public Realm getRealm()

setRealm

public void setRealm(Realm realm)

getProxyRealm

public Realm getProxyRealm()

setProxyRealm

public void setProxyRealm(Realm proxyRealm)

toString

public String toString()

Overrides:

toString in class Object