Implementation of the UDP protocol. More...

#include "udp-l4-protocol.h"

Inheritance diagram for ns3::UdpL4Protocol:

Collaboration diagram for ns3::UdpL4Protocol:

Public Member Functions
	UdpL4Protocol ()

	UdpL4Protocol (const UdpL4Protocol &)=delete

	~UdpL4Protocol () override

Ipv4EndPoint *	Allocate ()
	Allocate an IPv4 Endpoint. More...

Ipv4EndPoint *	Allocate (Ipv4Address address)
	Allocate an IPv4 Endpoint. More...

Ipv4EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, Ipv4Address address, uint16_t port)
	Allocate an IPv4 Endpoint. More...

Ipv4EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort)
	Allocate an IPv4 Endpoint. More...

Ipv4EndPoint *	Allocate (Ptr< NetDevice > boundNetDevice, uint16_t port)
	Allocate an IPv4 Endpoint. More...

Ipv6EndPoint *	Allocate6 ()
	Allocate an IPv6 Endpoint. More...

Ipv6EndPoint *	Allocate6 (Ipv6Address address)
	Allocate an IPv6 Endpoint. More...

Ipv6EndPoint *	Allocate6 (Ptr< NetDevice > boundNetDevice, Ipv6Address address, uint16_t port)
	Allocate an IPv6 Endpoint. More...

Ipv6EndPoint *	Allocate6 (Ptr< NetDevice > boundNetDevice, Ipv6Address localAddress, uint16_t localPort, Ipv6Address peerAddress, uint16_t peerPort)
	Allocate an IPv6 Endpoint. More...

Ipv6EndPoint *	Allocate6 (Ptr< NetDevice > boundNetDevice, uint16_t port)
	Allocate an IPv6 Endpoint. More...

Ptr< Socket >	CreateSocket ()

void	DeAllocate (Ipv4EndPoint *endPoint)
	Remove an IPv4 Endpoint. More...

void	DeAllocate (Ipv6EndPoint *endPoint)
	Remove an IPv6 Endpoint. More...

IpL4Protocol::DownTargetCallback	GetDownTarget () const override
	This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 case) More...

IpL4Protocol::DownTargetCallback6	GetDownTarget6 () const override
	This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 case) More...

int	GetProtocolNumber () const override
	Returns the protocol number of this protocol. More...

UdpL4Protocol &	operator= (const UdpL4Protocol &)=delete

IpL4Protocol::RxStatus	Receive (Ptr< Packet > p, const Ipv4Header &header, Ptr< Ipv4Interface > interface) override
	Called from lower-level layers to send the packet up in the stack. More...

IpL4Protocol::RxStatus	Receive (Ptr< Packet > p, const Ipv6Header &header, Ptr< Ipv6Interface > interface) override
	Called from lower-level layers to send the packet up in the stack. More...

void	ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv4Address payloadSource, Ipv4Address payloadDestination, const uint8_t payload[8]) override
	Called from lower-level layers to send the ICMP packet up in the stack. More...

void	ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv6Address payloadSource, Ipv6Address payloadDestination, const uint8_t payload[8]) override
	Called from lower-level layers to send the ICMPv6 packet up in the stack. More...

bool	RemoveSocket (Ptr< UdpSocketImpl > socket)
	Remove a socket from the internal list. More...

void	Send (Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport)
	Send a packet via UDP (IPv4) More...

void	Send (Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport, Ptr< Ipv4Route > route)
	Send a packet via UDP (IPv4) More...

void	Send (Ptr< Packet > packet, Ipv6Address saddr, Ipv6Address daddr, uint16_t sport, uint16_t dport)
	Send a packet via UDP (IPv6) More...

void	Send (Ptr< Packet > packet, Ipv6Address saddr, Ipv6Address daddr, uint16_t sport, uint16_t dport, Ptr< Ipv6Route > route)
	Send a packet via UDP (IPv6) More...

