An Learning OpenFlow 1.3 controller (works as L2 switch) More...

#include "ofswitch13-learning-controller.h"

Inheritance diagram for ns3::OFSwitch13LearningController:

Collaboration diagram for ns3::OFSwitch13LearningController:

Public Member Functions
	OFSwitch13LearningController ()
	Default constructor. More...

	~OFSwitch13LearningController () override
	Dummy destructor. More...

void	DoDispose () override
	Destructor implementation. More...

ofl_err	HandleFlowRemoved (struct ofl_msg_flow_removed *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid) override
	Handle flow removed messages sent from switch to this controller. More...

ofl_err	HandlePacketIn (struct ofl_msg_packet_in *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid) override
	Handle packet-in messages sent from switch to this controller. More...

Public Member Functions inherited from ns3::OFSwitch13Controller
	OFSwitch13Controller ()
	Default constructor. More...

	~OFSwitch13Controller () override
	Dummy destructor, see DoDispose. More...

int	DpctlExecute (uint64_t dpId, const std::string textCmd)
	Execute a dpctl command to interact with the remote switch. More...

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

	~Application () override

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time. More...

void	SetStopTime (Time stop)
	Specify application stop time. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () 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< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () 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 () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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 errors. 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 ()
	Register this type. More...

Static Public Member Functions inherited from ns3::OFSwitch13Controller
static void	DpctlSendAndPrint (struct vconn vconn, struct ofl_msg_header msg)
	Overriding BOFUSS dpctl_send_and_print and dpctl_transact_and_print weak functions from utilities/dpctl.c. More...

static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

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

Protected Member Functions
void	HandshakeSuccessful (Ptr< const RemoteSwitch > swtch) override
	Function invoked after a successfully handshake procedure between this controller and a remote switch. More...

Protected Member Functions inherited from ns3::OFSwitch13Controller
uint32_t	GetNextXid ()

Ptr< const RemoteSwitch >	GetRemoteSwitch (uint64_t dpId) const
	Get the remote switch for this OpenFlow datapath ID. More...

void	SendBarrierRequest (Ptr< const RemoteSwitch > swtch)
	Send a barrier request message to switch, and wait for a non-blocking reply. More...

void	SendEchoRequest (Ptr< const RemoteSwitch > swtch, size_t payloadSize=0)
	Send an echo request message to switch, and wait for a non-blocking reply. More...

int	SendToSwitch (Ptr< const RemoteSwitch > swtch, struct ofl_msg_header *msg, uint32_t xid=0)
	Send a OFLib message to a registered switch. More...

void	StartApplication () override
	Application specific startup code. More...

void	StopApplication () override
	Application specific shutdown code. More...

