org.onosproject.openflow.controller

Interface OpenFlowSwitch

All Known Subinterfaces:

OpenFlowOpticalSwitch, OpenFlowSwitchDriver

All Known Implementing Classes:

AbstractOpenFlowSwitch, CalientFiberSwitchHandshaker, DefaultSwitchHandshaker, NiciraSwitchHandshaker, OFOpticalSwitch13, OfOpticalSwitchImplLinc13, OplinkRoadm

public interface OpenFlowSwitch

Represents to provider facing side of a switch.

Method Summary

Modifier and Type	Method and Description
String	channelId() Identifies the channel used to communicate with the switch.
String	datapathDescription() fetch the datapath description.
org.onosproject.net.Device.Type	deviceType() Returns the switch device type.
void	disconnectSwitch() Disconnects the switch by closing the TCP connection.
org.projectfloodlight.openflow.protocol.OFFactory	factory() Provides the factory for this OF version.
long	getId() Gets the datapathId of the switch.
List<org.projectfloodlight.openflow.protocol.OFPortDesc>	getPorts() Fetches the ports of this switch.
RoleState	getRole() Fetch the role for this switch.
String	getStringId() Gets a string version of the ID for this switch.
void	handleMessage(org.projectfloodlight.openflow.protocol.OFMessage fromSwitch) Handle a message from the switch.
String	hardwareDescription() fetch the hardware description.
boolean	isConnected() Checks if the switch is still connected.
String	manufacturerDescription() fetch the manufacturer description.
void	returnRoleReply(RoleState requested, RoleState response) Notifies the controller that the device has responded to a set-role request.
void	sendMsg(List<org.projectfloodlight.openflow.protocol.OFMessage> msgs) Writes the OFMessage list to the driver.
void	sendMsg(org.projectfloodlight.openflow.protocol.OFMessage msg) Writes the message to the driver.
String	serialNumber() fetch the serial number.
void	setRole(RoleState role) Sets the role for this switch.
String	softwareDescription() fetch the software description.

Method Detail

sendMsg

void sendMsg(org.projectfloodlight.openflow.protocol.OFMessage msg)

Writes the message to the driver.

Note: Messages may be silently dropped/lost due to IOExceptions or role. If this is a concern, then a caller should use barriers.

Parameters:

msg - the message to write

sendMsg

void sendMsg(List<org.projectfloodlight.openflow.protocol.OFMessage> msgs)

Writes the OFMessage list to the driver.

Note: Messages may be silently dropped/lost due to IOExceptions or role. If this is a concern, then a caller should use barriers.

Parameters:

msgs - the messages to be written

handleMessage

void handleMessage(org.projectfloodlight.openflow.protocol.OFMessage fromSwitch)

Handle a message from the switch.

Parameters:

fromSwitch - the message to handle

setRole

void setRole(RoleState role)

Sets the role for this switch.

Parameters:

role - the role to set.

getRole

RoleState getRole()

Fetch the role for this switch.

Returns:

the role.

getPorts

List<org.projectfloodlight.openflow.protocol.OFPortDesc> getPorts()

Fetches the ports of this switch.

Returns:

unmodifiable list of the ports.

factory

org.projectfloodlight.openflow.protocol.OFFactory factory()

Provides the factory for this OF version.

Returns:

OF version specific factory.

getStringId

String getStringId()

Gets a string version of the ID for this switch.

Returns:

string version of the ID

getId

long getId()

Gets the datapathId of the switch.

Returns:

the switch dpid in long format

manufacturerDescription

String manufacturerDescription()

fetch the manufacturer description.

Returns:

the description

datapathDescription

String datapathDescription()

fetch the datapath description.

Returns:

the description

hardwareDescription

String hardwareDescription()

fetch the hardware description.

Returns:

the description

softwareDescription

String softwareDescription()

fetch the software description.

Returns:

the description

serialNumber

String serialNumber()

fetch the serial number.

Returns:

the serial

isConnected

boolean isConnected()

Checks if the switch is still connected.

Returns:

whether the switch is still connected

disconnectSwitch

void disconnectSwitch()

Disconnects the switch by closing the TCP connection. Results in a call to the channel handler's channelDisconnected method for cleanup

returnRoleReply

void returnRoleReply(RoleState requested,
                     RoleState response)

Notifies the controller that the device has responded to a set-role request.

Parameters:

requested - the role requested by the controller

response - the role set at the device

deviceType

org.onosproject.net.Device.Type deviceType()

Returns the switch device type.

Returns:

device type

channelId

String channelId()

Identifies the channel used to communicate with the switch.

Returns:

string representation of the connection to the device