IpcsClassifierRecord class. More...

#include "ipcs-classifier-record.h"

Classes
struct	ipv4Addr
	ipv4Addr structure More...

struct	PortRange
	PortRange structure. More...

Public Member Functions
	IpcsClassifierRecord ()

	IpcsClassifierRecord (Ipv4Address srcAddress, Ipv4Mask srcMask, Ipv4Address dstAddress, Ipv4Mask dstMask, uint16_t srcPortLow, uint16_t srcPortHigh, uint16_t dstPortLow, uint16_t dstPortHigh, uint8_t protocol, uint8_t priority)
	creates a classifier records and sets all its parameters More...

	IpcsClassifierRecord (Tlv tlv)
	Decodes a TLV and creates a classifier. More...

	~IpcsClassifierRecord ()

void	AddDstAddr (Ipv4Address dstAddress, Ipv4Mask dstMask)
	add a new destination ip address to the classifier More...

void	AddDstPortRange (uint16_t dstPortLow, uint16_t dstPortHigh)
	add a range of destination port to the classifier More...

void	AddProtocol (uint8_t proto)
	add a protocol to the classifier More...

void	AddSrcAddr (Ipv4Address srcAddress, Ipv4Mask srcMask)
	add a new source ip address to the classifier More...

void	AddSrcPortRange (uint16_t srcPortLow, uint16_t srcPortHigh)
	add a range of source port to the classifier More...

bool	CheckMatch (Ipv4Address srcAddress, Ipv4Address dstAddress, uint16_t srcPort, uint16_t dstPort, uint8_t proto) const
	check if a packets can be used with this classifier More...

uint16_t	GetCid (void) const

uint16_t	GetIndex (void) const

uint8_t	GetPriority (void) const

void	SetCid (uint16_t cid)
	Set the cid associated to this classifier. More...

void	SetIndex (uint16_t index)
	Set the index of the classifier. More...

void	SetPriority (uint8_t prio)
	Set the priority of this classifier. More...

Tlv	ToTlv (void) const
	Creates a TLV from this classifier. More...

Private Member Functions
bool	CheckMatchDstAddr (Ipv4Address dstAddress) const
	Check match destination address function. More...

bool	CheckMatchDstPort (uint16_t dstPort) const
	Check match destination port function. More...

bool	CheckMatchProtocol (uint8_t proto) const
	Check match protocol function. More...

bool	CheckMatchSrcAddr (Ipv4Address srcAddress) const
	Check match source address function. More...

bool	CheckMatchSrcPort (uint16_t srcPort) const
	Check match source port function. More...

Private Attributes
uint16_t	m_cid
	the CID More...

std::vector< struct ipv4Addr >	m_dstAddr
	destination address More...

std::vector< struct PortRange >	m_dstPortRange
	destination port range More...

uint16_t	m_index
	index More...

uint8_t	m_priority
	priority More...

std::vector< uint8_t >	m_protocol
	protocol More...

std::vector< struct ipv4Addr >	m_srcAddr
	source address More...

std::vector< struct PortRange >	m_srcPortRange
	surce port range More...

uint8_t	m_tosHigh
	TOS high. More...

uint8_t	m_tosLow
	TOS low. More...

uint8_t	m_tosMask
	TOS mask. More...

Detailed Description

IpcsClassifierRecord class.

Definition at line 35 of file ipcs-classifier-record.h.

Constructor & Destructor Documentation

◆ IpcsClassifierRecord() [1/3]

ns3::IpcsClassifierRecord::IpcsClassifierRecord ( void )

Definition at line 29 of file ipcs-classifier-record.cc.

References AddDstAddr(), AddDstPortRange(), AddSrcAddr(), AddSrcPortRange(), m_cid, m_index, m_priority, m_protocol, m_tosHigh, m_tosLow, and m_tosMask.

◆ ~IpcsClassifierRecord()

ns3::IpcsClassifierRecord::~IpcsClassifierRecord ( void )

Definition at line 46 of file ipcs-classifier-record.cc.

◆ IpcsClassifierRecord() [2/3]

ns3::IpcsClassifierRecord::IpcsClassifierRecord	(	Ipv4Address	srcAddress,
		Ipv4Mask	srcMask,
		Ipv4Address	dstAddress,
		Ipv4Mask	dstMask,
		uint16_t	srcPortLow,
		uint16_t	srcPortHigh,
		uint16_t	dstPortLow,
		uint16_t	dstPortHigh,
		uint8_t	protocol,
		uint8_t	priority
	)

creates a classifier records and sets all its parameters

