etri.sdn.controller.protocol.io

Interface IOFSwitch

All Known Implementing Classes:

OFSwitchImpl

public interface IOFSwitch

This was originally written for Floodlight, but we slightly modified it to fit our implementation needs.

Author:

David Erickson (daviderickson@cs.stanford.edu), Byungjoon Lee (bjlee@etri.re.kr)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IOFSwitch.SwitchType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_FASTWILDCARDS
static java.lang.String	PROP_REQUIRES_L3_MATCH
static java.lang.String	PROP_SUPPORTS_NETMASK_TBL
static java.lang.String	PROP_SUPPORTS_OFPP_FLOOD
static java.lang.String	PROP_SUPPORTS_OFPP_TABLE
static java.lang.String	SWITCH_DESCRIPTION_DATA
static java.lang.String	SWITCH_DESCRIPTION_FUTURE
static java.lang.String	SWITCH_IS_CORE_SWITCH
static java.lang.String	SWITCH_SUPPORTS_NX_ROLE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearAllFlowMods() Clear all flowmods on this switch
void	deletePort(short portNumber) Delete a port for the switch.
void	deletePort(java.lang.String portName) Delete a port for the switch.
void	deliverFeaturesReply(int xid, org.openflow.protocol.OFFeaturesReply reply) Deliver a feature reply from switch to IOFSwitch object.
void	deliverSwitchStatistics(int xid, java.util.List<org.openflow.protocol.statistics.OFStatistics> m) deliver an switch statistics from switch to IOFSwitch object.
int	getActions() Returns switch features from features Reply
java.lang.Object	getAttribute(java.lang.String name) Set properties for switch specific behavior
java.util.Map<java.lang.Object,java.lang.Object>	getAttributes() Retrieves attributes of this switch
int	getBuffers() Returns switch features from features Reply
int	getCapabilities() Returns switch features from features Reply
java.util.Date	getConnectedSince() Retrieves the date the switch connected to this controller
Connection	getConnection()
org.openflow.protocol.statistics.OFDescriptionStatistics	getDescription() Get the OFDescriptionStatistics object.
java.util.Collection<java.lang.Short>	getEnabledPortNumbers() Get list of the port numbers of all enabled ports.
java.util.Collection<org.openflow.protocol.OFPhysicalPort>	getEnabledPorts() Get list of all enabled ports.
org.openflow.protocol.OFFeaturesReply	getFeaturesReply() query FEATURE_REPLY to the switch.
long	getId() Get the datapathId of the switch
int	getNextTransactionId() Returns the next available transaction id
org.openflow.protocol.OFPhysicalPort	getPort(short portNumber) Retrieve the port object by the port number.
org.openflow.protocol.OFPhysicalPort	getPort(java.lang.String portName) Retrieve the port object by the port name.
java.util.Map<java.lang.Short,java.lang.Long>	getPortBroadcastHits() Get the portBroadcastCacheHits
java.util.Collection<org.openflow.protocol.OFPhysicalPort>	getPorts() Get list of all ports.
IOFHandler.Role	getRole() Get the current role of the controller for the switch
java.lang.String	getStringId() Get a string version of the ID for this switch
java.util.List<org.openflow.protocol.statistics.OFStatistics>	getSwitchStatistics(org.openflow.protocol.OFStatisticsRequest req) query statistics to the switch.
byte	getTables() Returns switch features from features Reply
boolean	hasAttribute(java.lang.String name) Checks if a specific switch property exists for this switch
boolean	isActive() Check if the controller is an active controller for the switch.
boolean	isConnected() Check if the switch is still connected; Only call while holding processMessageLock
boolean	portEnabled(org.openflow.protocol.OFPhysicalPort port)
boolean	portEnabled(short portName)
boolean	portEnabled(java.lang.String portName)
java.lang.Object	removeAttribute(java.lang.String name) Set properties for switch specific behavior
void	setAttribute(java.lang.String name, java.lang.Object value) Set properties for switch specific behavior
void	setConnection(Connection conn)
void	setFeaturesReply(org.openflow.protocol.OFFeaturesReply featuresReply) Set the OFFeaturesReply message returned by the switch during initial handshake.
void	setPort(org.openflow.protocol.OFPhysicalPort port) Add or modify a switch port.
void	setSwitchProperties(org.openflow.protocol.statistics.OFDescriptionStatistics description) Set the SwitchProperties based on it's description
boolean	updateBroadcastCache(java.lang.Long entry, java.lang.Short port) Update broadcast cache