void	SetDownTarget (IpL4Protocol::DownTargetCallback cb) override
	This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 case) More...

void	SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb) override
	This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 case) More...

void	SetNode (Ptr< Node > node)
	Set node associated with this stack. More...

Public Member Functions inherited from ns3::IpL4Protocol
	~IpL4Protocol () override

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 ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::IpL4Protocol
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...

Static Public Attributes
static const uint8_t	PROT_NUMBER = 17
	protocol number (0x11) More...

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

void	NotifyNewAggregate () override
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

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

virtual void	DoInitialize ()
	Initialize() implementation. 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 Attributes
IpL4Protocol::DownTargetCallback	m_downTarget
	Callback to send packets over IPv4. More...

IpL4Protocol::DownTargetCallback6	m_downTarget6
	Callback to send packets over IPv6. More...

Ipv4EndPointDemux *	m_endPoints
	A list of IPv4 end points. More...

Ipv6EndPointDemux *	m_endPoints6
	A list of IPv6 end points. More...

Ptr< Node >	m_node
	The node this stack is associated with. More...

uint64_t	m_socketIndex {0}
	Index of the next socket to be created. More...

std::unordered_map< uint64_t, Ptr< UdpSocketImpl > >	m_sockets
	Unordered map of socket IDs and corresponding sockets. More...

Additional Inherited Members
Public Types inherited from ns3::IpL4Protocol
typedef Callback< void, Ptr< Packet >, Ipv4Address, Ipv4Address, uint8_t, Ptr< Ipv4Route > >	DownTargetCallback
	callback to send packets over IPv4 More...

typedef Callback< void, Ptr< Packet >, Ipv6Address, Ipv6Address, uint8_t, Ptr< Ipv6Route > >	DownTargetCallback6
	callback to send packets over IPv6 More...

enum	RxStatus { RX_OK , RX_CSUM_FAILED , RX_ENDPOINT_CLOSED , RX_ENDPOINT_UNREACH }
	Rx status codes. 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

Implementation of the UDP protocol.

Definition at line 63 of file udp-l4-protocol.h.

Constructor & Destructor Documentation

◆ UdpL4Protocol() [1/2]

ns3::UdpL4Protocol::UdpL4Protocol ( )

Definition at line 71 of file udp-l4-protocol.cc.

References NS_LOG_FUNCTION.

◆ ~UdpL4Protocol()

ns3::UdpL4Protocol::~UdpL4Protocol ( )

override

Definition at line 78 of file udp-l4-protocol.cc.

References NS_LOG_FUNCTION.

◆ UdpL4Protocol() [2/2]

ns3::UdpL4Protocol::UdpL4Protocol ( const UdpL4Protocol & )

delete

Member Function Documentation

◆ Allocate() [1/5]

Ipv4EndPoint * ns3::UdpL4Protocol::Allocate ( )

Allocate an IPv4 Endpoint.

Returns: the Endpoint

Definition at line 178 of file udp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate() [2/5]

Ipv4EndPoint * ns3::UdpL4Protocol::Allocate ( Ipv4Address address )

Allocate an IPv4 Endpoint.

Parameters

address address to use

Returns: the Endpoint

Definition at line 185 of file udp-l4-protocol.cc.

References first::address, ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate() [3/5]

Ipv4EndPoint * ns3::UdpL4Protocol::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		Ipv4Address	address,
		uint16_t	port
	)

Allocate an IPv4 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
address	address to use
port	port to use

Returns: the Endpoint

Definition at line 199 of file udp-l4-protocol.cc.

References first::address, ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

◆ Allocate() [4/5]

Ipv4EndPoint * ns3::UdpL4Protocol::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		Ipv4Address	localAddress,
		uint16_t	localPort,
		Ipv4Address	peerAddress,
		uint16_t	peerPort
	)

