2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.protocol.framework;
10 import java.io.Closeable;
11 import java.net.InetSocketAddress;
12 import java.net.SocketAddress;
14 import org.slf4j.Logger;
15 import org.slf4j.LoggerFactory;
17 import com.google.common.base.Preconditions;
19 import io.netty.bootstrap.Bootstrap;
20 import io.netty.bootstrap.ServerBootstrap;
21 import io.netty.buffer.PooledByteBufAllocator;
22 import io.netty.channel.Channel;
23 import io.netty.channel.ChannelFuture;
24 import io.netty.channel.ChannelInitializer;
25 import io.netty.channel.ChannelOption;
26 import io.netty.channel.EventLoopGroup;
27 import io.netty.channel.ServerChannel;
28 import io.netty.channel.local.LocalServerChannel;
29 import io.netty.channel.socket.SocketChannel;
30 import io.netty.channel.socket.nio.NioServerSocketChannel;
31 import io.netty.channel.socket.nio.NioSocketChannel;
32 import io.netty.util.concurrent.DefaultPromise;
33 import io.netty.util.concurrent.EventExecutor;
34 import io.netty.util.concurrent.Future;
35 import io.netty.util.concurrent.GlobalEventExecutor;
36 import io.netty.util.concurrent.Promise;
39 * Dispatcher class for creating servers and clients. The idea is to first create servers and clients and the run the
40 * start method that will handle sockets in different thread.
42 public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends SessionListener<?, ?, ?>> implements Closeable {
45 protected interface ChannelPipelineInitializer<CH extends Channel, S extends ProtocolSession<?>> {
47 * Initializes channel by specifying the handlers in its pipeline. Handlers are protocol specific, therefore this
48 * method needs to be implemented in protocol specific Dispatchers.
50 * @param channel whose pipeline should be defined, also to be passed to {@link SessionNegotiatorFactory}
51 * @param promise to be passed to {@link SessionNegotiatorFactory}
53 void initializeChannel(CH channel, Promise<S> promise);
56 protected interface PipelineInitializer<S extends ProtocolSession<?>> extends ChannelPipelineInitializer<SocketChannel, S> {
61 private static final Logger LOG = LoggerFactory.getLogger(AbstractDispatcher.class);
63 private final EventLoopGroup bossGroup;
65 private final EventLoopGroup workerGroup;
67 private final EventExecutor executor;
69 protected AbstractDispatcher(final EventLoopGroup bossGroup, final EventLoopGroup workerGroup) {
70 this(GlobalEventExecutor.INSTANCE, bossGroup, workerGroup);
73 protected AbstractDispatcher(final EventExecutor executor, final EventLoopGroup bossGroup, final EventLoopGroup workerGroup) {
74 this.bossGroup = Preconditions.checkNotNull(bossGroup);
75 this.workerGroup = Preconditions.checkNotNull(workerGroup);
76 this.executor = Preconditions.checkNotNull(executor);
81 * Creates server. Each server needs factories to pass their instances to client sessions.
83 * @param address address to which the server should be bound
84 * @param initializer instance of PipelineInitializer used to initialize the channel pipeline
86 * @return ChannelFuture representing the binding process
88 protected ChannelFuture createServer(final InetSocketAddress address, final PipelineInitializer<S> initializer) {
89 return createServer(address, NioServerSocketChannel.class, initializer);
93 * Creates server. Each server needs factories to pass their instances to client sessions.
95 * @param address address to which the server should be bound
96 * @param channelClass The {@link Class} which is used to create {@link Channel} instances from.
97 * @param initializer instance of PipelineInitializer used to initialize the channel pipeline
99 * @return ChannelFuture representing the binding process
101 protected <CH extends Channel> ChannelFuture createServer(final SocketAddress address, final Class<? extends ServerChannel> channelClass,
102 final ChannelPipelineInitializer<CH, S> initializer) {
103 final ServerBootstrap b = new ServerBootstrap();
104 b.childHandler(new ChannelInitializer<CH>() {
107 protected void initChannel(final CH ch) {
108 initializer.initializeChannel(ch, new DefaultPromise<S>(executor));
112 b.option(ChannelOption.SO_BACKLOG, 128);
113 if (LocalServerChannel.class.equals(channelClass) == false) {
114 // makes no sense for LocalServer and produces warning
115 b.childOption(ChannelOption.SO_KEEPALIVE, true);
117 b.childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT);
118 customizeBootstrap(b);
120 if (b.group() == null) {
121 b.group(bossGroup, workerGroup);
124 b.channel(channelClass);
125 } catch (IllegalStateException e) {
126 // FIXME: if this is ok, document why
127 LOG.trace("Not overriding channelFactory on bootstrap {}", b, e);
130 // Bind and start to accept incoming connections.
131 final ChannelFuture f = b.bind(address);
132 LOG.debug("Initiated server {} at {}.", f, address);
137 * Customize a server bootstrap before the server is created. This allows
138 * subclasses to assign non-default server options before the server is
141 * @param b Server bootstrap
143 protected void customizeBootstrap(final ServerBootstrap b) {
144 // The default is a no-op
150 * @param address remote address
151 * @param connectStrategy Reconnection strategy to be used when initial connection fails
153 * @return Future representing the connection process. Its result represents the combined success of TCP connection
154 * as well as session negotiation.
156 protected Future<S> createClient(final InetSocketAddress address, final ReconnectStrategy strategy, final PipelineInitializer<S> initializer) {
157 final Bootstrap b = new Bootstrap();
158 final ProtocolSessionPromise<S> p = new ProtocolSessionPromise<>(executor, address, strategy, b);
159 b.option(ChannelOption.SO_KEEPALIVE, true).handler(
160 new ChannelInitializer<SocketChannel>() {
162 protected void initChannel(final SocketChannel ch) {
163 initializer.initializeChannel(ch, p);
167 customizeBootstrap(b);
169 setChannelFactory(b);
172 LOG.debug("Client created.");
176 private void setWorkerGroup(final Bootstrap b) {
177 if (b.group() == null) {
178 b.group(workerGroup);
183 * Create a client but use a pre-configured bootstrap.
184 * This method however replaces the ChannelInitializer in the bootstrap. All other configuration is preserved.
186 * @param address remote address
188 protected Future<S> createClient(final InetSocketAddress address, final ReconnectStrategy strategy, final Bootstrap bootstrap, final PipelineInitializer<S> initializer) {
189 final ProtocolSessionPromise<S> p = new ProtocolSessionPromise<>(executor, address, strategy, bootstrap);
192 new ChannelInitializer<SocketChannel>() {
194 protected void initChannel(final SocketChannel ch) {
195 initializer.initializeChannel(ch, p);
200 LOG.debug("Client created.");
205 * Customize a client bootstrap before the connection is attempted. This
206 * allows subclasses to assign non-default options before the client is
209 * @param b Client bootstrap
211 protected void customizeBootstrap(final Bootstrap b) {
212 // The default is a no-op
217 * @deprecated use {@link org.opendaylight.protocol.framework.AbstractDispatcher#createReconnectingClient(java.net.InetSocketAddress, ReconnectStrategyFactory, org.opendaylight.protocol.framework.AbstractDispatcher.PipelineInitializer)} with only one reconnectStrategyFactory instead.
221 * @param address remote address
222 * @param connectStrategyFactory Factory for creating reconnection strategy to be used when initial connection fails
223 * @param reestablishStrategy Reconnection strategy to be used when the already-established session fails
225 * @return Future representing the reconnection task. It will report completion based on reestablishStrategy, e.g.
226 * success if it indicates no further attempts should be made and failure if it reports an error
229 protected Future<Void> createReconnectingClient(final InetSocketAddress address, final ReconnectStrategyFactory connectStrategyFactory,
230 final ReconnectStrategy reestablishStrategy, final PipelineInitializer<S> initializer) {
231 return createReconnectingClient(address, connectStrategyFactory, initializer);
235 * Creates a reconnecting client.
237 * @param address remote address
238 * @param connectStrategyFactory Factory for creating reconnection strategy for every reconnect attempt
240 * @return Future representing the reconnection task. It will report completion based on reestablishStrategy, e.g.
241 * success if it indicates no further attempts should be made and failure if it reports an error
243 protected Future<Void> createReconnectingClient(final InetSocketAddress address, final ReconnectStrategyFactory connectStrategyFactory,
244 final PipelineInitializer<S> initializer) {
245 final Bootstrap b = new Bootstrap();
247 final ReconnectPromise<S, L> p = new ReconnectPromise<>(GlobalEventExecutor.INSTANCE, this, address, connectStrategyFactory, b, initializer);
249 b.option(ChannelOption.SO_KEEPALIVE, true);
251 customizeBootstrap(b);
253 setChannelFactory(b);
259 private void setChannelFactory(final Bootstrap b) {
260 // There is no way to detect if this was already set by
261 // customizeBootstrap()
263 b.channel(NioSocketChannel.class);
264 } catch (final IllegalStateException e) {
265 LOG.trace("Not overriding channelFactory on bootstrap {}", b, e);
270 * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()}
274 public void close() {
276 this.workerGroup.shutdownGracefully();
278 this.bossGroup.shutdownGracefully();