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 io.netty.bootstrap.Bootstrap;
11 import io.netty.bootstrap.ServerBootstrap;
12 import io.netty.channel.ChannelFuture;
13 import io.netty.channel.ChannelInitializer;
14 import io.netty.channel.ChannelOption;
15 import io.netty.channel.EventLoopGroup;
16 import io.netty.channel.socket.SocketChannel;
17 import io.netty.channel.socket.nio.NioServerSocketChannel;
18 import io.netty.channel.socket.nio.NioSocketChannel;
19 import io.netty.util.concurrent.DefaultPromise;
20 import io.netty.util.concurrent.EventExecutor;
21 import io.netty.util.concurrent.Future;
22 import io.netty.util.concurrent.GlobalEventExecutor;
23 import io.netty.util.concurrent.Promise;
25 import java.io.Closeable;
26 import java.net.InetSocketAddress;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
31 import com.google.common.base.Preconditions;
34 * Dispatcher class for creating servers and clients. The idea is to first create servers and clients and the run the
35 * start method that will handle sockets in different thread.
37 public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends SessionListener<?, ?, ?>> implements Closeable {
39 protected interface PipelineInitializer<S extends ProtocolSession<?>> {
41 * Initializes channel by specifying the handlers in its pipeline. Handlers are protocol specific, therefore this
42 * method needs to be implemented in protocol specific Dispatchers.
44 * @param channel whose pipeline should be defined, also to be passed to {@link SessionNegotiatorFactory}
45 * @param promise to be passed to {@link SessionNegotiatorFactory}
47 void initializeChannel(SocketChannel channel, Promise<S> promise);
51 private static final Logger LOG = LoggerFactory.getLogger(AbstractDispatcher.class);
53 private final EventLoopGroup bossGroup;
55 private final EventLoopGroup workerGroup;
57 private final EventExecutor executor;
59 protected AbstractDispatcher(final EventLoopGroup bossGroup, final EventLoopGroup workerGroup) {
60 this(GlobalEventExecutor.INSTANCE, bossGroup, workerGroup);
63 protected AbstractDispatcher(final EventExecutor executor, final EventLoopGroup bossGroup, final EventLoopGroup workerGroup) {
64 this.bossGroup = Preconditions.checkNotNull(bossGroup);
65 this.workerGroup = Preconditions.checkNotNull(workerGroup);
66 this.executor = Preconditions.checkNotNull(executor);
71 * Creates server. Each server needs factories to pass their instances to client sessions.
73 * @param address address to which the server should be bound
74 * @param initializer instance of PipelineInitializer used to initialize the channel pipeline
76 * @return ChannelFuture representing the binding process
78 protected ChannelFuture createServer(final InetSocketAddress address, final PipelineInitializer<S> initializer) {
79 final ServerBootstrap b = new ServerBootstrap();
80 b.childHandler(new ChannelInitializer<SocketChannel>() {
83 protected void initChannel(final SocketChannel ch) {
84 initializer.initializeChannel(ch, new DefaultPromise<S>(executor));
88 b.option(ChannelOption.SO_BACKLOG, 128);
89 b.childOption(ChannelOption.SO_KEEPALIVE, true);
90 customizeBootstrap(b);
92 if (b.group() == null) {
93 b.group(bossGroup, workerGroup);
96 b.channel(NioServerSocketChannel.class);
97 } catch (IllegalStateException e) {
98 LOG.trace("Not overriding channelFactory on bootstrap {}", b, e);
101 // Bind and start to accept incoming connections.
102 final ChannelFuture f = b.bind(address);
103 LOG.debug("Initiated server {} at {}.", f, address);
108 * Customize a server bootstrap before the server is created. This allows
109 * subclasses to assign non-default server options before the server is
112 * @param b Server bootstrap
114 protected void customizeBootstrap(final ServerBootstrap b) {
115 // The default is a no-op
121 * @param address remote address
122 * @param connectStrategy Reconnection strategy to be used when initial connection fails
124 * @return Future representing the connection process. Its result represents the combined success of TCP connection
125 * as well as session negotiation.
127 protected Future<S> createClient(final InetSocketAddress address, final ReconnectStrategy strategy, final PipelineInitializer<S> initializer) {
128 final Bootstrap b = new Bootstrap();
129 final ProtocolSessionPromise<S> p = new ProtocolSessionPromise<S>(executor, address, strategy, b);
130 b.group(this.workerGroup).channel(NioSocketChannel.class).option(ChannelOption.SO_KEEPALIVE, true).handler(
131 new ChannelInitializer<SocketChannel>() {
134 protected void initChannel(final SocketChannel ch) {
135 initializer.initializeChannel(ch, p);
139 customizeBootstrap(b);
142 LOG.debug("Client created.");
147 * Customize a client bootstrap before the connection is attempted. This
148 * allows subclasses to assign non-default options before the client is
151 * @param b Client bootstrap
153 protected void customizeBootstrap(final Bootstrap b) {
154 // The default is a no-op
160 * @param address remote address
161 * @param connectStrategyFactory Factory for creating reconnection strategy to be used when initial connection fails
162 * @param reestablishStrategy Reconnection strategy to be used when the already-established session fails
164 * @return Future representing the reconnection task. It will report completion based on reestablishStrategy, e.g.
165 * success if it indicates no further attempts should be made and failure if it reports an error
167 protected Future<Void> createReconnectingClient(final InetSocketAddress address, final ReconnectStrategyFactory connectStrategyFactory,
168 final ReconnectStrategy reestablishStrategy, final PipelineInitializer<S> initializer) {
170 final ReconnectPromise<S, L> p = new ReconnectPromise<S, L>(GlobalEventExecutor.INSTANCE, this, address, connectStrategyFactory, reestablishStrategy, initializer);
177 * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()}
181 public void close() {
183 this.workerGroup.shutdownGracefully();
185 this.bossGroup.shutdownGracefully();