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.bgp.rib.impl.spi;
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 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 * Internal reference to a RIB instance.
27 public interface RIB {
28 AsNumber getLocalAs();
30 Ipv4Address getBgpIdentifier();
33 * Return the set of table identifiers which are accepted and advertised
34 * by this RIB instance.
36 * @return A set of identifiers.
38 @Nonnull Set<? extends BgpTableType> getLocalTables();
41 void initTable(Peer bgpPeer, TablesKey key);
44 void clearTable(Peer bgpPeer, TablesKey key);
47 void updateTables(Peer bgpPeer, Update message);
49 BGPDispatcher getDispatcher();
51 ReconnectStrategyFactory getTcpStrategyFactory();
53 ReconnectStrategyFactory getSessionStrategyFactory();
55 AdjRIBsOutRegistration registerRIBsOut(Peer bgpPeer, AdjRIBsOut aro);
57 long getRoutesCount(TablesKey key);
60 * Allocate a new transaction chain for use with a peer.
62 * @param listener {@link TransactionChainListener} handling recovery
63 * @return A new transaction chain.
65 DOMTransactionChain createPeerChain(TransactionChainListener listener);
68 * Return the RIB extensions available to the RIB instance.
70 * @return RIB extensions handle.
72 RIBExtensionConsumerContext getRibExtensions();
75 * Return the RIB extensions available to the RIB instance
76 * with additional RIB specific context such as
77 * translation between DOM and Binding.
79 * @return RIB extensions handle.
81 RIBSupportContextRegistry getRibSupportContext();
84 * Return YangInstanceIdentifier of BGP Rib with its RibId.
86 * @return YangInstanceIdentifier
88 YangInstanceIdentifier getYangRibId();