Allocate an IPv4 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
localAddress	local address to use
localPort	local port to use
peerAddress	remote address to use
peerPort	remote port to use

Returns: the Endpoint

Definition at line 206 of file udp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate() [5/5]

Ipv4EndPoint * ns3::UdpL4Protocol::Allocate	(	Ptr< NetDevice >	boundNetDevice,
		uint16_t	port
	)

Allocate an IPv4 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
port	port to use

Returns: the Endpoint

Definition at line 192 of file udp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

◆ Allocate6() [1/5]

Ipv6EndPoint * ns3::UdpL4Protocol::Allocate6 ( )

Allocate an IPv6 Endpoint.

Returns: the Endpoint

Definition at line 224 of file udp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate6() [2/5]

Ipv6EndPoint * ns3::UdpL4Protocol::Allocate6 ( Ipv6Address address )

Allocate an IPv6 Endpoint.

Parameters

address address to use

Returns: the Endpoint

Definition at line 231 of file udp-l4-protocol.cc.

References first::address, ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate6() [3/5]

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

Allocate an IPv6 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
address	address to use
port	port to use

Returns: the Endpoint

Definition at line 245 of file udp-l4-protocol.cc.

References first::address, ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

◆ Allocate6() [4/5]

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

Allocate an IPv6 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
localAddress	local address to use
localPort	local port to use
peerAddress	remote address to use
peerPort	remote port to use

Returns: the Endpoint

Definition at line 252 of file udp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Allocate6() [5/5]

Ipv6EndPoint * ns3::UdpL4Protocol::Allocate6	(	Ptr< NetDevice >	boundNetDevice,
		uint16_t	port
	)

Allocate an IPv6 Endpoint.

Parameters

boundNetDevice	Bound NetDevice (if any)
port	port to use

Returns: the Endpoint

Definition at line 238 of file udp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

◆ CreateSocket()

Ptr< Socket > ns3::UdpL4Protocol::CreateSocket ( )

Returns: A smart Socket pointer to a UdpSocket, allocated by this instance of the UDP protocol

Definition at line 167 of file udp-l4-protocol.cc.

References m_node, m_socketIndex, m_sockets, and NS_LOG_FUNCTION.

◆ DeAllocate() [1/2]

void ns3::UdpL4Protocol::DeAllocate ( Ipv4EndPoint * endPoint )

Remove an IPv4 Endpoint.

Parameters

endPoint the end point to remove

Definition at line 217 of file udp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::DeAllocate(), m_endPoints, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DeAllocate() [2/2]

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

Remove an IPv6 Endpoint.

Parameters

endPoint the end point to remove

Definition at line 263 of file udp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::DeAllocate(), m_endPoints6, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDispose()

void ns3::UdpL4Protocol::DoDispose ( void )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 138 of file udp-l4-protocol.cc.

References ns3::Object::DoDispose(), m_downTarget, m_downTarget6, m_endPoints, m_endPoints6, m_node, m_sockets, NS_LOG_FUNCTION, and ns3::Callback< R, UArgs >::Nullify().

Here is the call graph for this function:

◆ GetDownTarget()

IpL4Protocol::DownTargetCallback ns3::UdpL4Protocol::GetDownTarget ( ) const

overridevirtual

This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 case)

Returns: current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 533 of file udp-l4-protocol.cc.

References m_downTarget.

◆ GetDownTarget6()

IpL4Protocol::DownTargetCallback6 ns3::UdpL4Protocol::GetDownTarget6 ( ) const

overridevirtual

This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 case)

Returns: current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 546 of file udp-l4-protocol.cc.

References m_downTarget6.

◆ GetProtocolNumber()

int ns3::UdpL4Protocol::GetProtocolNumber ( ) const

overridevirtual

Returns the protocol number of this protocol.

Returns: the protocol number.

Implements ns3::IpL4Protocol.

Definition at line 132 of file udp-l4-protocol.cc.

References PROT_NUMBER.

◆ GetTypeId()

TypeId ns3::UdpL4Protocol::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 54 of file udp-l4-protocol.cc.

References m_sockets, ns3::MakeObjectMapAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ NotifyNewAggregate()

void ns3::UdpL4Protocol::NotifyNewAggregate ( )

overrideprotectedvirtual

Notify all Objects aggregated to this one of a new Object being aggregated.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

This method is invoked whenever two sets of Objects are aggregated together. It is invoked exactly once for each Object in both sets. This method can be overridden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate() method.

It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 95 of file udp-l4-protocol.cc.

References ns3::Object::AggregateObject(), ns3::Object::GetObject(), nsclick-simple-lan::ipv4, ns3::Callback< R, UArgs >::IsNull(), m_downTarget, m_downTarget6, m_node, ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, ns3::Ipv4::Send(), ns3::Ipv6::Send(), SetDownTarget(), SetDownTarget6(), and SetNode().

Here is the call graph for this function:

◆ operator=()

UdpL4Protocol& ns3::UdpL4Protocol::operator= ( const UdpL4Protocol & )

delete

◆ Receive() [1/2]

IpL4Protocol::RxStatus ns3::UdpL4Protocol::Receive	(	Ptr< Packet >	p,
		const Ipv4Header &	header,
		Ptr< Ipv4Interface >	incomingInterface
	)

overridevirtual

Called from lower-level layers to send the packet up in the stack.

Parameters

p	packet to forward up
header	IPv4 Header information
incomingInterface	the Ipv4Interface on which the packet arrived

Returns: Rx status code

Implements ns3::IpL4Protocol.

Definition at line 335 of file udp-l4-protocol.cc.

