Demultiplexer for end points. More...

#include "ipv6-end-point-demux.h"

Public Types
typedef std::list< Ipv6EndPoint * >	EndPoints
	Container of the IPv6 endpoints. More...

typedef std::list< Ipv6EndPoint * >::iterator	EndPointsI
	Iterator to the container of the IPv6 endpoints. More...

Public Member Functions
	Ipv6EndPointDemux ()

	~Ipv6EndPointDemux ()

Ipv6EndPoint *	Allocate (void)
	Allocate a Ipv6EndPoint. More...

Ipv6EndPoint *	Allocate (Ipv6Address address)
	Allocate a Ipv6EndPoint. More...

Ipv6EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, uint16_t port)
	Allocate a Ipv6EndPoint. More...

Ipv6EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, Ipv6Address address, uint16_t port)
	Allocate a Ipv6EndPoint. More...

Ipv6EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, Ipv6Address localAddress, uint16_t localPort, Ipv6Address peerAddress, uint16_t peerPort)
	Allocate a Ipv6EndPoint. More...

void	DeAllocate (Ipv6EndPoint *endPoint)
	Remove a end point. More...

EndPoints	GetEndPoints () const
	Get the entire list of end points registered. More...

EndPoints	Lookup (Ipv6Address dst, uint16_t dport, Ipv6Address src, uint16_t sport, Ptr< Ipv6Interface > incomingInterface)
	lookup for a match with all the parameters. More...

bool	LookupLocal (Ptr< NetDevice > boundNetDevice, Ipv6Address addr, uint16_t port)
	Lookup for address and port. More...

bool	LookupPortLocal (uint16_t port)
	Lookup for port local. More...

Ipv6EndPoint *	SimpleLookup (Ipv6Address dst, uint16_t dport, Ipv6Address src, uint16_t sport)
	Simple lookup for a four-tuple match. More...

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

Private Attributes
EndPoints	m_endPoints
	A list of IPv6 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

Demultiplexer for end points.

Definition at line 38 of file ipv6-end-point-demux.h.

Member Typedef Documentation

◆ EndPoints

typedef std::list<Ipv6EndPoint *> ns3::Ipv6EndPointDemux::EndPoints

Container of the IPv6 endpoints.

Definition at line 44 of file ipv6-end-point-demux.h.

◆ EndPointsI

typedef std::list<Ipv6EndPoint *>::iterator ns3::Ipv6EndPointDemux::EndPointsI

Iterator to the container of the IPv6 endpoints.

Definition at line 49 of file ipv6-end-point-demux.h.

Constructor & Destructor Documentation

◆ Ipv6EndPointDemux()

ns3::Ipv6EndPointDemux::Ipv6EndPointDemux ( )

Definition at line 29 of file ipv6-end-point-demux.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~Ipv6EndPointDemux()

ns3::Ipv6EndPointDemux::~Ipv6EndPointDemux ( )

Definition at line 37 of file ipv6-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ Allocate() [1/5]

Ipv6EndPoint * ns3::Ipv6EndPointDemux::Allocate ( void )

Allocate a Ipv6EndPoint.

Returns: an empty Ipv6EndPoint instance

Definition at line 76 of file ipv6-end-point-demux.cc.

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

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

◆ Allocate() [2/5]

Ipv6EndPoint * ns3::Ipv6EndPointDemux::Allocate ( Ipv6Address address )

Allocate a Ipv6EndPoint.

Parameters

address IPv6 address

Returns: an Ipv6EndPoint instance

Definition at line 91 of file ipv6-end-point-demux.cc.

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

◆ Allocate() [3/5]

Ipv6EndPoint * ns3::Ipv6EndPointDemux::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		uint16_t	port
	)

Allocate a Ipv6EndPoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
port	local port

Returns: an Ipv6EndPoint instance

Definition at line 106 of file ipv6-end-point-demux.cc.

References Allocate(), ns3::Ipv6Address::GetAny(), NS_LOG_FUNCTION, and port.

◆ Allocate() [4/5]

Ipv6EndPoint * ns3::Ipv6EndPointDemux::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		Ipv6Address	address,
		uint16_t	port
	)

Allocate a Ipv6EndPoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
address	local address
port	local port

Returns: an Ipv6EndPoint instance

Definition at line 113 of file ipv6-end-point-demux.cc.

References first::address, LookupLocal(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, and port.

◆ Allocate() [5/5]

Ipv6EndPoint * ns3::Ipv6EndPointDemux::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		Ipv6Address	localAddress,
		uint16_t	localPort,
		Ipv6Address	peerAddress,
		uint16_t	peerPort
	)

Allocate a Ipv6EndPoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
localAddress	local address
localPort	local port
peerAddress	peer address
peerPort	peer port

Returns: an Ipv6EndPoint instance

Definition at line 127 of file ipv6-end-point-demux.cc.

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

◆ AllocateEphemeralPort()

