Package io.netty.channel

Interface ChannelPromise

All Superinterfaces:

ChannelFuture, io.netty.util.concurrent.Future<Void>, Future<Void>, io.netty.util.concurrent.Promise<Void>

All Known Subinterfaces:

ChannelProgressivePromise

All Known Implementing Classes:

DefaultChannelProgressivePromise, DefaultChannelPromise, DelegatingChannelPromiseNotifier, VoidChannelPromise

public interface ChannelPromise
extends ChannelFuture, io.netty.util.concurrent.Promise<Void>

Special ChannelFuture which is writable.

Method Summary

Modifier and Type	Method	Description
ChannelPromise	addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
ChannelPromise	addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
ChannelPromise	await()
ChannelPromise	awaitUninterruptibly()
Channel	channel()	Returns a channel where the I/O operation associated with this future takes place.
ChannelPromise	removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
ChannelPromise	removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
ChannelPromise	setFailure(Throwable cause)
ChannelPromise	setSuccess()
ChannelPromise	setSuccess(Void result)
ChannelPromise	sync()
ChannelPromise	syncUninterruptibly()
boolean	trySuccess()
ChannelPromise	unvoid()	Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.

Methods inherited from interface io.netty.channel.ChannelFuture

isVoid

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.Promise

setUncancellable, tryFailure, trySuccess

Method Detail

channel

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

setSuccess

ChannelPromise setSuccess(Void result)

Specified by:

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

setSuccess

ChannelPromise setSuccess()

trySuccess

boolean trySuccess()

setFailure

ChannelPromise setFailure(Throwable cause)

Specified by:

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

addListener

ChannelPromise 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 io.netty.util.concurrent.Future<Void>

Specified by:

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

addListeners

ChannelPromise 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 io.netty.util.concurrent.Future<Void>

Specified by:

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

removeListener

ChannelPromise 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 io.netty.util.concurrent.Future<Void>

Specified by:

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

removeListeners

ChannelPromise 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 io.netty.util.concurrent.Future<Void>

Specified by:

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

sync

ChannelPromise sync()
             throws InterruptedException

Specified by:

sync in interface ChannelFuture

Specified by:

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

Specified by:

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

Throws:

InterruptedException

syncUninterruptibly

ChannelPromise syncUninterruptibly()

Specified by:

syncUninterruptibly in interface ChannelFuture

Specified by:

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

Specified by:

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

await

ChannelPromise await()
              throws InterruptedException

Specified by:

await in interface ChannelFuture

Specified by:

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

Specified by:

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

Throws:

InterruptedException

awaitUninterruptibly

ChannelPromise awaitUninterruptibly()

Specified by:

awaitUninterruptibly in interface ChannelFuture

Specified by:

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

Specified by:

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

unvoid

ChannelPromise unvoid()

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