Parameters

srcAddress	the source ip address
srcMask	the mask to apply on the source ip address
dstAddress	the destination ip address
dstMask	the mask to apply on the destination ip address
srcPortLow	the lower boundary of the source port range
srcPortHigh	the higher boundary of the source port range
dstPortLow	the lower boundary of the destination port range
dstPortHigh	the higher boundary of the destination port range
protocol	the L4 protocol
priority	the priority of this classifier

Definition at line 128 of file ipcs-classifier-record.cc.

References AddDstAddr(), AddDstPortRange(), AddSrcAddr(), AddSrcPortRange(), m_cid, m_index, m_priority, m_protocol, m_tosHigh, m_tosLow, and m_tosMask.

◆ IpcsClassifierRecord() [3/3]

ns3::IpcsClassifierRecord::IpcsClassifierRecord ( Tlv tlv )

Decodes a TLV and creates a classifier.

Parameters

tlv	the TLV to decode and from which the classifier parameters will be extracted

Definition at line 50 of file ipcs-classifier-record.cc.

Member Function Documentation

◆ AddDstAddr()

void ns3::IpcsClassifierRecord::AddDstAddr	(	Ipv4Address	dstAddress,
		Ipv4Mask	dstMask
	)

add a new destination ip address to the classifier

Parameters

dstAddress	the destination ip address
dstMask	the mask to apply on the destination ip address

Definition at line 161 of file ipcs-classifier-record.cc.

References ns3::IpcsClassifierRecord::ipv4Addr::Address, m_dstAddr, and ns3::IpcsClassifierRecord::ipv4Addr::Mask.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun(), and IpcsClassifierRecord().

◆ AddDstPortRange()

void ns3::IpcsClassifierRecord::AddDstPortRange	(	uint16_t	dstPortLow,
		uint16_t	dstPortHigh
	)

add a range of destination port to the classifier

Parameters

dstPortLow	the lower boundary of the destination port range
dstPortHigh	the higher boundary of the destination port range

Definition at line 178 of file ipcs-classifier-record.cc.

References m_dstPortRange, ns3::IpcsClassifierRecord::PortRange::PortHigh, and ns3::IpcsClassifierRecord::PortRange::PortLow.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun(), and IpcsClassifierRecord().

◆ AddProtocol()

void ns3::IpcsClassifierRecord::AddProtocol ( uint8_t proto )

add a protocol to the classifier

Parameters

proto the L4 protocol to add

Definition at line 186 of file ipcs-classifier-record.cc.

References m_protocol.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun(), and IpcsClassifierRecord().

◆ AddSrcAddr()

void ns3::IpcsClassifierRecord::AddSrcAddr	(	Ipv4Address	srcAddress,
		Ipv4Mask	srcMask
	)

add a new source ip address to the classifier

Parameters

srcAddress	the source ip address
srcMask	the mask to apply on the source ip address

Definition at line 153 of file ipcs-classifier-record.cc.

References ns3::IpcsClassifierRecord::ipv4Addr::Address, m_srcAddr, and ns3::IpcsClassifierRecord::ipv4Addr::Mask.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun(), and IpcsClassifierRecord().

◆ AddSrcPortRange()

void ns3::IpcsClassifierRecord::AddSrcPortRange	(	uint16_t	srcPortLow,
		uint16_t	srcPortHigh
	)

add a range of source port to the classifier

Parameters

srcPortLow	the lower boundary of the source port range
srcPortHigh	the higher boundary of the source port range

Definition at line 169 of file ipcs-classifier-record.cc.

References m_srcPortRange, ns3::IpcsClassifierRecord::PortRange::PortHigh, and ns3::IpcsClassifierRecord::PortRange::PortLow.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun(), and IpcsClassifierRecord().

◆ CheckMatch()

bool ns3::IpcsClassifierRecord::CheckMatch	(	Ipv4Address	srcAddress,
		Ipv4Address	dstAddress,
		uint16_t	srcPort,
		uint16_t	dstPort,
		uint8_t	proto
	)		const

check if a packets can be used with this classifier

Parameters

srcAddress	the source ip address of the packet
dstAddress	the destination ip address of the packet
srcPort	the source port of the packet
dstPort	the destination port of the packet
proto	The L4 protocol of the packet

Returns: true if there is a match

Definition at line 296 of file ipcs-classifier-record.cc.

References CheckMatchDstAddr(), CheckMatchDstPort(), CheckMatchProtocol(), CheckMatchSrcAddr(), and CheckMatchSrcPort().

