A Discrete-Event Network Simulator
API
ns3::ofi::Controller Class Reference

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 ()
 Destructor. More...
 
virtual void AddSwitch (Ptr< OpenFlowSwitchNetDevice > swtch)
 Adds a switch to the controller. More...
 
virtual void ReceiveFromSwitch (Ptr< OpenFlowSwitchNetDevice > swtch, ofpbuf *buffer)
 A switch calls this method to pass a message on to the Controller. More...
 
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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Types

typedef std::set< Ptr< OpenFlowSwitchNetDevice > > Switches_t
 OpenFlowSwitchNetDevice container type. More...
 

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)
 Construct flow data from a matching key to build a flow entry for adding, modifying, or deleting a flow. More...
 
uint8_t GetPacketType (ofpbuf *buffer)
 Get the packet type on the buffer, which can then be used to determine how to handle the buffer. More...
 
virtual void SendToSwitch (Ptr< OpenFlowSwitchNetDevice > swtch, void *msg, size_t length)
 However the controller is implemented, this method is to be used to pass a message on to a switch. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

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

Additional Inherited Members

Detailed Description

An interface for a Controller of OpenFlowSwitchNetDevices.

Follows the OpenFlow specification for a controller.

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

Member Typedef Documentation

◆ Switches_t

OpenFlowSwitchNetDevice container type.

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

Constructor & Destructor Documentation

◆ ~Controller()

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

Destructor.

Member Function Documentation

◆ AddSwitch()

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

Adds a switch to the controller.

Parameters
swtchThe switch to register.

◆ BuildFlow()

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

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

Parameters
keyThe matching key data; used to create a flow that matches the packet.
buffer_idThe OpenFlow Buffer ID; used to run the actions on the packet if we add or modify the flow.
commandWhether to add, modify, or delete this flow.
actsList of actions to execute.
actions_lenLength of the actions buffer.
idle_timeoutFlow expires if left inactive for this amount of time (specify OFP_FLOW_PERMANENT to disable feature).
hard_timeoutFlow 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.

◆ GetPacketType()

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

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

Parameters
bufferThe packet in OpenFlow buffer format.
Returns
The packet type, as defined in the ofp_type struct.

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

◆ ReceiveFromSwitch()

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
swtchThe switch the message was received from.
bufferThe message.

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

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

◆ SendToSwitch()

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

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

Parameters
swtchThe switch to receive the message.
msgThe message to send.
lengthThe length of the message.

◆ StartDump()

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
cbThe callback data.

Member Data Documentation

◆ m_switches

Switches_t ns3::ofi::Controller::m_switches
protected

The collection of switches registered to this controller.

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


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