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 com.google.common.base.Preconditions;
11 import io.netty.bootstrap.Bootstrap;
12 import io.netty.channel.ChannelFuture;
13 import io.netty.channel.ChannelFutureListener;
14 import io.netty.channel.ChannelOption;
15 import io.netty.util.concurrent.DefaultPromise;
16 import io.netty.util.concurrent.EventExecutor;
17 import io.netty.util.concurrent.Future;
18 import io.netty.util.concurrent.FutureListener;
19 import io.netty.util.concurrent.Promise;
20 import java.net.InetSocketAddress;
21 import javax.annotation.concurrent.GuardedBy;
22 import javax.annotation.concurrent.ThreadSafe;
23 import org.slf4j.Logger;
24 import org.slf4j.LoggerFactory;
28 final class ProtocolSessionPromise<S extends ProtocolSession<?>> extends DefaultPromise<S> {
29 private static final Logger LOG = LoggerFactory.getLogger(ProtocolSessionPromise.class);
30 private final ReconnectStrategy strategy;
31 private InetSocketAddress address;
32 private final Bootstrap b;
35 private Future<?> pending;
37 ProtocolSessionPromise(final EventExecutor executor, final InetSocketAddress address, final ReconnectStrategy strategy,
40 this.strategy = Preconditions.checkNotNull(strategy);
41 this.address = Preconditions.checkNotNull(address);
42 this.b = Preconditions.checkNotNull(b);
45 synchronized void connect() {
46 final Object lock = this;
49 final int timeout = this.strategy.getConnectTimeout();
51 LOG.debug("Promise {} attempting connect for {}ms", lock, timeout);
53 if(this.address.isUnresolved()) {
54 this.address = new InetSocketAddress(this.address.getHostName(), this.address.getPort());
56 this.b.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, timeout);
57 final ChannelFuture connectFuture = this.b.connect(this.address);
58 // Add listener that attempts reconnect by invoking this method again.
59 connectFuture.addListener(new BootstrapConnectListener(lock));
60 this.pending = connectFuture;
61 } catch (final Exception e) {
62 LOG.info("Failed to connect to {}", address, e);
68 public synchronized boolean cancel(final boolean mayInterruptIfRunning) {
69 if (super.cancel(mayInterruptIfRunning)) {
70 this.pending.cancel(mayInterruptIfRunning);
78 public synchronized Promise<S> setSuccess(final S result) {
79 LOG.debug("Promise {} completed", this);
80 this.strategy.reconnectSuccessful();
81 return super.setSuccess(result);
84 private class BootstrapConnectListener implements ChannelFutureListener {
85 private final Object lock;
87 public BootstrapConnectListener(final Object lock) {
92 public void operationComplete(final ChannelFuture cf) throws Exception {
95 LOG.debug("Promise {} connection resolved", lock);
97 // Triggered when a connection attempt is resolved.
98 Preconditions.checkState(ProtocolSessionPromise.this.pending.equals(cf));
101 * The promise we gave out could have been cancelled,
102 * which cascades to the connect getting cancelled,
103 * but there is a slight race window, where the connect
104 * is already resolved, but the listener has not yet
105 * been notified -- cancellation at that point won't
106 * stop the notification arriving, so we have to close
110 if (cf.isSuccess()) {
111 LOG.debug("Closing channel for cancelled promise {}", lock);
112 cf.channel().close();
118 LOG.debug("Promise {} connection successful", lock);
122 LOG.debug("Attempt to connect to {} failed", ProtocolSessionPromise.this.address, cf.cause());
124 final Future<Void> rf = ProtocolSessionPromise.this.strategy.scheduleReconnect(cf.cause());
125 rf.addListener(new ReconnectingStrategyListener());
126 ProtocolSessionPromise.this.pending = rf;
130 private class ReconnectingStrategyListener implements FutureListener<Void> {
132 public void operationComplete(final Future<Void> sf) {
133 synchronized (lock) {
134 // Triggered when a connection attempt is to be made.
135 Preconditions.checkState(ProtocolSessionPromise.this.pending.equals(sf));
138 * The promise we gave out could have been cancelled,
139 * which cascades to the reconnect attempt getting
140 * cancelled, but there is a slight race window, where
141 * the reconnect attempt is already enqueued, but the
142 * listener has not yet been notified -- if cancellation
143 * happens at that point, we need to catch it here.
145 if (!isCancelled()) {
146 if (sf.isSuccess()) {
149 setFailure(sf.cause());