net.onrc.openvirtex.elements.datapath

Class Switch<T extends Port>

java.lang.Object

net.onrc.openvirtex.elements.datapath.Switch<T>

Type Parameters:

T - generic type (Port) that is casted in the subclasses

All Implemented Interfaces:

OVXEventHandler, OVXSendMsg

Direct Known Subclasses:

OVXSwitch, PhysicalSwitch

public abstract class Switch<T extends Port>
extends Object
implements OVXEventHandler, OVXSendMsg

The Class Switch.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.netty.channel.Channel	channel
static String	DB_KEY
protected OVXDescriptionStatistics	desc
protected OFFeaturesReply	featuresReply The features reply message.
protected boolean	isConnected
protected Mappable	map
protected HashMap<Short,T>	portMap The port map.
protected Long	switchId The switch id (DPID).
protected String	switchName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Switch(Long switchId) Instantiates a new switch (should be never used).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addPort(T port) Adds the port.
abstract boolean	boot() Starts up the switch.
OFFeaturesReply	getFeaturesReply() Gets the switch info.
Mappable	getMap()
String	getName()
T	getPort(Short portNumber) Gets the port.
Map<Short,T>	getPorts() Returns an unmodifiable copy of the port map.
Long	getSwitchId() Gets the switch id.
String	getSwitchName() Gets the switch name.
abstract void	handleIO(OFMessage msg, org.jboss.netty.channel.Channel channel)
abstract void	handleRoleIO(OFVendor msg, org.jboss.netty.channel.Channel channel)
abstract void	removeChannel(org.jboss.netty.channel.Channel channel)
boolean	removePort(Short portNumber) Removes the port.
void	setChannel(org.jboss.netty.channel.Channel channel) Sets the channel.
void	setConnected(boolean isConnected) Sets the connected.
void	setDescriptionStats(OVXDescriptionStatistics description) Sets the description stats.
void	setFeaturesReply(OFFeaturesReply m) Sets the features reply.
abstract void	tearDown() Tear down.
String	toString()
abstract void	unregister() Removes the switch from the network representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.onrc.openvirtex.core.io.OVXSendMsg

sendMsg

Field Detail

DB_KEY

public static final String DB_KEY

See Also:

Constant Field Values

isConnected

protected boolean isConnected

channel

protected org.jboss.netty.channel.Channel channel

desc

protected OVXDescriptionStatistics desc

switchName

protected String switchName

map

protected Mappable map

portMap

protected HashMap<Short,T extends Port> portMap

The port map. Associate all the port instances with the switch. The port number is the key.

featuresReply

protected OFFeaturesReply featuresReply

The features reply message.

switchId

protected Long switchId

The switch id (DPID).

Constructor Detail

Switch

protected Switch(Long switchId)

Instantiates a new switch (should be never used).

Parameters:

switchId - the switchId (long) that represent the DPID

map - reference to the OVXMap

Method Detail

getSwitchName

public String getSwitchName()

Gets the switch name.

Returns:

a user-friendly String that map the switch DPID

getMap

public Mappable getMap()

getFeaturesReply

public OFFeaturesReply getFeaturesReply()

Gets the switch info.

Returns:

the switch info

setFeaturesReply

public void setFeaturesReply(OFFeaturesReply m)

Sets the features reply.

Parameters:

m - the new features reply

getSwitchId

public Long getSwitchId()

Gets the switch id.

Returns:

the switch id

getPorts

public Map<Short,T> getPorts()

Returns an unmodifiable copy of the port map.

getPort

public T getPort(Short portNumber)

Gets the port.

Parameters:

portNumber - the port number

Returns:

the port instance

addPort

public boolean addPort(T port)

Adds the port. If the port is already present then no action is performed.

Parameters:

port - the port instance

Returns:

true, if successful

removePort

public boolean removePort(Short portNumber)

Removes the port.

Parameters:

portNumber - the port number

Returns:

true, if successful

handleIO

public abstract void handleIO(OFMessage msg,
            org.jboss.netty.channel.Channel channel)

Specified by:

handleIO in interface OVXEventHandler

handleRoleIO

public abstract void handleRoleIO(OFVendor msg,
                org.jboss.netty.channel.Channel channel)

setConnected

public void setConnected(boolean isConnected)

Sets the connected.

Parameters:

isConnected - the new connected

setChannel

public void setChannel(org.jboss.netty.channel.Channel channel)

Sets the channel.

Parameters:

channel - the new channel

boot

public abstract boolean boot()

Starts up the switch.

Returns:

true upon success startup.

unregister

public abstract void unregister()

Removes the switch from the network representation. Removal may be triggered by an API call (in the case of a OVXSwitch) or disconnection of a switch connected to us (in the case of a PhysicalSwitch).

tearDown

public abstract void tearDown()

Tear down.

setDescriptionStats

public void setDescriptionStats(OVXDescriptionStatistics description)

Sets the description stats.

Parameters:

description - the new description stats

getName

public String getName()

Specified by:

getName in interface OVXSendMsg

toString

public String toString()

Overrides:

toString in class Object

removeChannel

public abstract void removeChannel(org.jboss.netty.channel.Channel channel)