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

Interface BGPPeerState

  • All Superinterfaces:
    InstanceReference<Rib>, RibReference
    All Known Implementing Classes:
    ApplicationPeer, BGPPeer, BGPPeerStateImpl
    public interface BGPPeerState
extends RibReference
    Representing operational state related to a particular BGP neighbor. - Counters for BGP messages sent and received from the neighbor - Operational state of timers associated with the BGP neighbor - Operational state of the transport session associated with the BGP neighbor - Operational state of the error handling associated with the BGP neighbor - Operational state of graceful-restart associated with a BGP neighbor - Per-AFI-SAFI operational state and counters to the BGP neighbor - Per-AFI-SAFI operational state for BGP graceful-restart

    • Method Detail

      • isActive

        boolean isActive()
        Indicates whether this instance is being actively managed and updated.
        Returns:
        active

      • getGroupId

        @Nullable String getGroupId()
        PeerGroup Id.
        Returns:
        PeerGroup Id

      • getNeighborAddress

        @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getNeighborAddress()
        Return Neighbor Key/Address.
        Returns:
        neighbor Address

      • getTotalPathsCount

        default long getTotalPathsCount()
        Paths installed under Effective-Rib-In for a BGP neighbor. Represented per Prefixes, the cost of calculate paths per each Prefix on Effective-Rib-in is not worth at this point, check comment under incrementPrefixesInstalled
        Returns:
        Paths counter

      • getTotalPrefixes

        long getTotalPrefixes()
        Prefixes installed under Effective-Rib-In for a BGP neighbor.
        Returns:
        Paths counter

      • getBGPErrorHandlingState

        @NonNull BGPErrorHandlingState getBGPErrorHandlingState()
        Error Handling State.
        Returns:
        ErrorHandlingState

      • getBGPAfiSafiState

        @NonNull BGPAfiSafiState getBGPAfiSafiState()
        Afi Safi Operational State.
        Returns:
        AfiSafiState

      • getBGPSessionState

        @Nullable BGPSessionState getBGPSessionState()
        BGP Session Operational State.
        Returns:
        BGPSessionState

      • getBGPPeerMessagesState

        @Nullable BGPPeerMessagesState getBGPPeerMessagesState()
        BGP Message Operational State.
        Returns:
        BGPPeerMessagesState

      • getBGPTimersState

        @Nullable BGPTimersState getBGPTimersState()
        BGP Operation Timers State.
        Returns:
        BGPTimersState

      • getBGPTransportState

        @Nullable BGPTransportState getBGPTransportState()
        BGP Operational Transport State.
        Returns:
        BGPTransportState

      • getBGPGracelfulRestart

        @NonNull BGPGracelfulRestartState getBGPGracelfulRestart()
        BGP Operational GracelfulRestart State.
        Returns:
        BGPGracelfulRestartState