org.opendaylight.protocol.bgp.mode.api

Interface RouteEntry

All Known Implementing Classes:

AbstractRouteEntry, AddPathAbstractRouteEntry

public interface RouteEntry

A single route entry inside a route table. Maintains the attributes of from all contributing peers. The information is stored in arrays with a shared map of offsets for peers to allow lookups. This is needed to maintain low memory overhead in face of large number of routes and peers, where individual object overhead becomes the dominating factor.

Method Summary

Modifier and Type	Method and Description
int	addRoute(UnsignedInteger routerId, Long remotePathId, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier attrII, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)
org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode	createValue(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId, BestPath path) Create value
boolean	removeRoute(UnsignedInteger routerId, Long remotePathId) Remove route
boolean	selectBest(long localAs) Indicates whether best has changed
void	updateRoute(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey localTK, org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker peerPT, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier locRibTarget, org.opendaylight.protocol.bgp.rib.spi.RIBSupport ribSupport, org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeIdPA) Update LocRibOut and AdjRibsOut by removing stale best path and writing new best
void	writeRoute(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId peerId, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath, org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup peerGroup, org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey localTK, org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker peerPT, org.opendaylight.protocol.bgp.rib.spi.RIBSupport ribSupport, org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx) Write Route on LocRibOut and AdjRibsOut

Method Detail

removeRoute

boolean removeRoute(UnsignedInteger routerId,
                    Long remotePathId)

Remove route

Parameters:

routerId - router ID in unsigned integer format from an Ipv4Address

remotePathId - remote path Id received

Returns:

return true if it was the last route on entry

createValue

org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode createValue(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId,
                                                                         BestPath path)

Create value

Parameters:

routeId - router ID pathArgument

path - BestPath

Returns:

MapEntryNode

selectBest

boolean selectBest(long localAs)

Indicates whether best has changed

Parameters:

localAs - The local autonomous system number

Returns:

return true if it has changed

addRoute

int addRoute(UnsignedInteger routerId,
             Long remotePathId,
             org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier attrII,
             org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Parameters:

routerId - router ID in unsigned integer format from an Ipv4Address

remotePathId - remote path Id received

attrII - route Attributes Identifier

data - route Data change

Returns:

returns the offset

updateRoute

void updateRoute(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey localTK,
                 org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker peerPT,
                 org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier locRibTarget,
                 org.opendaylight.protocol.bgp.rib.spi.RIBSupport ribSupport,
                 org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                 org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeIdPA)

Update LocRibOut and AdjRibsOut by removing stale best path and writing new best

Parameters:

localTK - local Table Key

peerPT - peer export policy

locRibTarget - YII local rib

ribSupport - rib support

tx - DOM transaction

routeIdPA - router ID pathArgument

writeRoute

void writeRoute(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId peerId,
                org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId,
                org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier rootPath,
                org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup peerGroup,
                org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey localTK,
                org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker peerPT,
                org.opendaylight.protocol.bgp.rib.spi.RIBSupport ribSupport,
                org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx)

Write Route on LocRibOut and AdjRibsOut

Parameters:

peerId - destination peerId

routeId - router ID path Argument

rootPath - YII root path

peerGroup - PeerExportGroup

localTK - local Table Key

ribSupport - rib support

tx - DOM transaction