References ns3::Node::ChecksumEnabled(), ns3::Packet::Copy(), ns3::UdpHeader::EnableChecksums(), ns3::Ipv4Header::GetDestination(), ns3::UdpHeader::GetDestinationPort(), ns3::Ipv4Header::GetSource(), ns3::UdpHeader::GetSourcePort(), ns3::UdpHeader::InitializeChecksum(), ns3::UdpHeader::IsChecksumOk(), ns3::Ipv4EndPointDemux::Lookup(), m_endPoints, ns3::Ipv6Address::MakeIpv4MappedAddress(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Packet::PeekHeader(), PROT_NUMBER, ns3::Packet::RemoveHeader(), ns3::IpL4Protocol::RX_CSUM_FAILED, ns3::IpL4Protocol::RX_ENDPOINT_UNREACH, ns3::IpL4Protocol::RX_OK, ns3::Ipv6Header::SetDestination(), and ns3::Ipv6Header::SetSource().

Here is the call graph for this function:

◆ Receive() [2/2]

IpL4Protocol::RxStatus ns3::UdpL4Protocol::Receive	(	Ptr< Packet >	p,
		const Ipv6Header &	header,
		Ptr< Ipv6Interface >	incomingInterface
	)

overridevirtual

Called from lower-level layers to send the packet up in the stack.

Parameters

p	packet to forward up
header	IPv6 Header information
incomingInterface	the Ipv6Interface on which the packet arrived

Returns: Rx status code

Implements ns3::IpL4Protocol.

Definition at line 393 of file udp-l4-protocol.cc.

References ns3::Node::ChecksumEnabled(), ns3::Packet::Copy(), ns3::UdpHeader::EnableChecksums(), ns3::Ipv6Header::GetDestination(), ns3::UdpHeader::GetDestinationPort(), ns3::Ipv6Header::GetSource(), ns3::UdpHeader::GetSourcePort(), ns3::UdpHeader::InitializeChecksum(), ns3::UdpHeader::IsChecksumOk(), ns3::Ipv6Address::IsIpv4MappedAddress(), ns3::Ipv6EndPointDemux::Lookup(), m_endPoints6, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PROT_NUMBER, ns3::Packet::RemoveHeader(), ns3::IpL4Protocol::RX_CSUM_FAILED, ns3::IpL4Protocol::RX_ENDPOINT_UNREACH, and ns3::IpL4Protocol::RX_OK.

Here is the call graph for this function:

◆ ReceiveIcmp() [1/2]

void ns3::UdpL4Protocol::ReceiveIcmp	(	Ipv4Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo,
		Ipv4Address	payloadSource,
		Ipv4Address	payloadDestination,
		const uint8_t	payload[8]
	)

overridevirtual

Called from lower-level layers to send the ICMP packet up in the stack.

Parameters

icmpSource	the source address of the icmp message
icmpTtl	the ttl of the icmp message
icmpType	the 'type' field of the icmp message
icmpCode	the 'code' field of the icmp message
icmpInfo	extra information dependent on the icmp message generated by Icmpv4L4Protocol
payloadSource	the source address of the packet which triggered the icmp message
payloadDestination	the destination address of the packet which triggered the icmp message.
payload	the first 8 bytes of the packet payload which triggered the icmp message.

Reimplemented from ns3::IpL4Protocol.

Definition at line 270 of file udp-l4-protocol.cc.

References ns3::Ipv4EndPoint::ForwardIcmp(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Ipv4EndPointDemux::SimpleLookup().

Here is the call graph for this function:

◆ ReceiveIcmp() [2/2]

void ns3::UdpL4Protocol::ReceiveIcmp	(	Ipv6Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo,
		Ipv6Address	payloadSource,
		Ipv6Address	payloadDestination,
		const uint8_t	payload[8]
	)

overridevirtual

Called from lower-level layers to send the ICMPv6 packet up in the stack.

Parameters

icmpSource	the source address of the icmp message
icmpTtl	the ttl of the icmp message
icmpType	the 'type' field of the icmp message
icmpCode	the 'code' field of the icmp message
icmpInfo	extra information dependent on the icmp message generated by Icmpv6L4Protocol
payloadSource	the source address of the packet which triggered the icmp message
payloadDestination	the destination address of the packet which triggered the icmp message.
payload	the first 8 bytes of the packet payload which triggered the icmp message.

Reimplemented from ns3::IpL4Protocol.

Definition at line 302 of file udp-l4-protocol.cc.

References ns3::Ipv6EndPoint::ForwardIcmp(), m_endPoints6, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Ipv6EndPointDemux::SimpleLookup().

Here is the call graph for this function:

◆ RemoveSocket()

bool ns3::UdpL4Protocol::RemoveSocket ( Ptr< UdpSocketImpl > socket )

Remove a socket from the internal list.

Parameters

socket socket to remove

Returns: true if the socket has been removed

Definition at line 552 of file udp-l4-protocol.cc.

References m_sockets, and NS_LOG_FUNCTION.

◆ Send() [1/4]

void ns3::UdpL4Protocol::Send	(	Ptr< Packet >	packet,
		Ipv4Address	saddr,
		Ipv4Address	daddr,
		uint16_t	sport,
		uint16_t	dport
	)

Send a packet via UDP (IPv4)

Parameters

packet	The packet to send
saddr	The source Ipv4Address
daddr	The destination Ipv4Address
sport	The source port number
dport	The destination port number

Definition at line 432 of file udp-l4-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::UdpHeader::EnableChecksums(), ns3::UdpHeader::InitializeChecksum(), m_downTarget, NS_LOG_FUNCTION, PROT_NUMBER, ns3::UdpHeader::SetDestinationPort(), and ns3::UdpHeader::SetSourcePort().

Here is the call graph for this function:

◆ Send() [2/4]

void ns3::UdpL4Protocol::Send	(	Ptr< Packet >	packet,
		Ipv4Address	saddr,
		Ipv4Address	daddr,
		uint16_t	sport,
		uint16_t	dport,
		Ptr< Ipv4Route >	route
	)

Send a packet via UDP (IPv4)

Parameters

packet	The packet to send
saddr	The source Ipv4Address
daddr	The destination Ipv4Address
sport	The source port number
dport	The destination port number
route	The route

Definition at line 455 of file udp-l4-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::UdpHeader::EnableChecksums(), ns3::UdpHeader::InitializeChecksum(), m_downTarget, NS_LOG_FUNCTION, PROT_NUMBER, ns3::UdpHeader::SetDestinationPort(), and ns3::UdpHeader::SetSourcePort().

Here is the call graph for this function:

◆ Send() [3/4]

void ns3::UdpL4Protocol::Send	(	Ptr< Packet >	packet,
		Ipv6Address	saddr,
		Ipv6Address	daddr,
		uint16_t	sport,
		uint16_t	dport
	)

Send a packet via UDP (IPv6)

Parameters

packet	The packet to send
saddr	The source Ipv4Address
daddr	The destination Ipv4Address
sport	The source port number
dport	The destination port number

Definition at line 479 of file udp-l4-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::UdpHeader::EnableChecksums(), ns3::UdpHeader::InitializeChecksum(), m_downTarget6, NS_LOG_FUNCTION, PROT_NUMBER, ns3::UdpHeader::SetDestinationPort(), and ns3::UdpHeader::SetSourcePort().

Here is the call graph for this function:

◆ Send() [4/4]

void ns3::UdpL4Protocol::Send	(	Ptr< Packet >	packet,
		Ipv6Address	saddr,
		Ipv6Address	daddr,
		uint16_t	sport,
		uint16_t	dport,
		Ptr< Ipv6Route >	route
	)

Send a packet via UDP (IPv6)

Parameters

packet	The packet to send
saddr	The source Ipv4Address
daddr	The destination Ipv4Address
sport	The source port number
dport	The destination port number
route	The route

Definition at line 502 of file udp-l4-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::UdpHeader::EnableChecksums(), ns3::UdpHeader::InitializeChecksum(), m_downTarget6, NS_LOG_FUNCTION, PROT_NUMBER, ns3::UdpHeader::SetDestinationPort(), and ns3::UdpHeader::SetSourcePort().

Here is the call graph for this function:

◆ SetDownTarget()

void ns3::UdpL4Protocol::SetDownTarget ( IpL4Protocol::DownTargetCallback cb )

overridevirtual

This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 case)

Parameters

cb	current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 526 of file udp-l4-protocol.cc.

References m_downTarget, and NS_LOG_FUNCTION.

Referenced by NotifyNewAggregate().

Here is the caller graph for this function:

◆ SetDownTarget6()

void ns3::UdpL4Protocol::SetDownTarget6 ( IpL4Protocol::DownTargetCallback6 cb )

overridevirtual

This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 case)

Parameters

cb	current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 539 of file udp-l4-protocol.cc.

References m_downTarget6, and NS_LOG_FUNCTION.

Referenced by NotifyNewAggregate().

Here is the caller graph for this function:

◆ SetNode()

void ns3::UdpL4Protocol::SetNode ( Ptr< Node > node )

Set node associated with this stack.

Parameters

node the node

Definition at line 84 of file udp-l4-protocol.cc.

References m_node.

Referenced by NotifyNewAggregate().

Here is the caller graph for this function:

Member Data Documentation

◆ m_downTarget

IpL4Protocol::DownTargetCallback ns3::UdpL4Protocol::m_downTarget

private

Callback to send packets over IPv4.

Definition at line 302 of file udp-l4-protocol.h.

Referenced by DoDispose(), GetDownTarget(), NotifyNewAggregate(), Send(), and SetDownTarget().

◆ m_downTarget6

IpL4Protocol::DownTargetCallback6 ns3::UdpL4Protocol::m_downTarget6

private

Callback to send packets over IPv6.

Definition at line 303 of file udp-l4-protocol.h.

Referenced by DoDispose(), GetDownTarget6(), NotifyNewAggregate(), Send(), and SetDownTarget6().

◆ m_endPoints

Ipv4EndPointDemux* ns3::UdpL4Protocol::m_endPoints