Field Detail

SWITCH_DESCRIPTION_FUTURE

static final java.lang.String SWITCH_DESCRIPTION_FUTURE

See Also:

Constant Field Values

SWITCH_DESCRIPTION_DATA

static final java.lang.String SWITCH_DESCRIPTION_DATA

See Also:

Constant Field Values

SWITCH_SUPPORTS_NX_ROLE

static final java.lang.String SWITCH_SUPPORTS_NX_ROLE

See Also:

Constant Field Values

SWITCH_IS_CORE_SWITCH

static final java.lang.String SWITCH_IS_CORE_SWITCH

See Also:

Constant Field Values

PROP_FASTWILDCARDS

static final java.lang.String PROP_FASTWILDCARDS

See Also:

Constant Field Values

PROP_REQUIRES_L3_MATCH

static final java.lang.String PROP_REQUIRES_L3_MATCH

See Also:

Constant Field Values

PROP_SUPPORTS_OFPP_TABLE

static final java.lang.String PROP_SUPPORTS_OFPP_TABLE

See Also:

Constant Field Values

PROP_SUPPORTS_OFPP_FLOOD

static final java.lang.String PROP_SUPPORTS_OFPP_FLOOD

See Also:

Constant Field Values

PROP_SUPPORTS_NETMASK_TBL

static final java.lang.String PROP_SUPPORTS_NETMASK_TBL

See Also:

Constant Field Values

Method Detail

setConnection

void setConnection(Connection conn)

getConnection

Connection getConnection()

getBuffers

int getBuffers()

Returns switch features from features Reply

Returns:

getActions

int getActions()

Returns switch features from features Reply

Returns:

getCapabilities

int getCapabilities()

Returns switch features from features Reply

Returns:

getTables

byte getTables()

Returns switch features from features Reply

Returns:

setFeaturesReply

void setFeaturesReply(org.openflow.protocol.OFFeaturesReply featuresReply)

Set the OFFeaturesReply message returned by the switch during initial handshake.

Parameters:

featuresReply -

setSwitchProperties

void setSwitchProperties(org.openflow.protocol.statistics.OFDescriptionStatistics description)

Set the SwitchProperties based on it's description

Parameters:

description -

getEnabledPorts

java.util.Collection<org.openflow.protocol.OFPhysicalPort> getEnabledPorts()

Get list of all enabled ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Returns:

Unmodifiable list of ports not backed by the underlying collection

getEnabledPortNumbers

java.util.Collection<java.lang.Short> getEnabledPortNumbers()

Get list of the port numbers of all enabled ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Returns:

Unmodifiable list of ports not backed by the underlying collection

getPort

org.openflow.protocol.OFPhysicalPort getPort(short portNumber)

Retrieve the port object by the port number. The port object is the one that reflects the port status updates that have been received, not the one from the features reply.

Parameters:

portNumber -

Returns:

port object

getPort

org.openflow.protocol.OFPhysicalPort getPort(java.lang.String portName)

Retrieve the port object by the port name. The port object is the one that reflects the port status updates that have been received, not the one from the features reply.

Parameters:

portName -

Returns:

port object

setPort

void setPort(org.openflow.protocol.OFPhysicalPort port)

Add or modify a switch port. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Parameters:

port -

deletePort

void deletePort(short portNumber)

Delete a port for the switch. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Parameters:

portNumber -

deletePort

