opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/ReconnectPromise.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 com.google.common.base.Preconditions;
  11 import io.netty.bootstrap.Bootstrap;
  12 import io.netty.channel.ChannelHandlerContext;
  13 import io.netty.channel.ChannelInboundHandlerAdapter;
  14 import io.netty.util.concurrent.DefaultPromise;
  15 import io.netty.util.concurrent.EventExecutor;
  16 import io.netty.util.concurrent.Future;
  17 import io.netty.util.concurrent.GenericFutureListener;
  18 import java.net.InetSocketAddress;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 @Deprecated
  23 final class ReconnectPromise<S extends ProtocolSession<?>, L extends SessionListener<?, ?, ?>> extends DefaultPromise<Void> {
  24     private static final Logger LOG = LoggerFactory.getLogger(ReconnectPromise.class);
  25
  26     private final AbstractDispatcher<S, L> dispatcher;
  27     private final InetSocketAddress address;
  28     private final ReconnectStrategyFactory strategyFactory;
  29     private final Bootstrap b;
  30     private final AbstractDispatcher.PipelineInitializer<S> initializer;
  31     private Future<?> pending;
  32
  33     public ReconnectPromise(final EventExecutor executor, final AbstractDispatcher<S, L> dispatcher, final InetSocketAddress address,
  34                             final ReconnectStrategyFactory connectStrategyFactory, final Bootstrap b, final AbstractDispatcher.PipelineInitializer<S> initializer) {
  35         super(executor);
  36         this.b = b;
  37         this.initializer = Preconditions.checkNotNull(initializer);
  38         this.dispatcher = Preconditions.checkNotNull(dispatcher);
  39         this.address = Preconditions.checkNotNull(address);
  40         this.strategyFactory = Preconditions.checkNotNull(connectStrategyFactory);
  41     }
  42
  43     synchronized void connect() {
  44         final ReconnectStrategy cs = this.strategyFactory.createReconnectStrategy();
  45
  46         // Set up a client with pre-configured bootstrap, but add a closed channel handler into the pipeline to support reconnect attempts
  47         pending = this.dispatcher.createClient(this.address, cs, b, (channel, promise) -> {
  48             initializer.initializeChannel(channel, promise);
  49             // add closed channel handler
  50             // This handler has to be added as last channel handler and the channel inactive event has to be caught by it
  51             // Handlers in front of it can react to channelInactive event, but have to forward the event or the reconnect will not work
  52             // This handler is last so all handlers in front of it can handle channel inactive (to e.g. resource cleanup) before a new connection is started
  53             channel.pipeline().addLast(new ClosedChannelHandler(ReconnectPromise.this));
  54         });
  55
  56         pending.addListener((GenericFutureListener<Future<Object>>) future -> {
  57             if (!future.isSuccess()) {
  58                 ReconnectPromise.this.setFailure(future.cause());
  59             }
  60         });
  61     }
  62
  63     /**
  64      *
  65      * @return true if initial connection was established successfully, false if initial connection failed due to e.g. Connection refused, Negotiation failed
  66      */
  67     private boolean isInitialConnectFinished() {
  68         Preconditions.checkNotNull(pending);
  69         return pending.isDone() && pending.isSuccess();
  70     }
  71
  72     @Override
  73     public synchronized boolean cancel(final boolean mayInterruptIfRunning) {
  74         if (super.cancel(mayInterruptIfRunning)) {
  75             Preconditions.checkNotNull(pending);
  76             this.pending.cancel(mayInterruptIfRunning);
  77             return true;
  78         }
  79
  80         return false;
  81     }
  82
  83     /**
  84      * Channel handler that responds to channelInactive event and reconnects the session.
  85      * Only if the promise was not canceled.
  86      */
  87     private static final class ClosedChannelHandler extends ChannelInboundHandlerAdapter {
  88         private final ReconnectPromise<?, ?> promise;
  89
  90         public ClosedChannelHandler(final ReconnectPromise<?, ?> promise) {
  91             this.promise = promise;
  92         }
  93
  94         @Override
  95         public void channelInactive(final ChannelHandlerContext ctx) throws Exception {
  96             // This is the ultimate channel inactive handler, not forwarding
  97             if (promise.isCancelled()) {
  98                 return;
  99             }
 100
 101             if (promise.isInitialConnectFinished() == false) {
 102                 LOG.debug("Connection to {} was dropped during negotiation, reattempting", promise.address);
 103             }
 104
 105             LOG.debug("Reconnecting after connection to {} was dropped", promise.address);
 106             promise.connect();
 107         }
 108     }
 109
 110 }