VoidChannelPromise (Netty/Transport 4.1.118.Final API)

java.lang.Object
- io.netty.util.concurrent.AbstractFuture<Void>
- - io.netty.channel.VoidChannelPromise

All Implemented Interfaces:: ChannelFuture, ChannelPromise, io.netty.util.concurrent.Promise<Void>, Future<Void>

@UnstableApi
public final class VoidChannelPromise
extends io.netty.util.concurrent.AbstractFuture<Void>
implements ChannelPromise

Constructor Summary

Constructors
Constructor and Description

VoidChannelPromise(Channel channel, boolean fireException)
Creates a new instance.

Constructors
Constructor and Description
`VoidChannelPromise(Channel channel, boolean fireException)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoidChannelPromise`	`addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)`
`VoidChannelPromise`	`addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)`
`VoidChannelPromise`	`await()`
`boolean`	`await(long timeoutMillis)`
`boolean`	`await(long timeout, TimeUnit unit)`
`VoidChannelPromise`	`awaitUninterruptibly()`
`boolean`	`awaitUninterruptibly(long timeoutMillis)`
`boolean`	`awaitUninterruptibly(long timeout, TimeUnit unit)`
`boolean`	`cancel(boolean mayInterruptIfRunning)`
`Throwable`	`cause()`
`Channel`	`channel()` Returns a channel where the I/O operation associated with this future takes place.
`Void`	`getNow()`
`boolean`	`isCancellable()`
`boolean`	`isCancelled()`
`boolean`	`isDone()`
`boolean`	`isSuccess()`
`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()`
`VoidChannelPromise`	`removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)`
`VoidChannelPromise`	`removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)`
`VoidChannelPromise`	`setFailure(Throwable cause)`
`VoidChannelPromise`	`setSuccess()`
`VoidChannelPromise`	`setSuccess(Void result)`
`boolean`	`setUncancellable()`
`VoidChannelPromise`	`sync()`
`VoidChannelPromise`	`syncUninterruptibly()`
`boolean`	`tryFailure(Throwable cause)`
`boolean`	`trySuccess()`
`boolean`	`trySuccess(Void result)`
`ChannelPromise`	`unvoid()` Returns a new `ChannelPromise` if `ChannelFuture.isVoid()` returns `true` otherwise itself.

Methods inherited from class io.netty.util.concurrent.AbstractFuture
get, get

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.concurrent.Future
get, get

- Constructor Detail
  - VoidChannelPromise
```
public VoidChannelPromise(Channel channel,
                          boolean fireException)
```
    Creates a new instance.
    
    Parameters:
    
    channel - the Channel associated with this future
- Method Detail
  - addListener
```
public VoidChannelPromise 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 ChannelPromise
    
    Specified by:
    
    addListener in interface io.netty.util.concurrent.Promise<Void>
  - addListeners
```
public VoidChannelPromise 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 ChannelPromise
    
    Specified by:
    
    addListeners in interface io.netty.util.concurrent.Promise<Void>
  - removeListener
```
public VoidChannelPromise 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 ChannelPromise
    
    Specified by:
    
    removeListener in interface io.netty.util.concurrent.Promise<Void>
  - removeListeners
```
public VoidChannelPromise 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 ChannelPromise
    
    Specified by:
    
    removeListeners in interface io.netty.util.concurrent.Promise<Void>
  - await
```
public VoidChannelPromise await()
                         throws InterruptedException
```
    Specified by:
    
    await in interface ChannelFuture
    
    Specified by:
    
    await in interface ChannelPromise
    
    Specified by:
    
    await in interface io.netty.util.concurrent.Promise<Void>
    
    Throws:
    
    InterruptedException
  - await
```
public boolean await(long timeout,
                     TimeUnit unit)
```
  - await
```
public boolean await(long timeoutMillis)
```
  - awaitUninterruptibly
```
public VoidChannelPromise awaitUninterruptibly()
```
    Specified by:
    
    awaitUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    awaitUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    awaitUninterruptibly in interface io.netty.util.concurrent.Promise<Void>
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeout,
                                    TimeUnit unit)
```
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeoutMillis)
```
  - 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
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface Future<Void>
  - isSuccess
```
public boolean isSuccess()
```
  - setUncancellable
```
public boolean setUncancellable()
```
    Specified by:
    
    setUncancellable in interface io.netty.util.concurrent.Promise<Void>
  - isCancellable
```
public boolean isCancellable()
```
  - isCancelled
```
public boolean isCancelled()
```
    Specified by:
    
    isCancelled in interface Future<Void>
  - cause
```
public Throwable cause()
```
  - sync
```
public VoidChannelPromise sync()
```
    Specified by:
    
    sync in interface ChannelFuture
    
    Specified by:
    
    sync in interface ChannelPromise
    
    Specified by:
    
    sync in interface io.netty.util.concurrent.Promise<Void>
  - syncUninterruptibly
```
public VoidChannelPromise syncUninterruptibly()
```
    Specified by:
    
    syncUninterruptibly in interface ChannelFuture
    
    Specified by:
    
    syncUninterruptibly in interface ChannelPromise
    
    Specified by:
    
    syncUninterruptibly in interface io.netty.util.concurrent.Promise<Void>
  - setFailure
```
public VoidChannelPromise setFailure(Throwable cause)
```
    Specified by:
    
    setFailure in interface ChannelPromise
    
    Specified by:
    
    setFailure in interface io.netty.util.concurrent.Promise<Void>
  - setSuccess
```
public VoidChannelPromise setSuccess()
```
    Specified by:
    
    setSuccess in interface ChannelPromise
  - tryFailure
```
public boolean tryFailure(Throwable cause)
```
    Specified by:
    
    tryFailure in interface io.netty.util.concurrent.Promise<Void>
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    Specified by:
    
    cancel in interface Future<Void>
    
    Parameters:
    
    mayInterruptIfRunning - this value has no effect in this implementation.
  - trySuccess
```
public boolean trySuccess()
```
    Specified by:
    
    trySuccess in interface ChannelPromise
  - setSuccess
```
public VoidChannelPromise setSuccess(Void result)
```
    Specified by:
    
    setSuccess in interface ChannelPromise
    
    Specified by:
    
    setSuccess in interface io.netty.util.concurrent.Promise<Void>
  - trySuccess
```
public boolean trySuccess(Void result)
```
    Specified by:
    
    trySuccess in interface io.netty.util.concurrent.Promise<Void>
  - getNow
```
public Void getNow()
```
  - unvoid
```
public ChannelPromise unvoid()
```
    Description copied from interface: ChannelPromise
    
    Returns a new ChannelPromise if ChannelFuture.isVoid() returns true otherwise itself.
    
    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

Class VoidChannelPromise

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.Future

Constructor Detail

VoidChannelPromise

Method Detail

addListener

addListeners

removeListener

removeListeners

await

await

await

awaitUninterruptibly

awaitUninterruptibly

awaitUninterruptibly

channel

isDone

isSuccess

setUncancellable

isCancellable

isCancelled

cause

sync

syncUninterruptibly

setFailure

setSuccess

tryFailure

cancel

trySuccess

setSuccess

trySuccess

getNow

unvoid

isVoid