Package org.opendaylight.protocol.bgp.rib.impl

Class BGPPeer

java.lang.Object

org.opendaylight.protocol.bgp.rib.DefaultRibReference

org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl

org.opendaylight.protocol.bgp.rib.impl.BGPPeer

All Implemented Interfaces:

com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>, BGPMessagesListener, RibReference, BGPSessionListener, Peer, PeerRPCs, PeerTrackerInformation, BGPRouteEntryImportParameters, RouteTargetMembershipConsumer, BGPAfiSafiState, BGPErrorHandlingState, BGPGracelfulRestartState, BGPLlGracelfulRestartState, BGPPeerMessagesState, BGPPeerState, BGPPeerStateProvider, InstanceReference<Rib>

public final class BGPPeer
extends BGPPeerStateImpl
implements BGPSessionListener

Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into RIB actions.

Constructor Summary

Constructors

Constructor

Description

BGPPeer(BGPTableTypeRegistryConsumer tableTypeRegistry, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone neighborAddress, String peerGroupName, RIB rib, PeerRole role, ClusterIdentifier clusterId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber localAs, org.opendaylight.mdsal.binding.api.RpcProviderService rpcRegistry, Set<TablesKey> afiSafisAdvertized, Set<TablesKey> afiSafisGracefulAdvertized, Map<TablesKey,org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24> llGracefulTablesAdvertised, boolean treatAsWithdraw, BgpPeerBean bean)

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo>	close()	Close Peers and performs asynchronously DS clean up.
final BGPAfiSafiState	getBGPAfiSafiState()	Afi Safi Operational State.
final BGPErrorHandlingState	getBGPErrorHandlingState()	Error Handling State.
BGPSessionState	getBGPSessionState()	BGP Session Operational State.
BGPTimersState	getBGPTimersState()	BGP Operation Timers State.
BGPTransportState	getBGPTransportState()	BGP Operational Transport State.
final ClusterIdentifier	getClusterId()	Returns Cluster Id.
final ClusterIdentifier	getFromClusterId()	Peer id of Peer route entry announcer.
final PeerId	getFromPeerId()	Peer id of Peer route entry announcer.
final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber	getFromPeerLocalAs()	Peer local AS of route entry announcer.
final PeerRole	getFromPeerRole()	Peer id of Peer route entry announcer.
final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber	getLocalAs()	Returns Local AS.
List<RouteTarget>	getMemberships()	Returns the list of RouteTargets advertized per Peer.
final String	getName()	Return peer's symbolic name.
final PeerId	getPeerId()	Returns Peer id.
int	getPeerRestartTime()	The period of time (advertised by the peer) that the peer expects a restart of a BGP session to take.
final @NonNull BGPPeerState	getPeerState()	Returns Peer Operational State.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	getRibOutIId(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates tablekey)	Creates Table Adj Rib Out Instance identifier.
final PeerRole	getRole()	Returns Peer Role.
SendReceive	getSupportedAddPathTables(TablesKey tableKey)	Returns AddPath support configuration if supported, otherwise null.
final void	initializeRibOut(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes> routesToStore)	Stores under peers rib Out already present routes, before proceed to process any new route advertizement.
void	instantiateServiceInstance()
boolean	isLocalRestarting()	This flag indicates whether the local neighbor is currently restarting.
boolean	isPeerRestarting()	This flag indicates whether the remote neighbor is currently in the process of restarting, and hence received routes are currently stale.
void	markUptodate(TablesKey tablesKey)	Marks synchronization finished for given Table key.
void	onFailure(Throwable cause)
void	onMessage(BGPSession session, org.opendaylight.yangtools.binding.Notification<?> msg)	Fired when a normal protocol message is received.
void	onSessionDown(BGPSession session, Exception exc)	Fired when the session went down because of an IO error.
void	onSessionTerminated(BGPSession session, BGPTerminationReason cause)	Fired when the session is terminated locally.
void	onSessionUp(BGPSession session)	Fired when the session was established successfully.
final void	onSuccess(org.opendaylight.yangtools.yang.common.Empty value)
final void	reEvaluateAdvertizement(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes> routesToStore)	Applies all policies through all present routes, and advertize/withdraws based on new results.
final void	refreshRibOut(RouteEntryDependenciesContainer entryDep, List<StaleBestPathRoute> staleRoutes, List<AdvertizedRoute> newRoutes)	Update peers ribout after path selection processing.
com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo>	releaseConnection()	Release Peer session.
com.google.common.util.concurrent.ListenableFuture<?>	restartGracefully(long selectionDeferralTimerSeconds)	Perform graceful restart.
boolean	supportsTable(TablesKey tableKey)	Returns true if we have advertized support for a table, i.e.
String	toString()

