Package io.netty.channel

Class DefaultChannelProgressivePromise

java.lang.Object

io.netty.util.concurrent.AbstractFuture<V>

io.netty.util.concurrent.DefaultPromise<V>

io.netty.util.concurrent.DefaultProgressivePromise<Void>

io.netty.channel.DefaultChannelProgressivePromise

All Implemented Interfaces:

ChannelFuture, ChannelProgressiveFuture, ChannelProgressivePromise, ChannelPromise, io.netty.util.concurrent.Future<Void>, io.netty.util.concurrent.ProgressiveFuture<Void>, io.netty.util.concurrent.ProgressivePromise<Void>, io.netty.util.concurrent.Promise<Void>, Future<Void>

public class DefaultChannelProgressivePromise
extends io.netty.util.concurrent.DefaultProgressivePromise<Void>
implements ChannelProgressivePromise

The default ChannelProgressivePromise implementation. It is recommended to use Channel.newProgressivePromise() to create a new ChannelProgressivePromise rather than calling the constructor explicitly.

Field Summary

Fields inherited from class io.netty.util.concurrent.DefaultPromise

PROPERTY_MAX_LISTENER_STACK_DEPTH

Constructor Summary

Constructors

Constructor	Description
DefaultChannelProgressivePromise(Channel channel)	Creates a new instance.
DefaultChannelProgressivePromise(Channel channel, io.netty.util.concurrent.EventExecutor executor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ChannelProgressivePromise	addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
ChannelProgressivePromise	addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
ChannelProgressivePromise	await()
ChannelProgressivePromise	awaitUninterruptibly()
Channel	channel()	Returns a channel where the I/O operation associated with this future takes place.
protected void	checkDeadLock()
protected io.netty.util.concurrent.EventExecutor	executor()
long	flushCheckpoint()
void	flushCheckpoint(long checkpoint)
boolean	isVoid()	Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods: ChannelFuture.addListener(GenericFutureListener) ChannelFuture.addListeners(GenericFutureListener[]) ChannelFuture.await() Future.await(long, TimeUnit) ()} Future.await(long) ()} ChannelFuture.awaitUninterruptibly() ChannelFuture.sync() ChannelFuture.syncUninterruptibly()
ChannelProgressivePromise	promise()
ChannelProgressivePromise	removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
ChannelProgressivePromise	removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
ChannelProgressivePromise	setFailure(Throwable cause)
ChannelProgressivePromise	setProgress(long progress, long total)
ChannelProgressivePromise	setSuccess()
ChannelProgressivePromise	setSuccess(Void result)
ChannelProgressivePromise	sync()
ChannelProgressivePromise	syncUninterruptibly()
boolean	trySuccess()
ChannelProgressivePromise	unvoid()	Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.

Methods inherited from class io.netty.util.concurrent.DefaultProgressivePromise

tryProgress

Methods inherited from class io.netty.util.concurrent.DefaultPromise

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder, tryFailure, trySuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.concurrent.Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future

get, get, isCancelled, isDone

Methods inherited from interface io.netty.util.concurrent.ProgressivePromise

tryProgress

Methods inherited from interface io.netty.util.concurrent.Promise

setUncancellable, tryFailure, trySuccess

Constructor Detail

DefaultChannelProgressivePromise

public DefaultChannelProgressivePromise(Channel channel)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

DefaultChannelProgressivePromise

public DefaultChannelProgressivePromise(Channel channel,
                                        io.netty.util.concurrent.EventExecutor executor)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

Method Detail

executor

protected io.netty.util.concurrent.EventExecutor executor()

Overrides:

executor in class io.netty.util.concurrent.DefaultPromise<Void>

channel

public Channel channel()

Description copied from interface: ChannelFuture

Returns a channel where the I/O operation associated with this future takes place.

Specified by:

channel in interface ChannelFuture

Specified by:

channel in interface ChannelPromise

setSuccess

public ChannelProgressivePromise setSuccess()

Specified by:

setSuccess in interface ChannelProgressivePromise

Specified by:

setSuccess in interface ChannelPromise

setSuccess

public ChannelProgressivePromise setSuccess(Void result)

Specified by:

setSuccess in interface ChannelProgressivePromise

Specified by:

setSuccess in interface ChannelPromise

Specified by:

setSuccess in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

setSuccess in interface io.netty.util.concurrent.Promise<Void>

Overrides:

setSuccess in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

trySuccess

public boolean trySuccess()

Specified by:

trySuccess in interface ChannelPromise

setFailure

public ChannelProgressivePromise setFailure(Throwable cause)

Specified by:

setFailure in interface ChannelProgressivePromise

Specified by:

setFailure in interface ChannelPromise

Specified by:

setFailure in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

setFailure in interface io.netty.util.concurrent.Promise<Void>

Overrides:

setFailure in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

setProgress

public ChannelProgressivePromise setProgress(long progress,
                                             long total)

Specified by:

setProgress in interface ChannelProgressivePromise

Specified by:

setProgress in interface io.netty.util.concurrent.ProgressivePromise<Void>

Overrides:

setProgress in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

addListener

public ChannelProgressivePromise addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)

Specified by:

addListener in interface ChannelFuture

Specified by:

addListener in interface ChannelProgressiveFuture

Specified by:

addListener in interface ChannelProgressivePromise

Specified by:

addListener in interface ChannelPromise

Specified by:

