PortStatistics (ONOS Java API (2.1.0))

All Superinterfaces:

Annotated

All Known Implementing Classes:

DefaultPortStatistics
```
public interface PortStatistics
extends Annotated
```
Statistics of a port.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Annotations`	`annotations()` Returns the key/value annotations.
`long`	`bytesReceived()` Returns the bytes received.
`long`	`bytesSent()` Returns the bytes sent.
`long`	`durationNano()` Returns the time port has been alive in nano seconds.
`long`	`durationSec()` Returns the time port has been alive in seconds.
`boolean`	`isZero()` Returns true if all the port stats are zero, excluding TxErrors and RxErrors.
`long`	`packetsReceived()` Returns the number of packets received.
`long`	`packetsRxDropped()` Returns the number of packets dropped by RX.
`long`	`packetsRxErrors()` Returns the number of transmit errors.
`long`	`packetsSent()` Returns the number of packets sent.
`long`	`packetsTxDropped()` Returns the number of packets dropped by TX.
`long`	`packetsTxErrors()` Returns the number of receive errors.
`PortNumber`	`portNumber()` Returns the port number.

- Method Detail
  - portNumber
```
PortNumber portNumber()
```
    Returns the port number.
    
    Returns:
    
    port number
  - packetsReceived
```
long packetsReceived()
```
    Returns the number of packets received.
    
    Returns:
    
    the number of packets received
  - packetsSent
```
long packetsSent()
```
    Returns the number of packets sent.
    
    Returns:
    
    the number of packets sent
  - bytesReceived
```
long bytesReceived()
```
    Returns the bytes received.
    
    Returns:
    
    the bytes received
  - bytesSent
```
long bytesSent()
```
    Returns the bytes sent.
    
    Returns:
    
    the bytes sent
  - packetsRxDropped
```
long packetsRxDropped()
```
    Returns the number of packets dropped by RX.
    
    Returns:
    
    the number of packets dropped by RX
  - packetsTxDropped
```
long packetsTxDropped()
```
    Returns the number of packets dropped by TX.
    
    Returns:
    
    the number of packets dropped by TX
  - packetsRxErrors
```
long packetsRxErrors()
```
    Returns the number of transmit errors.
    
    Returns:
    
    the number of transmit errors
  - packetsTxErrors
```
long packetsTxErrors()
```
    Returns the number of receive errors.
    
    Returns:
    
    the number of receive error
  - durationSec
```
long durationSec()
```
    Returns the time port has been alive in seconds.
    
    Returns:
    
    the time port has been alive in seconds
  - durationNano
```
long durationNano()
```
    Returns the time port has been alive in nano seconds.
    
    Returns:
    
    the time port has been alive in nano seconds
  - annotations
```
default Annotations annotations()
```
    Description copied from interface: Annotated
    
    Returns the key/value annotations.
    
    Specified by:
    
    annotations in interface Annotated
    
    Returns:
    
    key/value annotations
  - isZero
```
boolean isZero()
```
    Returns true if all the port stats are zero, excluding TxErrors and RxErrors.
    
    Returns:
    
    boolean true if all port stats are zero

Interface PortStatistics

Method Summary

Method Detail

portNumber

packetsReceived

packetsSent

bytesReceived

bytesSent

packetsRxDropped

packetsTxDropped

packetsRxErrors

packetsTxErrors

durationSec

durationNano

annotations

isZero