Methods inherited from class org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl

getAfiSafisAdvertized, getAfiSafisReceived, getBGPGracelfulRestart, getBGPPeerMessagesState, getErroneousUpdateReceivedCount, getGroupId, getLlGracefulRestartTimer, getMode, getNeighborAddress, getNotificationMessagesReceivedCount, getNotificationMessagesSentCount, getPrefixesInstalledCount, getPrefixesReceivedCount, getPrefixesSentCount, getTotalPrefixes, getUpdateMessagesReceivedCount, getUpdateMessagesSentCount, isActive, isAfiSafiSupported, isGracefulRestartAdvertized, isGracefulRestartReceived, isLlGracefulRestartAdvertised, isLlGracefulRestartReceived, messageReceived, messageSent, registerPrefixesCounters, registerPrefixesSentCounter, setActive, setAdvertizedGracefulRestartTableTypes, setAdvertizedLlGracefulRestartTableTypes

Methods inherited from class org.opendaylight.protocol.bgp.rib.DefaultRibReference

getInstanceIdentifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState

getTotalPathsCount

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

supportsAddPathSupported

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

getInstanceIdentifier

Constructor Details

BGPPeer

public BGPPeer(BGPTableTypeRegistryConsumer tableTypeRegistry,
 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone neighborAddress,
 String peerGroupName,
 RIB rib,
 PeerRole role,
 ClusterIdentifier clusterId,
 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber localAs,
 org.opendaylight.mdsal.binding.api.RpcProviderService rpcRegistry,
 Set<TablesKey> afiSafisAdvertized,
 Set<TablesKey> afiSafisGracefulAdvertized,
 Map<TablesKey,org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24> llGracefulTablesAdvertised,
 boolean treatAsWithdraw,
 BgpPeerBean bean)

Method Details

isLocalRestarting

public boolean isLocalRestarting()

Description copied from interface: BGPGracelfulRestartState

This flag indicates whether the local neighbor is currently restarting.

Specified by:

isLocalRestarting in interface BGPGracelfulRestartState

Returns:

local restarting state

isPeerRestarting

public boolean isPeerRestarting()

Description copied from interface: BGPGracelfulRestartState

This flag indicates whether the remote neighbor is currently in the process of restarting, and hence received routes are currently stale.

Specified by:

isPeerRestarting in interface BGPGracelfulRestartState

Returns:

peer is restarting

getPeerRestartTime

public int getPeerRestartTime()

Description copied from interface: BGPGracelfulRestartState

The period of time (advertised by the peer) that the peer expects a restart of a BGP session to take.

Specified by:

getPeerRestartTime in interface BGPGracelfulRestartState

Returns:

time

instantiateServiceInstance

public void instantiateServiceInstance()

close

public com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo> close()

Description copied from interface: Peer

Close Peers and performs asynchronously DS clean up.

Specified by:

close in interface Peer

Returns:

future

onMessage

public void onMessage(BGPSession session,
 org.opendaylight.yangtools.binding.Notification<?> msg)
               throws BGPDocumentedException

Description copied from interface: BGPSessionListener

Fired when a normal protocol message is received.

Specified by:

onMessage in interface BGPSessionListener

Parameters:

msg - Protocol message

Throws:

BGPDocumentedException

onSessionUp

public void onSessionUp(BGPSession session)

Description copied from interface: BGPSessionListener