addListener in interface io.netty.util.concurrent.Future<Void>

Specified by:

addListener in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

addListener in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

addListener in interface io.netty.util.concurrent.Promise<Void>

Overrides:

addListener in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

addListeners

public ChannelProgressivePromise addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)

Specified by:

addListeners in interface ChannelFuture

Specified by:

addListeners in interface ChannelProgressiveFuture

Specified by:

addListeners in interface ChannelProgressivePromise

Specified by:

addListeners in interface ChannelPromise

Specified by:

addListeners in interface io.netty.util.concurrent.Future<Void>

Specified by:

addListeners in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

addListeners in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

addListeners in interface io.netty.util.concurrent.Promise<Void>

Overrides:

addListeners in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

removeListener

public ChannelProgressivePromise removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)

Specified by:

removeListener in interface ChannelFuture

Specified by:

removeListener in interface ChannelProgressiveFuture

Specified by:

removeListener in interface ChannelProgressivePromise

Specified by:

removeListener in interface ChannelPromise

Specified by:

removeListener in interface io.netty.util.concurrent.Future<Void>

Specified by:

removeListener in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

removeListener in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

removeListener in interface io.netty.util.concurrent.Promise<Void>

Overrides:

removeListener in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

removeListeners

public ChannelProgressivePromise removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)

Specified by:

removeListeners in interface ChannelFuture

Specified by:

removeListeners in interface ChannelProgressiveFuture

Specified by:

removeListeners in interface ChannelProgressivePromise

Specified by:

removeListeners in interface ChannelPromise

Specified by:

removeListeners in interface io.netty.util.concurrent.Future<Void>

Specified by:

removeListeners in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

removeListeners in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

removeListeners in interface io.netty.util.concurrent.Promise<Void>

Overrides:

removeListeners in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

sync

public ChannelProgressivePromise sync()
                               throws InterruptedException

Specified by:

sync in interface ChannelFuture

Specified by:

sync in interface ChannelProgressiveFuture

Specified by:

sync in interface ChannelProgressivePromise

Specified by:

sync in interface ChannelPromise

Specified by:

sync in interface io.netty.util.concurrent.Future<Void>

Specified by:

sync in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

sync in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

sync in interface io.netty.util.concurrent.Promise<Void>

Overrides:

sync in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

Throws:

InterruptedException

syncUninterruptibly

public ChannelProgressivePromise syncUninterruptibly()

Specified by:

syncUninterruptibly in interface ChannelFuture

Specified by:

syncUninterruptibly in interface ChannelProgressiveFuture

Specified by:

syncUninterruptibly in interface ChannelProgressivePromise

Specified by:

syncUninterruptibly in interface ChannelPromise

Specified by:

syncUninterruptibly in interface io.netty.util.concurrent.Future<Void>

Specified by:

syncUninterruptibly in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

syncUninterruptibly in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

syncUninterruptibly in interface io.netty.util.concurrent.Promise<Void>

Overrides:

syncUninterruptibly in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

await

public ChannelProgressivePromise await()
                                throws InterruptedException

Specified by:

await in interface ChannelFuture

Specified by:

await in interface ChannelProgressiveFuture

Specified by:

await in interface ChannelProgressivePromise

Specified by:

await in interface ChannelPromise

Specified by:

await in interface io.netty.util.concurrent.Future<Void>

Specified by:

await in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

await in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

await in interface io.netty.util.concurrent.Promise<Void>

Overrides:

await in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

Throws:

InterruptedException

awaitUninterruptibly

public ChannelProgressivePromise awaitUninterruptibly()

Specified by:

awaitUninterruptibly in interface ChannelFuture

Specified by:

awaitUninterruptibly in interface ChannelProgressiveFuture

Specified by:

awaitUninterruptibly in interface ChannelProgressivePromise

Specified by:

awaitUninterruptibly in interface ChannelPromise

Specified by:

awaitUninterruptibly in interface io.netty.util.concurrent.Future<Void>

Specified by:

awaitUninterruptibly in interface io.netty.util.concurrent.ProgressiveFuture<Void>

Specified by:

awaitUninterruptibly in interface io.netty.util.concurrent.ProgressivePromise<Void>

Specified by:

awaitUninterruptibly in interface io.netty.util.concurrent.Promise<Void>

Overrides:

awaitUninterruptibly in class io.netty.util.concurrent.DefaultProgressivePromise<Void>

flushCheckpoint

public long flushCheckpoint()

flushCheckpoint

public void flushCheckpoint(long checkpoint)

promise

public ChannelProgressivePromise promise()

checkDeadLock

protected void checkDeadLock()

Overrides:

checkDeadLock in class io.netty.util.concurrent.DefaultPromise<Void>

unvoid

public ChannelProgressivePromise unvoid()

Description copied from interface: ChannelPromise

Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.

Specified by:

unvoid in interface ChannelProgressivePromise

Specified by:

unvoid in interface ChannelPromise

isVoid

public boolean isVoid()

Description copied from interface: ChannelFuture

Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods:

• ChannelFuture.addListener(GenericFutureListener)
• ChannelFuture.addListeners(GenericFutureListener[])
• ChannelFuture.await()
• Future.await(long, TimeUnit) ()}
• Future.await(long) ()}
• ChannelFuture.awaitUninterruptibly()
• ChannelFuture.sync()
• ChannelFuture.syncUninterruptibly()

Specified by:

isVoid in interface ChannelFuture