netty Architecture Docs
Home / Type/ ChannelFuture Type — netty Architecture

ChannelFuture Type — netty Architecture

Architecture documentation for the ChannelFuture type/interface in ChannelFuture.java from the netty codebase.

Type java

Entity Profile

Dependency Diagram

graph TD
  b70bd81a_f4e4_76ff_30fb_02207d105831["ChannelFuture"]
  9131d9a8_335e_3caa_4587_e90c7c581b4e["ChannelFuture.java"]
  b70bd81a_f4e4_76ff_30fb_02207d105831 -->|defined in| 9131d9a8_335e_3caa_4587_e90c7c581b4e
  style b70bd81a_f4e4_76ff_30fb_02207d105831 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

transport/src/main/java/io/netty/channel/ChannelFuture.java lines 165–212

public interface ChannelFuture extends Future<Void> {

    /**
     * Returns a channel where the I/O operation associated with this
     * future takes place.
     */
    Channel channel();

    @Override
    ChannelFuture addListener(GenericFutureListener<? extends Future<? super Void>> listener);

    @Override
    ChannelFuture addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);

    @Override
    ChannelFuture removeListener(GenericFutureListener<? extends Future<? super Void>> listener);

    @Override
    ChannelFuture removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);

    @Override
    ChannelFuture sync() throws InterruptedException;

    @Override
    ChannelFuture syncUninterruptibly();

    @Override
    ChannelFuture await() throws InterruptedException;

    @Override
    ChannelFuture awaitUninterruptibly();

    /**
     * Returns {@code true} if this {@link ChannelFuture} is a void future and so not allow to call any of the
     * following methods:
     * <ul>
     *     <li>{@link #addListener(GenericFutureListener)}</li>
     *     <li>{@link #addListeners(GenericFutureListener[])}</li>
     *     <li>{@link #await()}</li>
     *     <li>{@link #await(long, TimeUnit)} ()}</li>
     *     <li>{@link #await(long)} ()}</li>
     *     <li>{@link #awaitUninterruptibly()}</li>
     *     <li>{@link #sync()}</li>
     *     <li>{@link #syncUninterruptibly()}</li>
     * </ul>
     */
    boolean isVoid();
}

Defined In

Source

Frequently Asked Questions

What is the ChannelFuture type?
ChannelFuture is a type/interface in the netty codebase, defined in transport/src/main/java/io/netty/channel/ChannelFuture.java.
Where is ChannelFuture defined?
ChannelFuture is defined in transport/src/main/java/io/netty/channel/ChannelFuture.java at line 165.

Analyze Your Own Codebase

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

Try Supermodel Free