Package org.opendaylight.protocol.bgp.rib.spi

Interface Peer

All Superinterfaces:

PeerTrackerInformation, RouteTargetMembershipConsumer

All Known Implementing Classes:

ApplicationPeer, BGPPeer

public interface Peer
extends PeerTrackerInformation, RouteTargetMembershipConsumer

Marker interface identifying a BGP peer.

Method Summary

Modifier and Type	Method	Description
@NonNull com.google.common.util.concurrent.FluentFuture<? extends Object>	close()	Close Peers and performs asynchronously DS clean up.
@NonNull String	getName()	Return peer's symbolic name.
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>> void	initializeRibOut(@NonNull RouteEntryDependenciesContainer entryDep, @NonNull List<ActualBestPathRoutes<C,S>> routes)	Stores under peers rib Out already present routes, before proceed to process any new route advertizement.
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>> void	reEvaluateAdvertizement(@NonNull RouteEntryDependenciesContainer entryDep, @NonNull List<ActualBestPathRoutes<C,S>> routes)	Applies all policies through all present routes, and advertize/withdraws based on new results.
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>> void	refreshRibOut(@NonNull RouteEntryDependenciesContainer entryDep, @NonNull List<StaleBestPathRoute> staleRoutes, @NonNull List<AdvertizedRoute<C,S>> newRoutes)	Update peers ribout after path selection processing.

Methods inherited from interface org.opendaylight.protocol.bgp.rib.spi.PeerTrackerInformation

getClusterId, getLocalAs, getPeerId, getRibOutIId, getRole, getSupportedAddPathTables, supportsAddPathSupported, supportsTable

Methods inherited from interface org.opendaylight.protocol.bgp.rib.spi.policy.RouteTargetMembershipConsumer

getMemberships

Method Details

getName

@NonNull String getName()

Return peer's symbolic name.

Returns:

symbolic name.

close

@NonNull com.google.common.util.concurrent.FluentFuture<? extends Object> close()

Close Peers and performs asynchronously DS clean up.

Returns:

future

refreshRibOut

<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,
S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>>
void refreshRibOut(@NonNull RouteEntryDependenciesContainer entryDep,
 @NonNull List<StaleBestPathRoute> staleRoutes,
 @NonNull List<AdvertizedRoute<C,S>> newRoutes)

Update peers ribout after path selection processing.

Parameters:

entryDep - RouteEntryDependenciesContainer

staleRoutes - routes to be removed.

newRoutes - routes to be advertized.

initializeRibOut

<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,
S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>>
void initializeRibOut(@NonNull RouteEntryDependenciesContainer entryDep,
 @NonNull List<ActualBestPathRoutes<C,S>> routes)

Stores under peers rib Out already present routes, before proceed to process any new route advertizement.

Parameters:

entryDep - RouteEntryDependenciesContainer

routes - routes to be advertized.

reEvaluateAdvertizement

<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,
S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>>
void reEvaluateAdvertizement(@NonNull RouteEntryDependenciesContainer entryDep,
 @NonNull List<ActualBestPathRoutes<C,S>> routes)

Applies all policies through all present routes, and advertize/withdraws based on new results. Scenario would be for example a removal of RT membership. And reprocess VPN routes.

Parameters:

entryDep - RouteEntryDependenciesContainer

routes - routes to be updated.