An interface for a Controller of OpenFlowSwitchNetDevices. More...

#include <openflow-interface.h>

Inheritance diagram for ns3::ofi::Controller:

Collaboration diagram for ns3::ofi::Controller:

Public Member Functions
virtual	~Controller ()

virtual void	AddSwitch (Ptr< OpenFlowSwitchNetDevice > swtch)

virtual void	ReceiveFromSwitch (Ptr< OpenFlowSwitchNetDevice > swtch, ofpbuf *buffer)

void	StartDump (StatsDumpCallback *cb)
	Starts a callback-based, reliable, possibly multi-message reply to a request made by the controller. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()

	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Protected Types
typedef std::set< Ptr < OpenFlowSwitchNetDevice > >	Switches_t

Protected Member Functions
ofp_flow_mod *	BuildFlow (sw_flow_key key, uint32_t buffer_id, uint16_t command, void *acts, size_t actions_len, int idle_timeout, int hard_timeout)

uint8_t	GetPacketType (ofpbuf *buffer)

virtual void	SendToSwitch (Ptr< OpenFlowSwitchNetDevice > swtch, void *msg, size_t length)

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoDispose (void)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Protected Attributes
Switches_t	m_switches
	The collection of switches registered to this controller. More...

Detailed Description

An interface for a Controller of OpenFlowSwitchNetDevices.

Follows the OpenFlow specification for a controller.

Definition at line 346 of file openflow-interface.h.

Member Typedef Documentation

typedef std::set<Ptr<OpenFlowSwitchNetDevice> > ns3::ofi::Controller::Switches_t

protected

Definition at line 440 of file openflow-interface.h.

Constructor & Destructor Documentation

virtual ns3::ofi::Controller::~Controller ( )

inlinevirtual

Definition at line 358 of file openflow-interface.h.

References m_switches.

Member Function Documentation

virtual void ns3::ofi::Controller::AddSwitch ( Ptr< OpenFlowSwitchNetDevice > swtch )

virtual

Adds a switch to the controller.

Parameters

swtch The switch to register.

ofp_flow_mod* ns3::ofi::Controller::BuildFlow	(	sw_flow_key	key,
		uint32_t	buffer_id,
		uint16_t	command,
		void *	acts,
		size_t	actions_len,
		int	idle_timeout,
		int	hard_timeout
	)

protected

Internal:

Construct flow data from a matching key to build a flow entry for adding, modifying, or deleting a flow.

Parameters

key	The matching key data; used to create a flow that matches the packet.
buffer_id	The OpenFlow Buffer ID; used to run the actions on the packet if we add or modify the flow.
command	Whether to add, modify, or delete this flow.
acts	List of actions to execute.
actions_len	Length of the actions buffer.
idle_timeout	Flow expires if left inactive for this amount of time (specify OFP_FLOW_PERMANENT to disable feature).
hard_timeout	Flow expires after this amount of time (specify OFP_FLOW_PERMANENT to disable feature).

Returns: Flow data that when passed to SetFlow will add, modify, or delete a flow it defines.

uint8_t ns3::ofi::Controller::GetPacketType ( ofpbuf * buffer )

protected

Internal:

Get the packet type on the buffer, which can then be used to determine how to handle the buffer.

Parameters

buffer The packet in OpenFlow buffer format.

Returns: The packet type, as defined in the ofp_type struct.

static TypeId ns3::ofi::Controller::GetTypeId ( void )

inlinestatic

Definition at line 349 of file openflow-interface.h.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

virtual void ns3::ofi::Controller::ReceiveFromSwitch	(	Ptr< OpenFlowSwitchNetDevice >	swtch,
		ofpbuf *	buffer
	)

inlinevirtual

A switch calls this method to pass a message on to the Controller.

Parameters

swtch	The switch the message was received from.
buffer	The message.

Reimplemented in ns3::ofi::LearningController, and ns3::ofi::DropController.

Definition at line 376 of file openflow-interface.h.

virtual void ns3::ofi::Controller::SendToSwitch	(	Ptr< OpenFlowSwitchNetDevice >	swtch,
		void *	msg,
		size_t	length
	)

protectedvirtual

Internal:

However the controller is implemented, this method is to be used to pass a message on to a switch.

Parameters

swtch	The switch to receive the message.
msg	The message to send.
length	The length of the message.

void ns3::ofi::Controller::StartDump ( StatsDumpCallback * cb )

Starts a callback-based, reliable, possibly multi-message reply to a request made by the controller.

If an incoming request needs to have a reliable reply that might require multiple messages, it can use StartDump() to set up a callback that will be called as buffer space for replies.

A stats request made by the controller is processed by the switch, the switch then calls this method to tell the controller to start asking for information. By default (it can be overridden), the controller stops all work to run through the callback. ReceiveFromSwitch must be defined appropriately to handle the status reply messages generated by the switch, or otherwise the status reply messages will be sent and discarded.

Parameters

cb	The callback data.

Member Data Documentation

Switches_t ns3::ofi::Controller::m_switches

protected

The collection of switches registered to this controller.

Definition at line 441 of file openflow-interface.h.

Referenced by ~Controller().

The documentation for this class was generated from the following file:

src/openflow/model/openflow-interface.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation