Home / Class/ VoidChannelPromise Class — netty Architecture

VoidChannelPromise Class — netty Architecture

Architecture documentation for the VoidChannelPromise class in VoidChannelPromise.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5["VoidChannelPromise"]
  45d74881_7286_00de_f364_842564066d8f["VoidChannelPromise.java"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|defined in| 45d74881_7286_00de_f364_842564066d8f
  7f46c778_a65f_b4ac_ccff_beb25a17d3dd["VoidChannelPromise()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 7f46c778_a65f_b4ac_ccff_beb25a17d3dd
  cb3ccf50_59c7_8a88_68f3_0fab573a50ae["await()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| cb3ccf50_59c7_8a88_68f3_0fab573a50ae
  76fc71a7_f03d_010e_1743_2465f33c3dce["awaitUninterruptibly()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 76fc71a7_f03d_010e_1743_2465f33c3dce
  4725cd8a_7aa1_3e15_7d69_b9e01801f6e3["Channel()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 4725cd8a_7aa1_3e15_7d69_b9e01801f6e3
  9f238114_9874_7124_a665_d5126f09128e["isDone()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 9f238114_9874_7124_a665_d5126f09128e
  4b012d14_9325_334b_19bd_642d0dd160fc["isSuccess()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 4b012d14_9325_334b_19bd_642d0dd160fc
  5152d65e_1c89_5199_e761_774bfc8dc4be["setUncancellable()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 5152d65e_1c89_5199_e761_774bfc8dc4be
  1ffcdeae_2924_4ef0_908f_1850a9acb6f7["isCancellable()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 1ffcdeae_2924_4ef0_908f_1850a9acb6f7
  b01968d4_47b7_8326_7c3e_5385f2b71952["isCancelled()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| b01968d4_47b7_8326_7c3e_5385f2b71952
  123ff361_e67f_29b3_14a4_f3cbd3ea3a79["Throwable()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 123ff361_e67f_29b3_14a4_f3cbd3ea3a79
  5b40c32e_0a17_0539_8dbd_b677e10463a3["tryFailure()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 5b40c32e_0a17_0539_8dbd_b677e10463a3
  73cea576_f886_c8f5_77f2_b6fae421e3a4["cancel()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 73cea576_f886_c8f5_77f2_b6fae421e3a4
  28b416c7_a112_234c_2d7c_538facabc814["trySuccess()"]
  44e86ceb_e692_7fc6_cdba_7e250d0f3ad5 -->|method| 28b416c7_a112_234c_2d7c_538facabc814

Relationship Graph

Source Code

transport/src/main/java/io/netty/channel/VoidChannelPromise.java lines 26–239

@UnstableApi
public final class VoidChannelPromise extends AbstractFuture<Void> implements ChannelPromise {

    private final Channel channel;
    // Will be null if we should not propagate exceptions through the pipeline on failure case.
    private final ChannelFutureListener fireExceptionListener;

    /**
     * Creates a new instance.
     *
     * @param channel the {@link Channel} associated with this future
     */
    public VoidChannelPromise(final Channel channel, boolean fireException) {
        ObjectUtil.checkNotNull(channel, "channel");
        this.channel = channel;
        if (fireException) {
            fireExceptionListener = new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    Throwable cause = future.cause();
                    if (cause != null) {
                        fireException0(cause);
                    }
                }
            };
        } else {
            fireExceptionListener = null;
        }
    }

    @Override
    public VoidChannelPromise addListener(GenericFutureListener<? extends Future<? super Void>> listener) {
        fail();
        return this;
    }

    @Override
    public VoidChannelPromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) {
        fail();
        return this;
    }

    @Override
    public VoidChannelPromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener) {
        // NOOP
        return this;
    }

    @Override
    public VoidChannelPromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) {
        // NOOP
        return this;
    }

    @Override
    public VoidChannelPromise await() throws InterruptedException {
        if (Thread.interrupted()) {
            throw new InterruptedException();
        }
        return this;
    }

    @Override
    public boolean await(long timeout, TimeUnit unit) {
        fail();
        return false;
    }

    @Override
    public boolean await(long timeoutMillis) {
        fail();
        return false;
    }

    @Override
    public VoidChannelPromise awaitUninterruptibly() {
        fail();
        return this;
    }

    @Override

Frequently Asked Questions

What is the VoidChannelPromise class?
VoidChannelPromise is a class in the netty codebase, defined in transport/src/main/java/io/netty/channel/VoidChannelPromise.java.
Where is VoidChannelPromise defined?
VoidChannelPromise is defined in transport/src/main/java/io/netty/channel/VoidChannelPromise.java at line 26.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free