bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIB.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 java.util.Set;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  13 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  14 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  15 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  16 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  22
  23 /**
  24  * Internal reference to a RIB instance.
  25  */
  26 public interface RIB {
  27     AsNumber getLocalAs();
  28
  29     Ipv4Address getBgpIdentifier();
  30
  31     /**
  32      * Return the set of table identifiers which are accepted and advertised
  33      * by this RIB instance.
  34      *
  35      * @return A set of identifiers.
  36      */
  37     @Nonnull Set<? extends BgpTableType> getLocalTables();
  38
  39     void initTable(Peer bgpPeer, TablesKey key);
  40
  41     void clearTable(Peer bgpPeer, TablesKey key);
  42
  43     void updateTables(Peer bgpPeer, Update message);
  44
  45     BGPDispatcher getDispatcher();
  46
  47     ReconnectStrategyFactory getTcpStrategyFactory();
  48
  49     ReconnectStrategyFactory getSessionStrategyFactory();
  50
  51     AdjRIBsOutRegistration registerRIBsOut(Peer bgpPeer, AdjRIBsOut aro);
  52
  53     long getRoutesCount(TablesKey key);
  54
  55     /**
  56      * Allocate a new transaction chain for use with a peer.
  57      *
  58      * @param listener {@link TransactionChainListener} handling recovery
  59      * @return A new transaction chain.
  60      */
  61     DOMTransactionChain createPeerChain(TransactionChainListener listener);
  62
  63     /**
  64      * Return the RIB extensions available to the RIB instance.
  65      *
  66      * @return RIB extensions handle.
  67      */
  68     RIBExtensionConsumerContext getRibExtensions();
  69 }