DataPathInfo (sdn-apidoc 2.5.14 API)

All Known Subinterfaces:

DataPathDetails

All Known Implementing Classes:

DataPathInfoAdapter
```
public interface DataPathInfo
```
Represents information about an OpenFlow datapath.
This includes data from the FeaturesReply message received from the datapath during the handshake sequence.
All timestamps are measured in milliseconds since midnight, January 1, 1970 UTC. (See System.currentTimeMillis()).

Author:

Simon Hunt

Method Summary

Methods
Modifier and Type	Method and Description
`Set<Capability>`	`capabilities()` Returns the capabilities supported by the switch.
`String`	`datapathDescription()` Returns a textual description of the datapath.
`String`	`deviceTypeName()` Returns the type name of the device.
`DataPathId`	`dpid()` Returns the datapath identifier.
`String`	`hardwareDescription()` Returns a description of the hardware.
`long`	`lastMessageAt()` Returns the time of the last message received from the datapath (on any connection).
`String`	`manufacturerDescription()` Returns a description of the manufacturer.
`ProtocolVersion`	`negotiated()` Returns the version of the OpenFlow protocol that the datapath has negotiated with the controller, via the exchange of Hello messages (on the "main" connection).
`long`	`numBuffers()` Returns the maximum number of packets the switch can buffer at once.
`int`	`numTables()` Returns the number of tables supported by the switch.
`List<Port>`	`ports()` Returns the current known state of all the OpenFlow ports on the datapath.
`long`	`readyAt()` Returns the time at which the datapath completed the handshake with the controller (on the "main" connection).
`IpAddress`	`remoteAddress()` Returns the IP address of the switch (on the "main" connection).
`PortNumber`	`remotePort()` Returns the TCP port for the switch's "main" connection.
`String`	`serialNumber()` Returns the serial number.
`String`	`softwareDescription()` Returns a description of the software.

- Method Detail
  - dpid
```
DataPathId dpid()
```
    Returns the datapath identifier.
    
    Returns:
    the datapath ID
  - negotiated
```
ProtocolVersion negotiated()
```
    Returns the version of the OpenFlow protocol that the datapath has negotiated with the controller, via the exchange of Hello messages (on the "main" connection).
    
    Returns:
    the negotiated protocol version
  - readyAt
```
long readyAt()
```
    Returns the time at which the datapath completed the handshake with the controller (on the "main" connection).
    
    Returns:
    the "datapath ready" timestamp
  - lastMessageAt
```
long lastMessageAt()
```
    Returns the time of the last message received from the datapath (on any connection).
    
    Returns:
    the "last message" timestamp
  - ports
```
List<Port> ports()
```
    Returns the current known state of all the OpenFlow ports on the datapath. This method is guaranteed to always return a list.
    
    Returns:
    the known state of the ports
  - numBuffers
```
long numBuffers()
```
    Returns the maximum number of packets the switch can buffer at once.
    
    Returns:
    the number of packet buffers
  - numTables
```
int numTables()
```
    Returns the number of tables supported by the switch.
    
    Returns:
    the number of tables
  - capabilities
```
Set<Capability> capabilities()
```
    Returns the capabilities supported by the switch.
    
    Returns:
    the set of capabilities
  - remoteAddress
```
IpAddress remoteAddress()
```
    Returns the IP address of the switch (on the "main" connection).
    
    Returns:
    the switch IP address
  - remotePort
```
PortNumber remotePort()
```
    Returns the TCP port for the switch's "main" connection.
    
    Returns:
    the switch TCP port
  - datapathDescription
```
String datapathDescription()
```
    Returns a textual description of the datapath.
    
    Returns:
    the datapath description
  - manufacturerDescription
```
String manufacturerDescription()
```
    Returns a description of the manufacturer.
    
    Returns:
    the manufacturer description
  - hardwareDescription
```
String hardwareDescription()
```
    Returns a description of the hardware.
    
    Returns:
    the hardware description
  - softwareDescription
```
String softwareDescription()
```
    Returns a description of the software.
    
    Returns:
    the software description
  - serialNumber
```
String serialNumber()
```
    Returns the serial number.
    
    Returns:
    the serial number
  - deviceTypeName
```
String deviceTypeName()
```
    Returns the type name of the device. This is used as a key to look up appropriate implementations in the device driver subsystem.
    
    Returns:
    the device type name

Interface DataPathInfo

Method Summary

Method Detail

dpid

negotiated

readyAt

lastMessageAt

ports

numBuffers

numTables

capabilities

remoteAddress

remotePort

datapathDescription

manufacturerDescription

hardwareDescription

softwareDescription

serialNumber

deviceTypeName