ns3::UdpL4Protocol Class Reference
[Udp]

Implementation of the UDP protocol. More...

#include <udp-l4-protocol.h>

Inheritance diagram for ns3::UdpL4Protocol:

[legend]

Collaboration diagram for ns3::UdpL4Protocol:

[legend]

List of all members.

Public Member Functions
void	SetNode (Ptr< Node > node)
virtual int	GetProtocolNumber (void) const
Ptr< Socket >	CreateSocket (void)
Ipv4EndPoint *	Allocate (void)
Ipv4EndPoint *	Allocate (Ipv4Address address)
Ipv4EndPoint *	Allocate (uint16_t port)
Ipv4EndPoint *	Allocate (Ipv4Address address, uint16_t port)
Ipv4EndPoint *	Allocate (Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort)
void	DeAllocate (Ipv4EndPoint *endPoint)
void	Send (Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport)
	Send a packet via UDP.
void	Send (Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport, Ptr< Ipv4Route > route)
virtual enum Ipv4L4Protocol::RxStatus	Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > interface)
	Receive a packet up the protocol stack.
virtual 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])
	Receive an ICMP packet.
virtual void	SetDownTarget (Ipv4L4Protocol::DownTargetCallback cb)
virtual Ipv4L4Protocol::DownTargetCallback	GetDownTarget (void) const
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::UdpL4Protocol.
Static Public Attributes
static const uint8_t	PROT_NUMBER
Protected Member Functions
virtual void	DoDispose (void)
virtual void	NotifyNewAggregate ()

---

Detailed Description

Implementation of the UDP protocol.

---

Member Function Documentation

Ptr<Socket> ns3::UdpL4Protocol::CreateSocket

(

void

)

Returns:

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

virtual void ns3::UdpL4Protocol::DoDispose

(

void

)

[protected, virtual]

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

Subclasses are expected to implement their real destruction code in an overriden 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.

virtual Ipv4L4Protocol::DownTargetCallback ns3::UdpL4Protocol::GetDownTarget

(

void

)

const [virtual]

This method allows a caller to get the current down target callback set for this L4 protocol, for

Returns:

current Callback for the L4 protocol

Implements ns3::Ipv4L4Protocol.

virtual int ns3::UdpL4Protocol::GetProtocolNumber

(

void

)

const [virtual]

Returns:

the protocol number of this protocol.

Implements ns3::Ipv4L4Protocol.

static TypeId ns3::UdpL4Protocol::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::UdpL4Protocol.

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv4L4Protocol/$ns3::UdpL4Protocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::UdpL4Protocol

Attributes defined for this type:

• SocketList: The list of sockets associated to this protocol.
  • Set with class: ns3::ObjectVectorValue
  • Underlying type: ns3::Ptr< ns3::UdpSocketImpl >
  • Flags: read

Attributes defined in parent class ns3::Ipv4L4Protocol:

• ProtocolNumber: The Ipv4 protocol number.
  • Set with class: ns3::UintegerValue
  • Underlying type: int32_t 18446744071562067968:2147483647
  • Flags: read

No TraceSources defined for this type.

Reimplemented from ns3::Ipv4L4Protocol.

virtual void ns3::UdpL4Protocol::NotifyNewAggregate

(

)

[protected, virtual]

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 overriden 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.

virtual enum Ipv4L4Protocol::RxStatus ns3::UdpL4Protocol::Receive	(	Ptr< Packet >	p,
		Ipv4Header const &	header,
		Ptr< Ipv4Interface >	interface
	)			[virtual]

Receive a packet up the protocol stack.

Parameters:

	p	The Packet to dump the contents into
	header	IPv4 Header information
	interface	the interface from which the packet is coming.

Implements ns3::Ipv4L4Protocol.

virtual 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]
	)			[virtual]

Receive an ICMP packet.

Parameters:

	icmpSource	The IP address of the source of the packet.
	icmpTtl	The time to live from the IP header
	icmpType	The type of the message from the ICMP header
	icmpCode	The message code from the ICMP header
	icmpInfo	32-bit integer carrying informational value of varying semantics.
	payloadSource	The IP source address from the IP header of the packet
	payloadDestination	The IP destination address from the IP header of the packet
	payload	Payload of the ICMP packet

Reimplemented from ns3::Ipv4L4Protocol.

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

Send a packet via UDP.

Parameters:

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

virtual void ns3::UdpL4Protocol::SetDownTarget

(

Ipv4L4Protocol::DownTargetCallback

cb

)

[virtual]

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

Parameters:

cb

current Callback for the L4 protocol

Implements ns3::Ipv4L4Protocol.

---

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

• src/internet-stack/udp-l4-protocol.h
• doc/introspected-doxygen.h