ns3::Ipv4EndPointDemux Class Reference

Demultiplexes packets to various transport layer endpoints. More...

#include <ipv4-end-point-demux.h>

Collaboration diagram for ns3::Ipv4EndPointDemux:

Public Types
typedef std::list< Ipv4EndPoint * >	EndPoints
	Container of the IPv4 endpoints. More...
typedef std::list < Ipv4EndPoint * >::iterator	EndPointsI
	Iterator to the container of the IPv4 endpoints. More...

Public Member Functions
	Ipv4EndPointDemux ()
	~Ipv4EndPointDemux ()
Ipv4EndPoint *	Allocate (void)
	Allocate a Ipv4EndPoint. More...
Ipv4EndPoint *	Allocate (Ipv4Address address)
	Allocate a Ipv4EndPoint. More...
Ipv4EndPoint *	Allocate (uint16_t port)
	Allocate a Ipv4EndPoint. More...
Ipv4EndPoint *	Allocate (Ipv4Address address, uint16_t port)
	Allocate a Ipv4EndPoint. More...
Ipv4EndPoint *	Allocate (Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort)
	Allocate a Ipv4EndPoint. More...
void	DeAllocate (Ipv4EndPoint *endPoint)
	Remove a end point. More...
EndPoints	GetAllEndPoints (void)
	Get the entire list of end points registered. More...
EndPoints	Lookup (Ipv4Address daddr, uint16_t dport, Ipv4Address saddr, uint16_t sport, Ptr< Ipv4Interface > incomingInterface)
	lookup for a match with all the parameters. More...
bool	LookupLocal (Ipv4Address addr, uint16_t port)
	Lookup for address and port. More...
bool	LookupPortLocal (uint16_t port)
	Lookup for port local. More...
Ipv4EndPoint *	SimpleLookup (Ipv4Address daddr, uint16_t dport, Ipv4Address saddr, uint16_t sport)
	simple lookup for a match with all the parameters. More...

Private Member Functions
uint16_t	AllocateEphemeralPort (void)
	Allocate an ephemeral port. More...

Private Attributes
EndPoints	m_endPoints
	A list of IPv4 end points. More...
uint16_t	m_ephemeral
	The ephemeral port. More...
uint16_t	m_portFirst
	The first ephemeral port. More...
uint16_t	m_portLast
	The last ephemeral port. More...

Detailed Description

Demultiplexes packets to various transport layer endpoints.

This class serves as a lookup table to match partial or full information about a four-tuple to an ns3::Ipv4EndPoint. It internally contains a list of endpoints, and has APIs to add and find endpoints in this demux. This code is shared in common to TCP and UDP protocols in ns3. This demux sits between ns3's layer four and the socket layer

Definition at line 43 of file ipv4-end-point-demux.h.

Member Typedef Documentation

typedef std::list<Ipv4EndPoint *> ns3::Ipv4EndPointDemux::EndPoints

Container of the IPv4 endpoints.

Definition at line 48 of file ipv4-end-point-demux.h.

typedef std::list<Ipv4EndPoint *>::iterator ns3::Ipv4EndPointDemux::EndPointsI

Iterator to the container of the IPv4 endpoints.

Definition at line 53 of file ipv4-end-point-demux.h.

Constructor & Destructor Documentation

ns3::Ipv4EndPointDemux::Ipv4EndPointDemux

(

)

Definition at line 30 of file ipv4-end-point-demux.cc.

References NS_LOG_FUNCTION.

ns3::Ipv4EndPointDemux::~Ipv4EndPointDemux

(

)

Definition at line 36 of file ipv4-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION.

Member Function Documentation

Ipv4EndPoint * ns3::Ipv4EndPointDemux::Allocate

(

void

)

Allocate a Ipv4EndPoint.

Returns

an empty Ipv4EndPoint instance

Definition at line 77 of file ipv4-end-point-demux.cc.