Referenced by ns3::ServiceFlow::CheckClassifierMatch(), and Ns3WimaxCsParamTlvTestCase::DoRun().

◆ CheckMatchDstAddr()

bool ns3::IpcsClassifierRecord::CheckMatchDstAddr ( Ipv4Address dstAddress ) const

private

Check match destination address function.

Parameters

dstAddress destination IP address to check

Returns: true if a match

Definition at line 237 of file ipcs-classifier-record.cc.

References ns3::Ipv4Address::CombineMask(), m_dstAddr, and NS_LOG_INFO.

Referenced by CheckMatch().

◆ CheckMatchDstPort()

bool ns3::IpcsClassifierRecord::CheckMatchDstPort ( uint16_t dstPort ) const

private

Check match destination port function.

Parameters

dstPort destination port to check

Returns: true if a match

Definition at line 267 of file ipcs-classifier-record.cc.

References m_dstPortRange, NS_LOG_INFO, and port.

Referenced by CheckMatch().

◆ CheckMatchProtocol()

bool ns3::IpcsClassifierRecord::CheckMatchProtocol ( uint8_t proto ) const

private

Check match protocol function.

Parameters

proto protocol number to check

Returns: true if a match

Definition at line 282 of file ipcs-classifier-record.cc.

References m_protocol, and NS_LOG_INFO.

Referenced by CheckMatch().

◆ CheckMatchSrcAddr()

bool ns3::IpcsClassifierRecord::CheckMatchSrcAddr ( Ipv4Address srcAddress ) const

private

Check match source address function.

Parameters

srcAddress source IP address to check

Returns: true if a match

Definition at line 223 of file ipcs-classifier-record.cc.

References ns3::Ipv4Address::CombineMask(), m_srcAddr, and NS_LOG_INFO.

Referenced by CheckMatch().

◆ CheckMatchSrcPort()

bool ns3::IpcsClassifierRecord::CheckMatchSrcPort ( uint16_t srcPort ) const

private

Check match source port function.

Parameters

srcPort source port to check

Returns: true if a match

Definition at line 252 of file ipcs-classifier-record.cc.

References m_srcPortRange, NS_LOG_INFO, and port.

Referenced by CheckMatch().

◆ GetCid()

uint16_t ns3::IpcsClassifierRecord::GetCid ( void ) const

Returns: the cid associated with this classifier

Definition at line 212 of file ipcs-classifier-record.cc.

References m_cid.

◆ GetIndex()

uint16_t ns3::IpcsClassifierRecord::GetIndex ( void ) const

Returns: the index of this classifier

Definition at line 207 of file ipcs-classifier-record.cc.

References m_index.

◆ GetPriority()

uint8_t ns3::IpcsClassifierRecord::GetPriority ( void ) const

Returns: the priority of this classifier

Definition at line 217 of file ipcs-classifier-record.cc.

References m_priority.

◆ SetCid()

void ns3::IpcsClassifierRecord::SetCid ( uint16_t cid )

Set the cid associated to this classifier.

Parameters

cid	the connection identifier

Definition at line 196 of file ipcs-classifier-record.cc.

References m_cid.

◆ SetIndex()

void ns3::IpcsClassifierRecord::SetIndex ( uint16_t index )

Set the index of the classifier.

Parameters

index the index of the classifier

Definition at line 201 of file ipcs-classifier-record.cc.

References m_index.

Referenced by Ns3WimaxCsParamTlvTestCase::DoRun().

◆ SetPriority()

void ns3::IpcsClassifierRecord::SetPriority ( uint8_t prio )

Set the priority of this classifier.

Parameters

prio	the priority of the classifier

Definition at line 191 of file ipcs-classifier-record.cc.

References m_priority.

◆ ToTlv()

Tlv ns3::IpcsClassifierRecord::ToTlv ( void ) const

Creates a TLV from this classifier.

Returns: the created TLV

Definition at line 307 of file ipcs-classifier-record.cc.

References ns3::VectorTlvValue::Add(), ns3::PortRangeTlvValue::Add(), ns3::ProtocolTlvValue::Add(), ns3::Ipv4AddressTlvValue::Add(), ns3::VectorTlvValue::GetSerializedSize(), ns3::PortRangeTlvValue::GetSerializedSize(), ns3::ProtocolTlvValue::GetSerializedSize(), ns3::Ipv4AddressTlvValue::GetSerializedSize(), ns3::ClassificationRuleVectorTlvValue::Index, ns3::ClassificationRuleVectorTlvValue::IP_dst, ns3::ClassificationRuleVectorTlvValue::IP_src, m_dstAddr, m_dstPortRange, m_priority, m_protocol, m_srcAddr, m_srcPortRange, ns3::CsParamVectorTlvValue::Packet_Classification_Rule, ns3::ClassificationRuleVectorTlvValue::Port_dst, ns3::ClassificationRuleVectorTlvValue::Port_src, ns3::ClassificationRuleVectorTlvValue::Priority, and ns3::ClassificationRuleVectorTlvValue::Protocol.

