ns3::ofi Namespace Reference

Classes
struct	Action
	Class for handling flow table actions. More...
class	Controller
	An interface for a Controller of OpenFlowSwitchNetDevices. More...
class	DropController
	Demonstration of a Drop controller. More...
struct	EricssonAction
	Class for handling Ericsson Vendor-defined actions. More...
class	LearningController
	Demonstration of a Learning controller. More...
struct	Port
	Port and its metadata. More...
class	Stats
	OpenFlow statistics. More...
struct	StatsDumpCallback
	Callback for a stats dump request. More...
struct	SwitchPacketMetadata
	Packet Metadata, allows us to track the packet's metadata as it passes through the switch. More...
struct	VPortAction
	Class for handling virtual port table actions. More...

Functions
void	ExecuteActions (Ptr< OpenFlowSwitchNetDevice > swtch, uint64_t packet_uid, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len, int ignore_no_fwd)
	Executes a list of flow table actions. More...
void	ExecuteVendor (ofpbuf *buffer, const sw_flow_key *key, const ofp_action_header *ah)
	Executes a vendor-defined action. More...
void	ExecuteVPortActions (Ptr< OpenFlowSwitchNetDevice > swtch, uint64_t packet_uid, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len)
	Executes a list of virtual port table entry actions. More...
uint16_t	ValidateActions (const sw_flow_key *key, const ofp_action_header *actions, size_t actions_len)
	Validates a list of flow table actions. More...
uint16_t	ValidateVendor (const sw_flow_key *key, const ofp_action_header *ah, uint16_t len)
	Validates a vendor-defined action. More...
uint16_t	ValidateVPortActions (const ofp_action_header *actions, size_t actions_len)
	Validates a list of virtual port table entry actions. More...

Function Documentation

ExecuteActions()

void ns3::ofi::ExecuteActions	(	Ptr< OpenFlowSwitchNetDevice >	swtch,
		uint64_t	packet_uid,
		ofpbuf *	buffer,
		sw_flow_key *	key,
		const ofp_action_header *	actions,
		size_t	actions_len,
		int	ignore_no_fwd
	)

Executes a list of flow table actions.

Parameters

swtch	OpenFlowSwitchNetDevice these actions are being executed on.
packet_uid	Packet UID; used to fetch the packet and its metadata.
buffer	The Packet OpenFlow buffer.
key	The matching key for the flow tied to this list of actions.
actions	A buffer of actions.
actions_len	Length of actions buffer.
ignore_no_fwd	If true, during port forwarding actions, ports that are set to not forward are forced to forward.

ExecuteVendor()

void ns3::ofi::ExecuteVendor	(	ofpbuf *	buffer,
		const sw_flow_key *	key,
		const ofp_action_header *	ah
	)

Executes a vendor-defined action.

Parameters

buffer	The Packet OpenFlow buffer.
key	The matching key for the flow tied to this list of actions.
ah	Header of the action.

ExecuteVPortActions()

void ns3::ofi::ExecuteVPortActions	(	Ptr< OpenFlowSwitchNetDevice >	swtch,
		uint64_t	packet_uid,
		ofpbuf *	buffer,
		sw_flow_key *	key,
		const ofp_action_header *	actions,
		size_t	actions_len
	)

Executes a list of virtual port table entry actions.

Parameters

swtch	OpenFlowSwitchNetDevice these actions are being executed on.
packet_uid	Packet UID; used to fetch the packet and its metadata.
buffer	The Packet OpenFlow buffer.
key	The matching key for the flow tied to this list of actions.
actions	A buffer of actions.
actions_len	Length of actions buffer.

ValidateActions()

uint16_t ns3::ofi::ValidateActions	(	const sw_flow_key *	key,
		const ofp_action_header *	actions,
		size_t	actions_len
	)

Validates a list of flow table actions.

Parameters

key	The matching key for the flow tied to this list of actions.
actions	A buffer of actions.
actions_len	Length of actions buffer.

Returns

If the action list validates, ACT_VALIDATION_OK is returned. Otherwise, a code for the OFPET_BAD_ACTION error type is returned.

ValidateVendor()

uint16_t ns3::ofi::ValidateVendor	(	const sw_flow_key *	key,
		const ofp_action_header *	ah,
		uint16_t	len
	)

Validates a vendor-defined action.

Parameters

key	The matching key for the flow tied to this list of actions.
ah	Header of the action.
len	Length of the action.

Returns

If the action list validates, ACT_VALIDATION_OK is returned. Otherwise, a code for the OFPET_BAD_ACTION error type is returned.

ValidateVPortActions()

uint16_t ns3::ofi::ValidateVPortActions	(	const ofp_action_header *	actions,
		size_t	actions_len
	)

Validates a list of virtual port table entry actions.

Parameters

actions	A buffer of actions.
actions_len	Length of actions buffer.

Returns

If the action list validates, ACT_VALIDATION_OK is returned. Otherwise, a code for the OFPET_BAD_ACTION error type is returned.