L4 Protocol abstract base class. More...

#include "ip-l4-protocol.h"

Inheritance diagram for ns3::IpL4Protocol:

Collaboration diagram for ns3::IpL4Protocol:

Public Types
typedef Callback< void, Ptr< Packet >, Ipv4Address, Ipv4Address, uint8_t, Ptr< Ipv4Route > >	DownTargetCallback
	callback to send packets over IPv4

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

enum	RxStatus { RX_OK , RX_CSUM_FAILED , RX_ENDPOINT_CLOSED , RX_ENDPOINT_UNREACH }
	Rx status codes. More...

Public Member Functions
	~IpL4Protocol () override

virtual DownTargetCallback	GetDownTarget () const =0
	This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 case)

virtual DownTargetCallback6	GetDownTarget6 () const =0
	This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 case)

virtual int	GetProtocolNumber () const =0
	Returns the protocol number of this protocol.

virtual RxStatus	Receive (Ptr< Packet > p, const Ipv4Header &header, Ptr< Ipv4Interface > incomingInterface)=0
	Called from lower-level layers to send the packet up in the stack.

virtual RxStatus	Receive (Ptr< Packet > p, const Ipv6Header &header, Ptr< Ipv6Interface > incomingInterface)=0
	Called from lower-level layers to send the packet up in the 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])
	Called from lower-level layers to send the ICMP packet up in the stack.

virtual 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])
	Called from lower-level layers to send the ICMPv6 packet up in the stack.

virtual void	SetDownTarget (DownTargetCallback cb)=0
	This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 case)

virtual void	SetDownTarget6 (DownTargetCallback6 cb)=0
	This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 case)

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

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

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

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

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

L4 Protocol abstract base class.

This is an abstract base class for layer four protocols which use IP as the network layer.

Definition at line 40 of file ip-l4-protocol.h.

Member Typedef Documentation

◆ DownTargetCallback

typedef Callback<void, Ptr<Packet>, Ipv4Address, Ipv4Address, uint8_t, Ptr<Ipv4Route> > ns3::IpL4Protocol::DownTargetCallback

callback to send packets over IPv4

Definition at line 142 of file ip-l4-protocol.h.

◆ DownTargetCallback6

typedef Callback<void, Ptr<Packet>, Ipv6Address, Ipv6Address, uint8_t, Ptr<Ipv6Route> > ns3::IpL4Protocol::DownTargetCallback6

callback to send packets over IPv6

Definition at line 147 of file ip-l4-protocol.h.

Member Enumeration Documentation

◆ RxStatus

enum ns3::IpL4Protocol::RxStatus

Rx status codes.

Enumerator
RX_OK
RX_CSUM_FAILED
RX_ENDPOINT_CLOSED
RX_ENDPOINT_UNREACH

Definition at line 46 of file ip-l4-protocol.h.

Constructor & Destructor Documentation

◆ ~IpL4Protocol()

ns3::IpL4Protocol::~IpL4Protocol ( )

override

Definition at line 39 of file ip-l4-protocol.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetDownTarget()

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

◆ GetDownTarget6()

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

◆ GetProtocolNumber()

virtual int ns3::IpL4Protocol::GetProtocolNumber ( ) const

pure virtual

Returns the protocol number of this protocol.

Returns: the protocol number.

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::IpL4Protocol::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 25 of file ip-l4-protocol.cc.

References ns3::TypeId::ATTR_GET, GetProtocolNumber(), ns3::MakeIntegerAccessor(), ns3::MakeIntegerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Receive() [1/2]

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

◆ Receive() [2/2]

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

◆ ReceiveIcmp() [1/2]

void ns3::IpL4Protocol::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

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 in ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

Definition at line 45 of file ip-l4-protocol.cc.

References NS_LOG_FUNCTION.

◆ ReceiveIcmp() [2/2]

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

virtual

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 in ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

Definition at line 60 of file ip-l4-protocol.cc.

References NS_LOG_FUNCTION.

◆ SetDownTarget()

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

◆ SetDownTarget6()

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

pure virtual

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

Implemented in ns3::dsr::DsrRouting, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DownTargetCallback

◆ DownTargetCallback6

Member Enumeration Documentation

◆ RxStatus

Constructor & Destructor Documentation

◆ ~IpL4Protocol()

Member Function Documentation

◆ GetDownTarget()

◆ GetDownTarget6()

◆ GetProtocolNumber()

◆ GetTypeId()

◆ Receive() [1/2]

◆ Receive() [2/2]

◆ ReceiveIcmp() [1/2]

◆ ReceiveIcmp() [2/2]

◆ SetDownTarget()

◆ SetDownTarget6()