void deletePort(java.lang.String portName)

Delete a port for the switch. This is called by the core controller code in response to a OFPortStatus message. It should not typically be called by other floodlight applications.

Parameters:

portName -

getPorts

java.util.Collection<org.openflow.protocol.OFPhysicalPort> getPorts()

Get list of all ports. This will typically be different from the list of ports in the OFFeaturesReply, since that one is a static snapshot of the ports at the time the switch connected to the controller whereas this port list also reflects the port status messages that have been received.

Returns:

Unmodifiable list of ports

portEnabled

boolean portEnabled(short portName)

Parameters:

portName -

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

portEnabled

boolean portEnabled(java.lang.String portName)

Parameters:

portNumber -

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

portEnabled

boolean portEnabled(org.openflow.protocol.OFPhysicalPort port)

Parameters:

port -

Returns:

Whether a port is enabled per latest port status message (not configured down nor link down nor in spanning tree blocking state)

getId

long getId()

Get the datapathId of the switch

Returns:

getDescription

org.openflow.protocol.statistics.OFDescriptionStatistics getDescription()

Get the OFDescriptionStatistics object.

Returns:

getStringId

java.lang.String getStringId()

Get a string version of the ID for this switch

Returns:

getAttributes

java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

Retrieves attributes of this switch

Returns:

getConnectedSince

java.util.Date getConnectedSince()

Retrieves the date the switch connected to this controller

Returns:

the date

getNextTransactionId

int getNextTransactionId()

Returns the next available transaction id

Returns:

isConnected

boolean isConnected()

Check if the switch is still connected; Only call while holding processMessageLock

Returns:

whether the switch is still disconnected

getRole

IOFHandler.Role getRole()

Get the current role of the controller for the switch

Returns:

the role of the controller

isActive

boolean isActive()

Check if the controller is an active controller for the switch. The controller is active if its role is MASTER or EQUAL.

Returns:

whether the controller is active

hasAttribute

boolean hasAttribute(java.lang.String name)

Checks if a specific switch property exists for this switch

Parameters:

name - name of property

Returns:

value for name

getAttribute

java.lang.Object getAttribute(java.lang.String name)

Set properties for switch specific behavior

Parameters:

name - name of property

Returns:

value for name

setAttribute

void setAttribute(java.lang.String name,
                java.lang.Object value)

Set properties for switch specific behavior

Parameters:

name - name of property

value - value for name

removeAttribute

java.lang.Object removeAttribute(java.lang.String name)

Set properties for switch specific behavior

Parameters:

name - name of property

Returns:

current value for name or null (if not present)

clearAllFlowMods

boolean clearAllFlowMods()

Clear all flowmods on this switch

Returns:

updateBroadcastCache

boolean updateBroadcastCache(java.lang.Long entry,
                           java.lang.Short port)

Update broadcast cache

Parameters:

data -

Returns:

true if there is a cache hit false if there is no cache hit.

getPortBroadcastHits

java.util.Map<java.lang.Short,java.lang.Long> getPortBroadcastHits()

Get the portBroadcastCacheHits

Returns:

getSwitchStatistics

java.util.List<org.openflow.protocol.statistics.OFStatistics> getSwitchStatistics(org.openflow.protocol.OFStatisticsRequest req)

query statistics to the switch.

Parameters:

req -

Returns:

deliverSwitchStatistics

void deliverSwitchStatistics(int xid,
                           java.util.List<org.openflow.protocol.statistics.OFStatistics> m)

deliver an switch statistics from switch to IOFSwitch object.

Parameters:

xid -

m - OFStatistics objects

getFeaturesReply

org.openflow.protocol.OFFeaturesReply getFeaturesReply()

query FEATURE_REPLY to the switch.

Returns:

deliverFeaturesReply

void deliverFeaturesReply(int xid,
                        org.openflow.protocol.OFFeaturesReply reply)

Deliver a feature reply from switch to IOFSwitch object.

Parameters:

xid -

reply -