View Javadoc
1   /*
2    * Copyright 2013 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.ProgressivePromise;
21  
22  /**
23   * Special {@link ChannelPromise} which will be notified once the associated bytes is transferring.
24   */
25  public interface ChannelProgressivePromise extends ProgressivePromise<Void>, ChannelProgressiveFuture, ChannelPromise {
26  
27      @Override
28      ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super Void>> listener);
29  
30      @Override
31      ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
32  
33      @Override
34      ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener);
35  
36      @Override
37      ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
38  
39      @Override
40      ChannelProgressivePromise sync() throws InterruptedException;
41  
42      @Override
43      ChannelProgressivePromise syncUninterruptibly();
44  
45      @Override
46      ChannelProgressivePromise await() throws InterruptedException;
47  
48      @Override
49      ChannelProgressivePromise awaitUninterruptibly();
50  
51      @Override
52      ChannelProgressivePromise setSuccess(Void result);
53  
54      @Override
55      ChannelProgressivePromise setSuccess();
56  
57      @Override
58      ChannelProgressivePromise setFailure(Throwable cause);
59  
60      @Override
61      ChannelProgressivePromise setProgress(long progress, long total);
62  }