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:

EventListener, org.opendaylight.controller.config.api.runtime.RuntimeBean, BGPPeerRuntimeMXBean, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener, BGPMessagesListener, RibReference, BGPSessionListener, Peer, BGPAfiSafiState, BGPErrorHandlingState, BGPGracelfulRestartState, BGPPeerMessagesState, BGPPeerState, BGPPeerStateConsumer, InstanceReference<Rib>

public class BGPPeer
extends BGPPeerStateImpl
implements BGPSessionListener, Peer, BGPPeerRuntimeMXBean, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

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 and Description
BGPPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress, RIB rib, PeerRole role, org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry, Set<TablesKey> afiSafisAdvertized, Set<TablesKey> afiSafisGracefulAdvertized)
BGPPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress, RIB rib, PeerRole role, SimpleRoutingPolicy peerStatus, org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry, Set<TablesKey> afiSafisAdvertized, Set<TablesKey> afiSafisGracefulAdvertized)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.MoreObjects.ToStringHelper	addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper)
com.google.common.util.concurrent.ListenableFuture<Void>	close() Close Peers and performs asynchronously DS clean up
BGPAfiSafiState	getBGPAfiSafiState() Afi Safi Operational State
BGPErrorHandlingState	getBGPErrorHandlingState() Error Handling State
BgpPeerState	getBgpPeerState()
BgpSessionState	getBgpSessionState()
BGPSessionState	getBGPSessionState() BGP Session Operational State
BGPTimersState	getBGPTimersState() BGP Operation Timers State
BGPTransportState	getBGPTransportState() BGP Operational Transport State
String	getName() Return peer's symbolic name.
byte[]	getRawIdentifier() Return the peer's BGP identifier as raw bytearray
void	instantiateServiceInstance()
void	markUptodate(TablesKey tablesKey) Marks synchronization finished for given Table key
void	onMessage(BGPSession session, org.opendaylight.yangtools.yang.binding.Notification msg) Fired when a normal protocol message is received.
void	onSessionDown(BGPSession session, Exception e) 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.
void	onTransactionChainFailed(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain, org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction<?,?> transaction, Throwable cause)
void	onTransactionChainSuccessful(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain)
com.google.common.util.concurrent.ListenableFuture<Void>	releaseConnection()
void	resetSession()
void	resetStats()
String	toString()

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

getAfiSafisAdvertized, getAfiSafisReceived, getBGPGracelfulRestart, getBGPPeerMessagesState, getErroneousUpdateReceivedCount, getGroupId, getNeighborAddress, getNotificationMessagesReceivedCount, getNotificationMessagesSentCount, getPeerRestartTime, getPeerState, getPrefixesInstalledCount, getPrefixesReceivedCount, getPrefixesSentCount, getTotalPrefixes, getUpdateMessagesReceivedCount, getUpdateMessagesSentCount, isAfiSafiSupported, isGracefulRestartAdvertized, isGracefulRestartReceived, isLocalRestarting, isPeerRestarting, messageReceived, messageSent, registerPrefixesCounters, registerPrefixesSentCounter, resetState, setAdvertizedGracefulRestartTableTypes, setAfiSafiGracefulRestartState

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.RibReference

getInstanceIdentifier

Constructor Detail

BGPPeer

public BGPPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress,
               RIB rib,
               PeerRole role,
               SimpleRoutingPolicy peerStatus,
               org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry,
               @Nonnull
               Set<TablesKey> afiSafisAdvertized,
               @Nonnull
               Set<TablesKey> afiSafisGracefulAdvertized)

BGPPeer

public BGPPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress,
               RIB rib,
               PeerRole role,
               org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry,
               @Nonnull
               Set<TablesKey> afiSafisAdvertized,
               @Nonnull
               Set<TablesKey> afiSafisGracefulAdvertized)

Method Detail

instantiateServiceInstance

public void instantiateServiceInstance()

close

public com.google.common.util.concurrent.ListenableFuture<Void> 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.yang.binding.Notification msg)
               throws BGPDocumentedException

Description copied from interface: BGPSessionListener

Fired when a normal protocol message is received.

Specified by:

onMessage in interface BGPSessionListener

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 e)

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

e - 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

cause - the cause why the session went down

toString

public String toString()

Overrides:

toString in class Object

addToStringAttributes

protected com.google.common.base.MoreObjects.ToStringHelper addToStringAttributes(com.google.common.base.MoreObjects.ToStringHelper toStringHelper)

getName

public String getName()

Description copied from interface: Peer

Return peer's symbolic name.

Specified by:

getName in interface Peer

Returns:

symbolic name.

releaseConnection

public com.google.common.util.concurrent.ListenableFuture<Void> releaseConnection()

Specified by:

releaseConnection in interface BGPSessionListener

getRawIdentifier

public byte[] getRawIdentifier()

Description copied from interface: Peer

Return the peer's BGP identifier as raw bytearray

Specified by:

getRawIdentifier in interface Peer

Returns:

byte[] raw identifier

resetSession

public void resetSession()

Specified by:

resetSession in interface BGPPeerRuntimeMXBean

resetStats

public void resetStats()

Specified by:

resetStats in interface BGPPeerRuntimeMXBean

getBgpSessionState

public BgpSessionState getBgpSessionState()

Specified by:

getBgpSessionState in interface BGPPeerRuntimeMXBean

getBgpPeerState

public BgpPeerState getBgpPeerState()

Specified by:

getBgpPeerState in interface BGPPeerRuntimeMXBean

onTransactionChainFailed

public void onTransactionChainFailed(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain,
                                     org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction<?,?> transaction,
                                     Throwable cause)

Specified by:

onTransactionChainFailed in interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

onTransactionChainSuccessful

public void onTransactionChainSuccessful(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain)

Specified by:

onTransactionChainSuccessful in interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

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

getBGPErrorHandlingState

public BGPErrorHandlingState getBGPErrorHandlingState()

Description copied from interface: BGPPeerState

Error Handling State

Specified by:

getBGPErrorHandlingState in interface BGPPeerState

Returns:

ErrorHandlingState

getBGPAfiSafiState

public BGPAfiSafiState getBGPAfiSafiState()

Description copied from interface: BGPPeerState

Afi Safi Operational State

Specified by:

getBGPAfiSafiState in interface BGPPeerState

Returns:

AfiSafiState

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