References AllocateEphemeralPort(), ns3::Ipv4Address::GetAny(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, and port.

Referenced by ns3::UdpL4Protocol::Allocate(), ns3::NscTcpL4Protocol::Allocate(), ns3::TcpL4Protocol::Allocate(), and Allocate().

Here is the call graph for this function:

Here is the caller graph for this function:

Ipv4EndPoint * ns3::Ipv4EndPointDemux::Allocate

(

Ipv4Address

address

)

Allocate a Ipv4EndPoint.

Parameters

address

IPv4 address

Returns

an Ipv4EndPoint instance

Definition at line 93 of file ipv4-end-point-demux.cc.

References AllocateEphemeralPort(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, and port.

Here is the call graph for this function:

Ipv4EndPoint * ns3::Ipv4EndPointDemux::Allocate

(

uint16_t

port

)

Allocate a Ipv4EndPoint.

Parameters

port	local port

Returns

an Ipv4EndPoint instance

Definition at line 109 of file ipv4-end-point-demux.cc.

References Allocate(), ns3::Ipv4Address::GetAny(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Ipv4EndPoint * ns3::Ipv4EndPointDemux::Allocate	(	Ipv4Address	address,
		uint16_t	port
	)

Allocate a Ipv4EndPoint.

Parameters

address	local address
port	local port

Returns

an Ipv4EndPoint instance

Definition at line 117 of file ipv4-end-point-demux.cc.

References LookupLocal(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

Ipv4EndPoint * ns3::Ipv4EndPointDemux::Allocate	(	Ipv4Address	localAddress,
		uint16_t	localPort,
		Ipv4Address	peerAddress,
		uint16_t	peerPort
	)

Allocate a Ipv4EndPoint.

Parameters

localAddress	local address
localPort	local port
peerAddress	peer address
peerPort	peer port

Returns

an Ipv4EndPoint instance

Definition at line 132 of file ipv4-end-point-demux.cc.

References m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::Ipv4EndPoint::SetPeer().

Here is the call graph for this function:

uint16_t ns3::Ipv4EndPointDemux::AllocateEphemeralPort ( void  )

private

Allocate an ephemeral port.

Returns

the ephemeral port

Definition at line 354 of file ipv4-end-point-demux.cc.

References LookupPortLocal(), m_ephemeral, m_portFirst, m_portLast, NS_LOG_FUNCTION, and port.

Referenced by Allocate().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Ipv4EndPointDemux::DeAllocate

(

Ipv4EndPoint *

endPoint

)

Remove a end point.

Parameters

endPoint

the end point to remove

Definition at line 158 of file ipv4-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION.

Referenced by ns3::UdpL4Protocol::DeAllocate(), and ns3::TcpL4Protocol::DeAllocate().

Here is the caller graph for this function:

Ipv4EndPointDemux::EndPoints ns3::Ipv4EndPointDemux::GetAllEndPoints

(

void

)

Get the entire list of end points registered.

Returns

list of Ipv4EndPoint

Definition at line 176 of file ipv4-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION.

Referenced by ns3::NscTcpL4Protocol::wakeup().

Here is the caller graph for this function:

Ipv4EndPointDemux::EndPoints ns3::Ipv4EndPointDemux::Lookup	(	Ipv4Address	daddr,
		uint16_t	dport,
		Ipv4Address	saddr,
		uint16_t	sport,
		Ptr< Ipv4Interface >	incomingInterface
	)

lookup for a match with all the parameters.

Parameters

daddr	destination address to test
dport	destination port to test
saddr	source address to test
sport	source port to test
incomingInterface	the incoming interface

Returns

list of IPv4EndPoints (could be 0 element)

Definition at line 196 of file ipv4-end-point-demux.cc.

References ns3::Ipv4Address::CombineMask(), ns3::Ipv4Interface::GetAddress(), ns3::Ipv4Address::GetAny(), ns3::Ipv4EndPoint::GetBoundNetDevice(), ns3::Ipv4Interface::GetDevice(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv4InterfaceAddress::GetMask(), ns3::Ipv4Interface::GetNAddresses(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsSubnetDirectedBroadcast(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ns3::TcpL4Protocol::Receive(), and ns3::UdpL4Protocol::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Ipv4EndPointDemux::LookupLocal	(	Ipv4Address	addr,
		uint16_t	port
	)

Lookup for address and port.

Parameters

addr	address to test
port	port to test

Returns

true if there is a match in EndPoints, false otherwise

Definition at line 62 of file ipv4-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION.

Referenced by Allocate().

Here is the caller graph for this function:

bool ns3::Ipv4EndPointDemux::LookupPortLocal

(

uint16_t

port

)

Lookup for port local.

Parameters

port	port to test

Returns

true if a port local is in EndPoints, false otherwise

Definition at line 48 of file ipv4-end-point-demux.cc.

References m_endPoints, NS_LOG_FUNCTION, and port.

Referenced by AllocateEphemeralPort().

Here is the caller graph for this function:

Ipv4EndPoint * ns3::Ipv4EndPointDemux::SimpleLookup	(	Ipv4Address	daddr,
		uint16_t	dport,
		Ipv4Address	saddr,
		uint16_t	sport
	)

simple lookup for a match with all the parameters.

Parameters

daddr	destination address to test
dport	destination port to test
saddr	source address to test
sport	source port to test

Returns

IPv4EndPoint (0 if not found)

Definition at line 312 of file ipv4-end-point-demux.cc.

References ns3::Ipv4Address::GetAny(), m_endPoints, and NS_LOG_FUNCTION.

Referenced by ns3::TcpL4Protocol::ReceiveIcmp(), and ns3::UdpL4Protocol::ReceiveIcmp().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

EndPoints ns3::Ipv4EndPointDemux::m_endPoints

private

A list of IPv4 end points.

Definition at line 180 of file ipv4-end-point-demux.h.

Referenced by Allocate(), DeAllocate(), GetAllEndPoints(), Lookup(), LookupLocal(), LookupPortLocal(), SimpleLookup(), and ~Ipv4EndPointDemux().

uint16_t ns3::Ipv4EndPointDemux::m_ephemeral

private

The ephemeral port.

Definition at line 165 of file ipv4-end-point-demux.h.

Referenced by AllocateEphemeralPort().

uint16_t ns3::Ipv4EndPointDemux::m_portFirst

private

The first ephemeral port.

Definition at line 175 of file ipv4-end-point-demux.h.

Referenced by AllocateEphemeralPort().

uint16_t ns3::Ipv4EndPointDemux::m_portLast

private

The last ephemeral port.

Definition at line 170 of file ipv4-end-point-demux.h.

Referenced by AllocateEphemeralPort().

---

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

• src/internet/model/ipv4-end-point-demux.h
• src/internet/model/ipv4-end-point-demux.cc