View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.channel;
17  
18  import io.netty.util.concurrent.Future;
19  import io.netty.util.concurrent.GenericFutureListener;
20  import io.netty.util.concurrent.Promise;
21  
22  /**
23   * Special {@link ChannelFuture} which is writable.
24   */
25  public interface ChannelPromise extends ChannelFuture, Promise<Void> {
26  
27      @Override
28      Channel channel();
29  
30      @Override
31      ChannelPromise setSuccess(Void result);
32  
33      ChannelPromise setSuccess();
34  
35      boolean trySuccess();
36  
37      @Override
38      ChannelPromise setFailure(Throwable cause);
39  
40      @Override
41      ChannelPromise addListener(GenericFutureListener<? extends Future<? super Void>> listener);
42  
43      @Override
44      ChannelPromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
45  
46      @Override
47      ChannelPromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener);
48  
49      @Override
50      ChannelPromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
51  
52      @Override
53      ChannelPromise sync() throws InterruptedException;
54  
55      @Override
56      ChannelPromise syncUninterruptibly();
57  
58      @Override
59      ChannelPromise await() throws InterruptedException;
60  
61      @Override
62      ChannelPromise awaitUninterruptibly();
63  
64      /**
65       * Returns a new {@link ChannelPromise} if {@link #isVoid()} returns {@code true} otherwise itself.
66       */
67      ChannelPromise unvoid();
68  }