Referenced by ns3::CsParameters::ToTlv().

Member Data Documentation

◆ m_cid

uint16_t ns3::IpcsClassifierRecord::m_cid

private

the CID

Definition at line 195 of file ipcs-classifier-record.h.

Referenced by GetCid(), IpcsClassifierRecord(), and SetCid().

◆ m_dstAddr

std::vector<struct ipv4Addr> ns3::IpcsClassifierRecord::m_dstAddr

private

destination address

Definition at line 191 of file ipcs-classifier-record.h.

Referenced by AddDstAddr(), CheckMatchDstAddr(), and ToTlv().

◆ m_dstPortRange

std::vector<struct PortRange> ns3::IpcsClassifierRecord::m_dstPortRange

private

destination port range

Definition at line 193 of file ipcs-classifier-record.h.

Referenced by AddDstPortRange(), CheckMatchDstPort(), and ToTlv().

◆ m_index

uint16_t ns3::IpcsClassifierRecord::m_index

private

index

Definition at line 185 of file ipcs-classifier-record.h.

Referenced by GetIndex(), IpcsClassifierRecord(), and SetIndex().

◆ m_priority

uint8_t ns3::IpcsClassifierRecord::m_priority

private

priority

Definition at line 184 of file ipcs-classifier-record.h.

Referenced by GetPriority(), IpcsClassifierRecord(), SetPriority(), and ToTlv().

◆ m_protocol

std::vector<uint8_t> ns3::IpcsClassifierRecord::m_protocol

private

protocol

Definition at line 189 of file ipcs-classifier-record.h.

Referenced by AddProtocol(), CheckMatchProtocol(), IpcsClassifierRecord(), and ToTlv().

◆ m_srcAddr

std::vector<struct ipv4Addr> ns3::IpcsClassifierRecord::m_srcAddr

private

source address

Definition at line 190 of file ipcs-classifier-record.h.

Referenced by AddSrcAddr(), CheckMatchSrcAddr(), and ToTlv().

◆ m_srcPortRange

std::vector<struct PortRange> ns3::IpcsClassifierRecord::m_srcPortRange

private

surce port range

Definition at line 192 of file ipcs-classifier-record.h.

Referenced by AddSrcPortRange(), CheckMatchSrcPort(), and ToTlv().

◆ m_tosHigh

uint8_t ns3::IpcsClassifierRecord::m_tosHigh

private

TOS high.

Definition at line 187 of file ipcs-classifier-record.h.

Referenced by IpcsClassifierRecord().

◆ m_tosLow

uint8_t ns3::IpcsClassifierRecord::m_tosLow

private

TOS low.

Definition at line 186 of file ipcs-classifier-record.h.

Referenced by IpcsClassifierRecord().

◆ m_tosMask

uint8_t ns3::IpcsClassifierRecord::m_tosMask

private

TOS mask.

Definition at line 188 of file ipcs-classifier-record.h.

Referenced by IpcsClassifierRecord().

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

src/wimax/model/ipcs-classifier-record.h
src/wimax/model/ipcs-classifier-record.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IpcsClassifierRecord() [1/3]

◆ ~IpcsClassifierRecord()

◆ IpcsClassifierRecord() [2/3]

◆ IpcsClassifierRecord() [3/3]

Member Function Documentation

◆ AddDstAddr()

◆ AddDstPortRange()

◆ AddProtocol()

◆ AddSrcAddr()

◆ AddSrcPortRange()

◆ CheckMatch()

◆ CheckMatchDstAddr()

◆ CheckMatchDstPort()

◆ CheckMatchProtocol()

◆ CheckMatchSrcAddr()

◆ CheckMatchSrcPort()

◆ GetCid()

◆ GetIndex()

◆ GetPriority()

◆ SetCid()

◆ SetIndex()

◆ SetPriority()

◆ ToTlv()

Member Data Documentation

◆ m_cid

◆ m_dstAddr

◆ m_dstPortRange

◆ m_index

◆ m_priority

◆ m_protocol

◆ m_srcAddr

◆ m_srcPortRange

◆ m_tosHigh

◆ m_tosLow

◆ m_tosMask