uint16_t ns3::Ipv6EndPointDemux::AllocateEphemeralPort ( void )

private

Allocate a ephemeral port.

Returns: a port

Definition at line 331 of file ipv6-end-point-demux.cc.

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

Referenced by Allocate().

◆ DeAllocate()

void ns3::Ipv6EndPointDemux::DeAllocate ( Ipv6EndPoint * endPoint )

Remove a end point.

Parameters

endPoint the end point to remove

Definition at line 153 of file ipv6-end-point-demux.cc.

References m_endPoints, and NS_LOG_FUNCTION.

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

◆ GetEndPoints()

Ipv6EndPointDemux::EndPoints ns3::Ipv6EndPointDemux::GetEndPoints ( ) const

Get the entire list of end points registered.

Returns: list of Ipv6EndPoint

Definition at line 353 of file ipv6-end-point-demux.cc.

References m_endPoints.

◆ Lookup()

Ipv6EndPointDemux::EndPoints ns3::Ipv6EndPointDemux::Lookup	(	Ipv6Address	dst,
		uint16_t	dport,
		Ipv6Address	src,
		uint16_t	sport,
		Ptr< Ipv6Interface >	incomingInterface
	)

lookup for a match with all the parameters.

The function will return a list of most-matching EndPoints, in this order:

Full match
All but local address
Only local port and local address match
Only local port match

EndPoint with disabled Rx are skipped.

Parameters

dst	destination address to test
dport	destination port to test
src	source address to test
sport	source port to test
incomingInterface	the incoming interface

Returns: list of IPv6EndPoints (could be 0 element)

Definition at line 172 of file ipv6-end-point-demux.cc.

References ns3::Ipv6Address::GetAllRoutersMulticast(), ns3::Ipv6Address::GetAny(), ns3::Ipv6EndPoint::GetBoundNetDevice(), ns3::Ipv6Interface::GetDevice(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::IsRxEnabled(), m_endPoints, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

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

◆ LookupLocal()

bool ns3::Ipv6EndPointDemux::LookupLocal	(	Ptr< NetDevice >	boundNetDevice,
		Ipv6Address	addr,
		uint16_t	port
	)

Lookup for address and port.

Parameters

boundNetDevice	Bound NetDevice (if any)
addr	address to test
port	port to test

Returns: true if there is a match in EndPoints, false otherwise

Definition at line 61 of file ipv6-end-point-demux.cc.

References m_endPoints, NS_LOG_FUNCTION, and port.

Referenced by Allocate().

◆ LookupPortLocal()

bool ns3::Ipv6EndPointDemux::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 ipv6-end-point-demux.cc.

References m_endPoints, NS_LOG_FUNCTION, and port.

Referenced by AllocateEphemeralPort().

◆ SimpleLookup()

Ipv6EndPoint * ns3::Ipv6EndPointDemux::SimpleLookup	(	Ipv6Address	dst,
		uint16_t	dport,
		Ipv6Address	src,
		uint16_t	sport
	)

Simple lookup for a four-tuple match.

Parameters

dst	destination address to test
dport	destination port to test
src	source address to test
sport	source port to test

Returns: match or 0 if not found

Definition at line 291 of file ipv6-end-point-demux.cc.

References ns3::Ipv6Address::GetAny(), and m_endPoints.

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

Member Data Documentation

◆ m_endPoints

EndPoints ns3::Ipv6EndPointDemux::m_endPoints

private

A list of IPv6 end points.

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

Referenced by Allocate(), DeAllocate(), GetEndPoints(), Lookup(), LookupLocal(), LookupPortLocal(), SimpleLookup(), and ~Ipv6EndPointDemux().

◆ m_ephemeral

uint16_t ns3::Ipv6EndPointDemux::m_ephemeral

private

The ephemeral port.

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

Referenced by AllocateEphemeralPort().

◆ m_portFirst

uint16_t ns3::Ipv6EndPointDemux::m_portFirst

private

The first ephemeral port.

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

Referenced by AllocateEphemeralPort().

◆ m_portLast

uint16_t ns3::Ipv6EndPointDemux::m_portLast

private

The last ephemeral port.

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

Referenced by AllocateEphemeralPort().

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

src/internet/model/ipv6-end-point-demux.h
src/internet/model/ipv6-end-point-demux.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EndPoints

◆ EndPointsI

Constructor & Destructor Documentation

◆ Ipv6EndPointDemux()

◆ ~Ipv6EndPointDemux()

Member Function Documentation

◆ Allocate() [1/5]

◆ Allocate() [2/5]

◆ Allocate() [3/5]

◆ Allocate() [4/5]

◆ Allocate() [5/5]

◆ AllocateEphemeralPort()

◆ DeAllocate()

◆ GetEndPoints()

◆ Lookup()

◆ LookupLocal()

◆ LookupPortLocal()

◆ SimpleLookup()

Member Data Documentation

◆ m_endPoints

◆ m_ephemeral

◆ m_portFirst

◆ m_portLast