org.opendaylight.protocol.bgp.rib.impl.spi

Interface RIB

All Superinterfaces:

AutoCloseable, org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider, InstanceReference<Rib>, RibReference

All Known Implementing Classes:

RibImpl, RIBImpl

public interface RIB
extends RibReference, org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider

Internal reference to a RIB instance.

Method Summary

Modifier and Type	Method and Description
org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain	createPeerChain(org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener listener) Allocate a new transaction chain for use with a peer.
BgpId	getBgpIdentifier()
CodecsRegistry	getCodecsRegistry()
BGPDispatcher	getDispatcher()
ExportPolicyPeerTracker	getExportPolicyPeerTracker(TablesKey tablesKey) Returns ExportPolicyPeerTracker for specific tableKey, where peer can register himself as supporting the table.
ImportPolicyPeerTracker	getImportPolicyPeerTracker()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber	getLocalAs()
Set<? extends BgpTableType>	getLocalTables() Return the set of table identifiers which are accepted and advertised by this RIB instance.
Set<TablesKey>	getLocalTablesKeys()
BGPRenderStats	getRenderStats()
RIBExtensionConsumerContext	getRibExtensions() Return the RIB extensions available to the RIB instance.
org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier	getRibIServiceGroupIdentifier() Return common ServiceGroupIdentifier to be used between same group cluster service
RIBSupportContextRegistry	getRibSupportContext() Return the RIB extensions available to the RIB instance with additional RIB specific context such as translation between DOM and Binding.
org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService	getService() Return instance of DOMDataTreeChangeService, where consumer can register to listen on DOM data changes.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	getYangRibId() Return YangInstanceIdentifier of BGP Rib with its RibId.

Methods inherited from interface org.opendaylight.protocol.bgp.rib.RibReference

getInstanceIdentifier

Methods inherited from interface org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider

registerClusterSingletonService

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getLocalAs

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getLocalAs()

getBgpIdentifier

BgpId getBgpIdentifier()

getLocalTables

@Nonnull
Set<? extends BgpTableType> getLocalTables()

Return the set of table identifiers which are accepted and advertised by this RIB instance.

Returns:

A set of identifiers.

getDispatcher

BGPDispatcher getDispatcher()

createPeerChain

org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain createPeerChain(org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener listener)

Allocate a new transaction chain for use with a peer.

Parameters:

listener - TransactionChainListener handling recovery

Returns:

A new transaction chain.

getRibExtensions

RIBExtensionConsumerContext getRibExtensions()

Return the RIB extensions available to the RIB instance.

Returns:

RIB extensions handle.

getRibSupportContext

RIBSupportContextRegistry getRibSupportContext()

Return the RIB extensions available to the RIB instance with additional RIB specific context such as translation between DOM and Binding.

Returns:

RIB extensions handle.

getYangRibId

org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getYangRibId()

Return YangInstanceIdentifier of BGP Rib with its RibId.

Returns:

YangInstanceIdentifier

getCodecsRegistry

CodecsRegistry getCodecsRegistry()

getService

org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService getService()

Return instance of DOMDataTreeChangeService, where consumer can register to listen on DOM data changes.

Returns:

DOMDataTreeChangeService

getRenderStats

BGPRenderStats getRenderStats()

getImportPolicyPeerTracker

ImportPolicyPeerTracker getImportPolicyPeerTracker()

getExportPolicyPeerTracker

ExportPolicyPeerTracker getExportPolicyPeerTracker(TablesKey tablesKey)

Returns ExportPolicyPeerTracker for specific tableKey, where peer can register himself as supporting the table. Same export policy can be used to check which peers support respective table and announce then routes if required.

Parameters:

tablesKey - supported table

Returns:

ExportPolicyPeerTracker

getLocalTablesKeys

Set<TablesKey> getLocalTablesKeys()

getRibIServiceGroupIdentifier

org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier getRibIServiceGroupIdentifier()

Return common ServiceGroupIdentifier to be used between same group cluster service

Returns:

ServiceGroupIdentifier