org.asynchttpclient.netty

Class NettyResponseFuture<V>

java.lang.Object

org.asynchttpclient.future.AbstractListenableFuture<V>

org.asynchttpclient.netty.NettyResponseFuture<V>

Type Parameters:

V - the result type

All Implemented Interfaces:

Future<V>, ListenableFuture<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/interfaces inherited from interface org.asynchttpclient.ListenableFuture

ListenableFuture.CompletedFailure<T>

Constructor Summary

Constructors

Constructor and Description
NettyResponseFuture(Request originalRequest, AsyncHandler<V> asyncHandler, NettyRequest nettyRequest, int maxRetry, ChannelPoolPartitioning connectionPoolPartitioning, 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	attachChannel(io.netty.channel.Channel channel, boolean reuseChannel)
boolean	canBeReplayed() Return true if the Future can be recovered.
boolean	cancel(boolean force)
void	cancelTimeouts()
boolean	canRetry()
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)
boolean	getAndSetStatusReceived(boolean sr)
AsyncHandler<V>	getAsyncHandler()
SocketAddress	getChannelRemoteAddress()
ChannelState	getChannelState()
ChannelPoolPartitioning	getConnectionPoolPartitioning()
Request	getCurrentRequest()
AtomicBoolean	getInAuth()
AtomicBoolean	getInProxyAuth()
long	getLastTouch()
NettyRequest	getNettyRequest()
Object	getPartitionKey()
Realm	getProxyRealm()
ProxyServer	getProxyServer()
Realm	getRealm()
long	getStart()
Request	getTargetRequest()
Uri	getUri()
int	incrementAndGetCurrentRedirectCount()
boolean	isCancelled()
boolean	isConnectAllowed()
boolean	isDone()
boolean	isDontWriteBodyBecauseExpectContinue()
boolean	isHeadersAlreadyWrittenOnContinue()
boolean	isKeepAlive()
boolean	isStreamWasAlreadyConsumed()
boolean	reuseChannel()
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	setKeepAlive(boolean keepAlive)
void	setNettyRequest(NettyRequest nettyRequest)
void	setProxyRealm(Realm proxyRealm)
void	setRealm(Realm realm)
void	setReuseChannel(boolean reuseChannel)
void	setStreamWasAlreadyConsumed(boolean streamWasAlreadyConsumed)
void	setTargetRequest(Request targetRequest)
void	setTimeoutsHolder(TimeoutsHolder timeoutsHolder)
CompletableFuture<V>	toCompletableFuture()
String	toString()
void	touch() Touch the current instance to prevent external service to times out.

Methods inherited from class org.asynchttpclient.future.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(Request originalRequest,
                           AsyncHandler<V> asyncHandler,
                           NettyRequest nettyRequest,
                           int maxRetry,
                           ChannelPoolPartitioning 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

Parameters:

t - the exception

touch

public void touch()

Description copied from interface: ListenableFuture

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

toCompletableFuture

public CompletableFuture<V> toCompletableFuture()

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)

getInAuth

public AtomicBoolean getInAuth()

getInProxyAuth

public AtomicBoolean getInProxyAuth()

getChannelState

public ChannelState getChannelState()

setChannelState

public void setChannelState(ChannelState channelState)

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

channel

public io.netty.channel.Channel channel()

reuseChannel

public boolean reuseChannel()

canRetry

public boolean canRetry()

getChannelRemoteAddress

public SocketAddress getChannelRemoteAddress()

setTargetRequest

public void setTargetRequest(Request targetRequest)

setCurrentRequest

public void setCurrentRequest(Request currentRequest)

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

getPartitionKey

public Object getPartitionKey()

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