bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/BGPDispatcher.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.bgp.rib.impl.spi;
   9
  10 import io.netty.util.concurrent.Future;
  11 import java.net.InetSocketAddress;
  12 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
  13 import org.opendaylight.protocol.framework.ReconnectStrategy;
  14 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  15 import org.opendaylight.tcpmd5.api.KeyMapping;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  17
  18 /**
  19  * Dispatcher class for creating BGP clients.
  20  */
  21 public interface BGPDispatcher extends BGPServerDispatcher {
  22
  23     /**
  24      * Creates BGP client.
  25      *
  26      * @param address Peer address
  27      * @param remoteAs remote AS
  28      * @param peerRegistry BGP peer registry
  29      * @param strategy reconnection strategy
  30      * @return Future promising a client session
  31      */
  32     Future<? extends BGPSession> createClient(InetSocketAddress address, AsNumber remoteAs,
  33             BGPPeerRegistry peerRegistry, ReconnectStrategy strategy);
  34
  35     Future<Void> createReconnectingClient(InetSocketAddress address, AsNumber remoteAs,
  36                                           BGPPeerRegistry peerRegistry, ReconnectStrategyFactory connectStrategyFactory,
  37             ReconnectStrategyFactory reestablishStrategyFactory);
  38
  39     Future<Void> createReconnectingClient(InetSocketAddress address, AsNumber remoteAs,
  40                                           BGPPeerRegistry peerRegistry, ReconnectStrategyFactory connectStrategyFactory,
  41             ReconnectStrategyFactory reestablishStrategyFactory, KeyMapping keys);
  42 }