opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.framework;
   9
  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;
  24
  25 import java.io.Closeable;
  26 import java.net.InetSocketAddress;
  27
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 import com.google.common.base.Preconditions;
  32
  33 /**
  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.
  36  */
  37 public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends SessionListener<?, ?, ?>> implements Closeable {
  38
  39     protected interface PipelineInitializer<S extends ProtocolSession<?>> {
  40         /**
  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.
  43          *
  44          * @param channel whose pipeline should be defined, also to be passed to {@link SessionNegotiatorFactory}
  45          * @param promise to be passed to {@link SessionNegotiatorFactory}
  46          */
  47         void initializeChannel(SocketChannel channel, Promise<S> promise);
  48     }
  49
  50
  51     private static final Logger LOG = LoggerFactory.getLogger(AbstractDispatcher.class);
  52
  53     private final EventLoopGroup bossGroup;
  54
  55     private final EventLoopGroup workerGroup;
  56
  57     private final EventExecutor executor;
  58
  59     protected AbstractDispatcher(final EventLoopGroup bossGroup, final EventLoopGroup workerGroup) {
  60         this(GlobalEventExecutor.INSTANCE, bossGroup, workerGroup);
  61     }
  62
  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);
  67     }
  68
  69
  70     /**
  71      * Creates server. Each server needs factories to pass their instances to client sessions.
  72      *
  73      * @param address address to which the server should be bound
  74      * @param initializer instance of PipelineInitializer used to initialize the channel pipeline
  75      *
  76      * @return ChannelFuture representing the binding process
  77      */
  78     protected ChannelFuture createServer(final InetSocketAddress address, final PipelineInitializer<S> initializer) {
  79         final ServerBootstrap b = new ServerBootstrap();
  80         b.group(this.bossGroup, this.workerGroup);
  81         b.channel(NioServerSocketChannel.class);
  82         b.option(ChannelOption.SO_BACKLOG, 128);
  83         b.childHandler(new ChannelInitializer<SocketChannel>() {
  84
  85             @Override
  86             protected void initChannel(final SocketChannel ch) {
  87                 initializer.initializeChannel(ch, new DefaultPromise<S>(executor));
  88             }
  89         });
  90         b.childOption(ChannelOption.SO_KEEPALIVE, true);
  91
  92         customizeBootstrap(b);
  93
  94         // Bind and start to accept incoming connections.
  95         final ChannelFuture f = b.bind(address);
  96         LOG.debug("Initiated server {} at {}.", f, address);
  97         return f;
  98     }
  99
 100     /**
 101      * Customize a server bootstrap before the server is created. This allows
 102      * subclasses to assign non-default server options before the server is
 103      * created.
 104      *
 105      * @param b Server bootstrap
 106      */
 107     protected void customizeBootstrap(final ServerBootstrap b) {
 108         // The default is a no-op
 109     }
 110
 111     /**
 112      * Creates a client.
 113      *
 114      * @param address remote address
 115      * @param connectStrategy Reconnection strategy to be used when initial connection fails
 116      *
 117      * @return Future representing the connection process. Its result represents the combined success of TCP connection
 118      *         as well as session negotiation.
 119      */
 120     protected Future<S> createClient(final InetSocketAddress address, final ReconnectStrategy strategy, final PipelineInitializer<S> initializer) {
 121         final Bootstrap b = new Bootstrap();
 122         final ProtocolSessionPromise<S> p = new ProtocolSessionPromise<S>(executor, address, strategy, b);
 123         b.group(this.workerGroup).channel(NioSocketChannel.class).option(ChannelOption.SO_KEEPALIVE, true).handler(
 124                 new ChannelInitializer<SocketChannel>() {
 125
 126                     @Override
 127                     protected void initChannel(final SocketChannel ch) {
 128                         initializer.initializeChannel(ch, p);
 129                     }
 130                 });
 131
 132         customizeBootstrap(b);
 133
 134         p.connect();
 135         LOG.debug("Client created.");
 136         return p;
 137     }
 138
 139     /**
 140      * Customize a client bootstrap before the connection is attempted. This
 141      * allows subclasses to assign non-default options before the client is
 142      * created.
 143      *
 144      * @param b Client bootstrap
 145      */
 146     protected void customizeBootstrap(final Bootstrap b) {
 147         // The default is a no-op
 148     }
 149
 150     /**
 151      * Creates a client.
 152      *
 153      * @param address remote address
 154      * @param connectStrategyFactory Factory for creating reconnection strategy to be used when initial connection fails
 155      * @param reestablishStrategy Reconnection strategy to be used when the already-established session fails
 156      *
 157      * @return Future representing the reconnection task. It will report completion based on reestablishStrategy, e.g.
 158      *         success if it indicates no further attempts should be made and failure if it reports an error
 159      */
 160     protected Future<Void> createReconnectingClient(final InetSocketAddress address, final ReconnectStrategyFactory connectStrategyFactory,
 161             final ReconnectStrategy reestablishStrategy, final PipelineInitializer<S> initializer) {
 162
 163         final ReconnectPromise<S, L> p = new ReconnectPromise<S, L>(GlobalEventExecutor.INSTANCE, this, address, connectStrategyFactory, reestablishStrategy, initializer);
 164         p.connect();
 165
 166         return p;
 167     }
 168
 169     /**
 170      * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()}
 171      */
 172     @Deprecated
 173     @Override
 174     public void close() {
 175         try {
 176             this.workerGroup.shutdownGracefully();
 177         } finally {
 178             this.bossGroup.shutdownGracefully();
 179         }
 180     }
 181
 182 }