Fired when the session was established successfully.

Specified by:

onSessionUp in interface BGPSessionListener

Parameters:

session - Peer address families which we accepted

onSessionDown

public void onSessionDown(BGPSession session,
 Exception exc)

Description copied from interface: BGPSessionListener

Fired when the session went down because of an IO error. Implementation should take care of closing underlying session.

Specified by:

onSessionDown in interface BGPSessionListener

Parameters:

session - that went down

exc - Exception that was thrown as the cause of session being down

onSessionTerminated

public void onSessionTerminated(BGPSession session,
 BGPTerminationReason cause)

Description copied from interface: BGPSessionListener

Fired when the session is terminated locally. The session has already been closed and transitioned to IDLE state. Any outstanding queued messages were not sent. The user should not attempt to make any use of the session.

Specified by:

onSessionTerminated in interface BGPSessionListener

Parameters:

cause - the cause why the session went down

toString

public String toString()

Overrides:

toString in class Object

releaseConnection

public com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo> releaseConnection()

Description copied from interface: PeerRPCs

Release Peer session.

Specified by:

releaseConnection in interface PeerRPCs

getSupportedAddPathTables

public SendReceive getSupportedAddPathTables(TablesKey tableKey)

Description copied from interface: PeerTrackerInformation

Returns AddPath support configuration if supported, otherwise null.

Specified by:

getSupportedAddPathTables in interface PeerTrackerInformation

Parameters:

tableKey - table

Returns:

AddPath support configuration if supported, otherwise null

supportsTable

public boolean supportsTable(TablesKey tableKey)

Description copied from interface: PeerTrackerInformation

Returns true if we have advertized support for a table, i.e. any prefix from this table should be subject to export towards the peer.

Specified by:

supportsTable in interface PeerTrackerInformation

Parameters:

tableKey - table

Returns:

true if the table is being advertized to the peer.

getRibOutIId

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getRibOutIId(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates tablekey)

Description copied from interface: PeerTrackerInformation

Creates Table Adj Rib Out Instance identifier.

Specified by:

getRibOutIId in interface PeerTrackerInformation

Parameters:

tablekey - table key

Returns:

instance identifier.

onFailure

public void onFailure(Throwable cause)

Specified by:

onFailure in interface com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>

markUptodate

public void markUptodate(TablesKey tablesKey)

Description copied from interface: BGPSessionListener

Marks synchronization finished for given Table key.

Specified by:

markUptodate in interface BGPSessionListener

Parameters:

tablesKey - of the table where synchronization finished

getBGPSessionState

public BGPSessionState getBGPSessionState()

Description copied from interface: BGPPeerState

BGP Session Operational State.

Specified by:

getBGPSessionState in interface BGPPeerState

Returns:

BGPSessionState

getBGPTimersState

public BGPTimersState getBGPTimersState()

Description copied from interface: BGPPeerState

BGP Operation Timers State.

Specified by:

getBGPTimersState in interface BGPPeerState

Returns:

BGPTimersState

getBGPTransportState

public BGPTransportState getBGPTransportState()

Description copied from interface: BGPPeerState

BGP Operational Transport State.

Specified by:

getBGPTransportState in interface BGPPeerState

Returns:

BGPTransportState

getMemberships

public List<RouteTarget> getMemberships()

Description copied from interface: RouteTargetMembershipConsumer

Returns the list of RouteTargets advertized per Peer.

Specified by:

getMemberships in interface RouteTargetMembershipConsumer

Returns:

the list of RouteTargets advertized per Peer

restartGracefully

public com.google.common.util.concurrent.ListenableFuture<?> restartGracefully(long selectionDeferralTimerSeconds)

Description copied from interface: PeerRPCs

Perform graceful restart. Wait with route selection until EOR is received or selection-deferral-timer expires.

Specified by:

restartGracefully in interface PeerRPCs

Parameters:

selectionDeferralTimerSeconds - time to wait in seconds

getPeerState

public final @NonNull BGPPeerState getPeerState()

Description copied from interface: BGPPeerStateProvider

Returns Peer Operational State.

