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

Public Member Functions
virtual	~IpL4Protocol ()

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

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

virtual int	GetProtocolNumber (void) const =0

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

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

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

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

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) More...

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) More...

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

L4 Protocol abstract base class.

Doxygen introspection did not find any typical Config paths.

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

Attributes

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

No TraceSources are defined for this type.

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

Member Typedef Documentation

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

callback to send packets over IPv4

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

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

callback to send packets over IPv6

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

Member Enumeration Documentation

enum ns3::IpL4Protocol::RxStatus

Rx status codes.

Enumerator
RX_OK
RX_CSUM_FAILED
RX_ENDPOINT_CLOSED
RX_ENDPOINT_UNREACH

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

Constructor & Destructor Documentation

ns3::IpL4Protocol::~IpL4Protocol ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

virtual DownTargetCallback ns3::IpL4Protocol::GetDownTarget ( void ) 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::Icmpv6L4Protocol, ns3::dsr::DsrRouting, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

virtual DownTargetCallback6 ns3::IpL4Protocol::GetDownTarget6 ( void ) 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::Icmpv6L4Protocol, ns3::dsr::DsrRouting, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

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

pure virtual

Returns: the protocol number of this protocol.

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

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::IpL4Protocol::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetProtocolNumber(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

virtual enum RxStatus ns3::IpL4Protocol::Receive	(	Ptr< Packet >	p,
		Ipv6Header const &	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::Icmpv6L4Protocol, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

virtual enum RxStatus ns3::IpL4Protocol::Receive	(	Ptr< Packet >	p,
		Ipv4Header const &	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::Icmpv6L4Protocol, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

Referenced by ns3::Ipv4L3Protocol::LocalDeliver(), and ns3::Ipv6L3Protocol::LocalDeliver().

Here is the caller graph for this function:

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

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

References NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::Forward().

Here is the caller graph for this function:

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

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

References NS_LOG_FUNCTION.

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::Icmpv6L4Protocol, ns3::dsr::DsrRouting, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

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::Icmpv6L4Protocol, ns3::dsr::DsrRouting, ns3::UdpL4Protocol, ns3::TcpL4Protocol, ns3::NscTcpL4Protocol, and ns3::Icmpv4L4Protocol.

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

Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation