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
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
java.util.Date	getConnectedSince() Retrieves the date the switch connected to this controller
Connection	getConnection()
long	getId() Get the datapathId of the switch
int	getNextTransactionId() Returns the next available transaction id
java.util.Map<java.lang.Short,java.lang.Long>	getPortBroadcastHits() Get the portBroadcastCacheHits
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
byte	getVersion() Get the version of the switch
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
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	setId(long id) Set the datapath id of the switch
void	setVersion(byte version) Set the version of the switch
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()

getId

long getId()

Get the datapathId of the switch

Returns:

datapath id (long)

setId

void setId(long id)

Set the datapath id of the switch

Parameters:

id - datapath id (long)

getStringId

java.lang.String getStringId()

Get a string version of the ID for this switch

Returns:

String (string version of the datapath id)

getAttributes

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

Retrieves attributes of this switch

Returns:

Map

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:

next transaction id (int)

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)

updateBroadcastCache

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

Update broadcast cache

Parameters:

entry - Long

port - Short

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:

Map object

getVersion

byte getVersion()

Get the version of the switch

Returns:

version number (byte)

setVersion

void setVersion(byte version)

Set the version of the switch

Parameters:

version - version number (byte)