ofl_err	HandleEchoRequest (struct ofl_msg_echo *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

ofl_err	HandleEchoReply (struct ofl_msg_echo *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

ofl_err	HandleBarrierReply (struct ofl_msg_header *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

ofl_err	HandleHello (struct ofl_msg_header *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

ofl_err	HandleFeaturesReply (struct ofl_msg_features_reply *msg, Ptr< RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleError (struct ofl_msg_error *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleGetConfigReply (struct ofl_msg_get_config_reply *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandlePortStatus (struct ofl_msg_port_status *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleAsyncReply (struct ofl_msg_async_config *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleMultipartReply (struct ofl_msg_multipart_reply_header *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleRoleReply (struct ofl_msg_role_request *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

virtual ofl_err	HandleQueueGetConfigReply (struct ofl_msg_queue_get_config_reply *msg, Ptr< const RemoteSwitch > swtch, uint32_t xid)
	Called when an OpenFlow message is received from a switch. More...

Protected Member Functions inherited from ns3::Application
void	DoInitialize () override
	Initialize() implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	NotifyNewAggregate ()
	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 ()
	Notifier called once the ObjectBase is fully constructed. More...

Private Types
typedef std::map< Ipv4Address, Mac48Address >	IpMacMap_t
	Map saving <IPv4 address / MAC address> More...

Private Attributes
IpMacMap_t	m_arpTable
	ARP resolution table. More...

L2 switching structures
typedef std::map< Mac48Address, uint32_t >	L2Table_t
	L2SwitchingTable: map MacAddress to port. More...

typedef std::map< uint64_t, L2Table_t >	DatapathMap_t
	Map datapathID to L2SwitchingTable. More...

DatapathMap_t	m_learnedInfo
	Switching information for all dapataths. More...

Additional Inherited Members
Public Types inherited from ns3::Application
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address. More...

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source. More...

Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
	The node that this application is installed on. More...

EventId	m_startEvent
	The event that will fire at m_startTime to start the application. More...

Time	m_startTime
	The simulation time that the application will start. More...

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application. More...

Time	m_stopTime
	The simulation time that the application will end. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

An Learning OpenFlow 1.3 controller (works as L2 switch)

Introspection did not find any typical Config paths.

No Attributes are defined for this type.

Attributes defined in parent class ns3::OFSwitch13Controller

Port: Port number to listen for incoming packets.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 6653
- Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 456 bytes (on a 64-bit architecture).

Definition at line 32 of file ofswitch13-learning-controller.h.

Member Typedef Documentation

◆ DatapathMap_t

typedef std::map<uint64_t, L2Table_t> ns3::OFSwitch13LearningController::DatapathMap_t

private

Map datapathID to L2SwitchingTable.

Definition at line 91 of file ofswitch13-learning-controller.h.

◆ IpMacMap_t

typedef std::map<Ipv4Address, Mac48Address> ns3::OFSwitch13LearningController::IpMacMap_t

private

Map saving <IPv4 address / MAC address>

Definition at line 80 of file ofswitch13-learning-controller.h.

◆ L2Table_t

typedef std::map<Mac48Address, uint32_t> ns3::OFSwitch13LearningController::L2Table_t

private

L2SwitchingTable: map MacAddress to port.

Definition at line 88 of file ofswitch13-learning-controller.h.

Constructor & Destructor Documentation

◆ OFSwitch13LearningController()

ns3::OFSwitch13LearningController::OFSwitch13LearningController ( )

Default constructor.

◆ ~OFSwitch13LearningController()

ns3::OFSwitch13LearningController::~OFSwitch13LearningController ( )

override

Dummy destructor.

Member Function Documentation

◆ DoDispose()

void ns3::OFSwitch13LearningController::DoDispose ( )

overridevirtual

Destructor implementation.

Reimplemented from ns3::OFSwitch13Controller.

◆ GetTypeId()

static TypeId ns3::OFSwitch13LearningController::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

◆ HandleFlowRemoved()

ofl_err ns3::OFSwitch13LearningController::HandleFlowRemoved	(	struct ofl_msg_flow_removed *	msg,
		Ptr< const RemoteSwitch >	swtch,
		uint32_t	xid
	)

overridevirtual

Handle flow removed messages sent from switch to this controller.

Look for L2 switching information and removes associated entry.

Parameters

msg	The flow removed message.
swtch	The switch information.
xid	Transaction id.

Returns: 0 if everything's ok, otherwise an error number.

Reimplemented from ns3::OFSwitch13Controller.

◆ HandlePacketIn()

ofl_err ns3::OFSwitch13LearningController::HandlePacketIn	(	struct ofl_msg_packet_in *	msg,
		Ptr< const RemoteSwitch >	swtch,
		uint32_t	xid
	)

overridevirtual

Handle packet-in messages sent from switch to this controller.

Look for L2 switching information, update the structures and send a packet-out back.

Parameters

msg	The packet-in message.
swtch	The switch information.
xid	Transaction id.

Returns: 0 if everything's ok, otherwise an error number.

Reimplemented from ns3::OFSwitch13Controller.

◆ HandshakeSuccessful()

void ns3::OFSwitch13LearningController::HandshakeSuccessful ( Ptr< const RemoteSwitch > swtch )

overrideprotectedvirtual

Function invoked after a successfully handshake procedure between this controller and a remote switch.

Derived classes can override this function to implement any relevant logic, as sending initial configuration messages to the switch.

Parameters

swtch The remote switch.

Reimplemented from ns3::OFSwitch13Controller.

Member Data Documentation

◆ m_arpTable

IpMacMap_t ns3::OFSwitch13LearningController::m_arpTable

private

ARP resolution table.

Definition at line 81 of file ofswitch13-learning-controller.h.

◆ m_learnedInfo

DatapathMap_t ns3::OFSwitch13LearningController::m_learnedInfo

private

Switching information for all dapataths.

Definition at line 94 of file ofswitch13-learning-controller.h.

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

contrib/ofswitch13/model/ofswitch13-learning-controller.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Attributes

L2 switching structures

Additional Inherited Members

Detailed Description

Attributes defined in parent class ns3::OFSwitch13Controller

Member Typedef Documentation

◆ DatapathMap_t

◆ IpMacMap_t

◆ L2Table_t

Constructor & Destructor Documentation

◆ OFSwitch13LearningController()

◆ ~OFSwitch13LearningController()

Member Function Documentation

◆ DoDispose()

◆ GetTypeId()

◆ HandleFlowRemoved()

◆ HandlePacketIn()

◆ HandshakeSuccessful()

Member Data Documentation

◆ m_arpTable

◆ m_learnedInfo