a5006c1969
Motivation: EventLoopGroup.register doesn't need the Channel paramter when ChannelPromise is provided as we can get the Channel from ChannelPromise. Resolves #2422. Modifications: - Add EventLoopGroup.register(ChannelPromise) - Deprecate EventLoopGroup.register(Channel, ChannelPromise) Result: EventLoopGroup.register is more convenient as people only need to set one parameter.
53 lines
1.9 KiB
Java
53 lines
1.9 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.channel;
|
|
|
|
import io.netty.util.concurrent.EventExecutorGroup;
|
|
|
|
/**
|
|
* Special {@link EventExecutorGroup} which allows registering {@link Channel}s that get
|
|
* processed for later selection during the event loop.
|
|
*
|
|
*/
|
|
public interface EventLoopGroup extends EventExecutorGroup {
|
|
/**
|
|
* Return the next {@link EventLoop} to use
|
|
*/
|
|
@Override
|
|
EventLoop next();
|
|
|
|
/**
|
|
* Register a {@link Channel} with this {@link EventLoop}. The returned {@link ChannelFuture}
|
|
* will get notified once the registration was complete.
|
|
*/
|
|
ChannelFuture register(Channel channel);
|
|
|
|
/**
|
|
* Register a {@link Channel} with this {@link EventLoop} using a {@link ChannelFuture}. The passed
|
|
* {@link ChannelFuture} will get notified once the registration was complete and also will get returned.
|
|
*/
|
|
ChannelFuture register(ChannelPromise promise);
|
|
|
|
/**
|
|
* Register a {@link Channel} with this {@link EventLoop}. The passed {@link ChannelFuture}
|
|
* will get notified once the registration was complete and also will get returned.
|
|
*
|
|
* @deprecated Use {@link #register(ChannelPromise)} instead.
|
|
*/
|
|
@Deprecated
|
|
ChannelFuture register(Channel channel, ChannelPromise promise);
|
|
}
|