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.EventExecutorGroup;
19  
20  /**
21   * Special {@link EventExecutorGroup} which allows registering {@link Channel}s that get
22   * processed for later selection during the event loop.
23   *
24   */
25  public interface EventLoopGroup extends EventExecutorGroup {
26      /**
27       * Return the next {@link EventLoop} to use
28       */
29      @Override
30      EventLoop next();
31  
32      /**
33       * Register a {@link Channel} with this {@link EventLoop}. The returned {@link ChannelFuture}
34       * will get notified once the registration was complete.
35       */
36      ChannelFuture register(Channel channel);
37  
38      /**
39       * Register a {@link Channel} with this {@link EventLoop} using a {@link ChannelFuture}. The passed
40       * {@link ChannelFuture} will get notified once the registration was complete and also will get returned.
41       */
42      ChannelFuture register(ChannelPromise promise);
43  
44      /**
45       * Register a {@link Channel} with this {@link EventLoop}. The passed {@link ChannelFuture}
46       * will get notified once the registration was complete and also will get returned.
47       *
48       * @deprecated Use {@link #register(ChannelPromise)} instead.
49       */
50      @Deprecated
51      ChannelFuture register(Channel channel, ChannelPromise promise);
52  }