private

A list of IPv4 end points.

Definition at line 296 of file udp-l4-protocol.h.

Referenced by Allocate(), DeAllocate(), DoDispose(), Receive(), and ReceiveIcmp().

◆ m_endPoints6

Ipv6EndPointDemux* ns3::UdpL4Protocol::m_endPoints6

private

A list of IPv6 end points.

Definition at line 297 of file udp-l4-protocol.h.

Referenced by Allocate6(), DeAllocate(), DoDispose(), Receive(), and ReceiveIcmp().

◆ m_node

Ptr<Node> ns3::UdpL4Protocol::m_node

private

The node this stack is associated with.

Definition at line 295 of file udp-l4-protocol.h.

Referenced by CreateSocket(), DoDispose(), NotifyNewAggregate(), and SetNode().

◆ m_socketIndex

uint64_t ns3::UdpL4Protocol::m_socketIndex {0}

private

Index of the next socket to be created.

Definition at line 301 of file udp-l4-protocol.h.

Referenced by CreateSocket().

◆ m_sockets

std::unordered_map<uint64_t, Ptr<UdpSocketImpl> > ns3::UdpL4Protocol::m_sockets

private

Unordered map of socket IDs and corresponding sockets.

Definition at line 300 of file udp-l4-protocol.h.

Referenced by CreateSocket(), DoDispose(), GetTypeId(), and RemoveSocket().

◆ PROT_NUMBER

const uint8_t ns3::UdpL4Protocol::PROT_NUMBER = 17

static

protocol number (0x11)

Definition at line 71 of file udp-l4-protocol.h.

Referenced by ns3::OpenFlowSwitchNetDevice::BufferFromPacket(), ns3::IpcsClassifier::Classify(), ns3::EpcTftClassifier::Classify(), ns3::olsr::HelloRegressionTest::CreateNodes(), ns3::olsr::TcRegressionTest::CreateNodes(), ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc(), ns3::UdpSocketImpl::DoSendTo(), GetProtocolNumber(), Receive(), ns3::aodv::RoutingProtocol::RouteInput(), and Send().

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

src/internet/model/udp-l4-protocol.h
src/internet/model/udp-l4-protocol.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UdpL4Protocol() [1/2]

◆ ~UdpL4Protocol()

◆ UdpL4Protocol() [2/2]

Member Function Documentation

◆ Allocate() [1/5]

◆ Allocate() [2/5]

◆ Allocate() [3/5]

◆ Allocate() [4/5]

◆ Allocate() [5/5]

◆ Allocate6() [1/5]

◆ Allocate6() [2/5]

◆ Allocate6() [3/5]

◆ Allocate6() [4/5]

◆ Allocate6() [5/5]

◆ CreateSocket()

◆ DeAllocate() [1/2]

◆ DeAllocate() [2/2]

◆ DoDispose()

◆ GetDownTarget()

◆ GetDownTarget6()

◆ GetProtocolNumber()

◆ GetTypeId()

◆ NotifyNewAggregate()

◆ operator=()

◆ Receive() [1/2]

◆ Receive() [2/2]

◆ ReceiveIcmp() [1/2]

◆ ReceiveIcmp() [2/2]

◆ RemoveSocket()

◆ Send() [1/4]

◆ Send() [2/4]

◆ Send() [3/4]

◆ Send() [4/4]

◆ SetDownTarget()

◆ SetDownTarget6()

◆ SetNode()

Member Data Documentation

◆ m_downTarget

◆ m_downTarget6

◆ m_endPoints

◆ m_endPoints6

◆ m_node

◆ m_socketIndex

◆ m_sockets

◆ PROT_NUMBER