Package org.opendaylight.protocol.bgp.mode.api

Interface RouteEntry

@NonNullByDefault 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 Details

    • putRoute

      boolean putRoute(RouterId routerId, org.opendaylight.yangtools.yang.common.Uint32 remotePathId, org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode route)
      Put a route.
      Parameters:
      routerId - router ID in unsigned integer format from an Ipv4Address
      remotePathId - remote path Id received
      route - route Data change
      Returns:
      true if a new route was introduced, false if a route was replaced

    • removeRoute

      boolean removeRoute(RouterId routerId, org.opendaylight.yangtools.yang.common.Uint32 remotePathId)
      Remove a route.
      Parameters:
      routerId - router ID in unsigned integer format from an Ipv4Address
      remotePathId - remote path Id received
      Returns:
      true if it was the last route on entry

    • selectBest

      boolean selectBest(RIBSupport ribSupport, long localAs)
      Indicates whether best has changed.
      Parameters:
      localAs - The local autonomous system number
      Returns:
      return true if it has changed

    • actualBestPaths

      List<ActualBestPathRoutes> actualBestPaths(RIBSupport ribSupport, RouteEntryInfo entryInfo)
      Returns collections of present selected best path.
      Parameters:
      ribSupport - RIB Support
      entryInfo - Route Entry Info wrapper
      Returns:
      collections of present selected best path

    • removeStalePaths

      @Nullable StaleBestPathRoute removeStalePaths(RIBSupport ribSupport, String routeKey)
      Returns list of stale best paths.
      Parameters:
      ribSupport - RIB Support
      routeKey - of stale route
      Returns:
      list of stale best paths

    • newBestPaths

      List<AdvertizedRoute> newBestPaths(RIBSupport ribSupport, String routeKey)
      Returns collection of best path routes after processing update of stale and new advertisement of routes.
      Parameters:
      ribSupport - RIB Support
      routeKey - route key
      Returns:
      collection of best path routes after processing update of stale and new advertisement of routes