Specified by:

getPeerState in interface BGPPeerStateProvider

Returns:

BGP Peer State

getPeerId

public final PeerId getPeerId()

Description copied from interface: PeerTrackerInformation

Returns Peer id.

Specified by:

getPeerId in interface PeerTrackerInformation

Returns:

PeerID

getRole

public final PeerRole getRole()

Description copied from interface: PeerTrackerInformation

Returns Peer Role.

Specified by:

getRole in interface PeerTrackerInformation

Returns:

PeerRole

getFromPeerRole

public final PeerRole getFromPeerRole()

Description copied from interface: BGPRouteEntryImportParameters

Peer id of Peer route entry announcer.

Specified by:

getFromPeerRole in interface BGPRouteEntryImportParameters

Returns:

peer Role of announcer Peer

getFromPeerId

public final PeerId getFromPeerId()

Description copied from interface: BGPRouteEntryImportParameters

Peer id of Peer route entry announcer.

Specified by:

getFromPeerId in interface BGPRouteEntryImportParameters

Returns:

peer Id of announcer Peer

getFromClusterId

public final ClusterIdentifier getFromClusterId()

Description copied from interface: BGPRouteEntryImportParameters

Peer id of Peer route entry announcer.

Specified by:

getFromClusterId in interface BGPRouteEntryImportParameters

Returns:

peer Id of announcer Peer

onSuccess

public final void onSuccess(org.opendaylight.yangtools.yang.common.Empty value)

Specified by:

onSuccess in interface com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>

getBGPErrorHandlingState

public final BGPErrorHandlingState getBGPErrorHandlingState()

Description copied from interface: BGPPeerState

Error Handling State.

Specified by:

getBGPErrorHandlingState in interface BGPPeerState

Returns:

ErrorHandlingState

getBGPAfiSafiState

public final BGPAfiSafiState getBGPAfiSafiState()

Description copied from interface: BGPPeerState

Afi Safi Operational State.

Specified by:

getBGPAfiSafiState in interface BGPPeerState

Returns:

AfiSafiState

getFromPeerLocalAs

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

Description copied from interface: BGPRouteEntryImportParameters

Peer local AS of route entry announcer.

Specified by:

getFromPeerLocalAs in interface BGPRouteEntryImportParameters

Returns:

peer Local AS

getName

public final String getName()

Description copied from interface: Peer

Return peer's symbolic name.

Specified by:

getName in interface Peer

Returns:

symbolic name.

getClusterId

public final ClusterIdentifier getClusterId()

Description copied from interface: PeerTrackerInformation

Returns Cluster Id.

Specified by:

getClusterId in interface PeerTrackerInformation

Returns:

Cluster Id

getLocalAs

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

Description copied from interface: PeerTrackerInformation

Returns Local AS.

Specified by:

getLocalAs in interface PeerTrackerInformation

Returns:

AS

initializeRibOut

public final void initializeRibOut(RouteEntryDependenciesContainer entryDep,
 List<ActualBestPathRoutes> routesToStore)

Description copied from interface: Peer

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

Specified by:

initializeRibOut in interface Peer

Parameters:

entryDep - RouteEntryDependenciesContainer

routesToStore - routes to be advertized.

refreshRibOut

public final void refreshRibOut(RouteEntryDependenciesContainer entryDep,
 List<StaleBestPathRoute> staleRoutes,
 List<AdvertizedRoute> newRoutes)

Description copied from interface: Peer

Update peers ribout after path selection processing.

Specified by:

refreshRibOut in interface Peer

Parameters:

entryDep - RouteEntryDependenciesContainer

staleRoutes - routes to be removed.

newRoutes - routes to be advertized.

reEvaluateAdvertizement

public final void reEvaluateAdvertizement(RouteEntryDependenciesContainer entryDep,
 List<ActualBestPathRoutes> routesToStore)

Description copied from interface: Peer

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.

Specified by:

reEvaluateAdvertizement in interface Peer

Parameters:

entryDep - RouteEntryDependenciesContainer

routesToStore - routes to be updated.