* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.protocol.bgp.rib.spi.state;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.protocol.bgp.rib.RibReference;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone;
/**
- * Representing operational state related to a particular BGP neighbor
+ * 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
*/
public interface BGPPeerState extends RibReference {
/**
- * PeerGroup Id
+ * Indicates whether this instance is being actively managed and updated.
+ *
+ * @return active
+ */
+ boolean isActive();
+
+ /**
+ * PeerGroup Id.
*
* @return PeerGroup Id
*/
- @Nullable
- String getGroupId();
+ @Nullable String getGroupId();
/**
- * Return Neighbor Key/Address
+ * Return Neighbor Key/Address.
*
* @return neighbor Address
*/
- @Nonnull
- IpAddress getNeighborAddress();
+ @NonNull IpAddressNoZone getNeighborAddress();
/**
- * Paths installed under Effective-Rib-In for a BGP neighbor
+ * 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
*
}
/**
- * Prefixes installed under Effective-Rib-In for a BGP neighbor
+ * Prefixes installed under Effective-Rib-In for a BGP neighbor.
*
* @return Paths counter
*/
long getTotalPrefixes();
/**
- * Error Handling State
+ * Error Handling State.
+ *
* @return ErrorHandlingState
*/
- @Nonnull
- BGPErrorHandlingState getBGPErrorHandlingState();
+ @NonNull BGPErrorHandlingState getBGPErrorHandlingState();
/**
- * Afi Safi Operational State
+ * Afi Safi Operational State.
+ *
* @return AfiSafiState
*/
- @Nonnull
- BGPAfiSafiState getBGPAfiSafiState();
+ @NonNull BGPAfiSafiState getBGPAfiSafiState();
/**
- * BGP Session Operational State
+ * BGP Session Operational State.
+ *
* @return BGPSessionState
*/
@Nullable BGPSessionState getBGPSessionState();
/**
- * BGP Message Operational State
+ * BGP Message Operational State.
+ *
* @return BGPPeerMessagesState
*/
@Nullable BGPPeerMessagesState getBGPPeerMessagesState();
/**
- * BGP Operation Timers State
+ * BGP Operation Timers State.
+ *
* @return BGPTimersState
*/
@Nullable BGPTimersState getBGPTimersState();
/**
- * BGP Operational Transport State
+ * BGP Operational Transport State.
+ *
* @return BGPTransportState
*/
@Nullable BGPTransportState getBGPTransportState();
/**
- * BGP Operational GracelfulRestart State
+ * BGP Operational GracelfulRestart State.
+ *
* @return BGPGracelfulRestartState
*/
- @Nonnull
- BGPGracelfulRestartState getBGPGracelfulRestart();
+ @NonNull BGPGracelfulRestartState getBGPGracelfulRestart();
}