A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::Icmpv4L4Protocol Class Reference

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::Icmpv4L4Protocol:

Public Member Functions

virtual
IpL4Protocol::DownTargetCallback 
GetDownTarget (void) const
 
virtual
IpL4Protocol::DownTargetCallback6 
GetDownTarget6 (void) const
 
virtual int GetProtocolNumber (void) const
 
virtual enum IpL4Protocol::RxStatus Receive (Ptr< Packet > p, Ipv6Header const &header, Ptr< Ipv6Interface > incomingInterface)
 
virtual enum IpL4Protocol::RxStatus Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)
 
void SendDestUnreachFragNeeded (Ipv4Header header, Ptr< const Packet > orgData, uint16_t nextHopMtu)
 
void SendDestUnreachPort (Ipv4Header header, Ptr< const Packet > orgData)
 
void SendTimeExceededTtl (Ipv4Header header, Ptr< const Packet > orgData)
 
virtual void SetDownTarget (IpL4Protocol::DownTargetCallback cb)
 
virtual void SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb)
 
void SetNode (Ptr< Node > node)
 
- Public Member Functions inherited from ns3::IpL4Protocol
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])
 
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])
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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 uint16_t GetStaticProtocolNumber (void)
 
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::IpL4Protocol
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Static Public Attributes

static const uint8_t PROT_NUMBER = 1
 

Protected Member Functions

virtual void NotifyNewAggregate ()
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Private Member Functions

virtual void DoDispose (void)
 
void Forward (Ipv4Address source, Icmpv4Header icmp, uint32_t info, Ipv4Header ipHeader, const uint8_t payload[8])
 
void HandleDestUnreach (Ptr< Packet > p, Icmpv4Header header, Ipv4Address source, Ipv4Address destination)
 
void HandleEcho (Ptr< Packet > p, Icmpv4Header header, Ipv4Address source, Ipv4Address destination)
 
void HandleTimeExceeded (Ptr< Packet > p, Icmpv4Header icmp, Ipv4Address source, Ipv4Address destination)
 
void SendDestUnreach (Ipv4Header header, Ptr< const Packet > orgData, uint8_t code, uint16_t nextHopMtu)
 
void SendMessage (Ptr< Packet > packet, Ipv4Address dest, uint8_t type, uint8_t code)
 
void SendMessage (Ptr< Packet > packet, Ipv4Address source, Ipv4Address dest, uint8_t type, uint8_t code, Ptr< Ipv4Route > route)
 

Private Attributes

IpL4Protocol::DownTargetCallback m_downTarget
 
Ptr< Nodem_node
 

Additional Inherited Members

- Public Types inherited from ns3::IpL4Protocol
typedef Callback< void, Ptr
< Packet >, Ipv4Address,
Ipv4Address, uint8_t, Ptr
< Ipv4Route > > 
DownTargetCallback
 
typedef Callback< void, Ptr
< Packet >, Ipv6Address,
Ipv6Address, uint8_t, Ptr
< Ipv6Route > > 
DownTargetCallback6
 
enum  RxStatus { RX_OK, RX_CSUM_FAILED, RX_ENDPOINT_CLOSED, RX_ENDPOINT_UNREACH }
 

Detailed Description

Config Paths

ns3::Icmpv4L4Protocol is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/$ns3::Icmpv4L4Protocol

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 14 of file icmpv4-l4-protocol.h.

Member Function Documentation

void ns3::Icmpv4L4Protocol::DoDispose ( void  )
privatevirtual

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.

Definition at line 266 of file icmpv4-l4-protocol.cc.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.

IpL4Protocol::DownTargetCallback ns3::Icmpv4L4Protocol::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::IpL4Protocol.

Definition at line 288 of file icmpv4-l4-protocol.cc.

References NS_LOG_FUNCTION.

int ns3::Icmpv4L4Protocol::GetProtocolNumber ( void  ) const
virtual
Returns
the protocol number of this protocol.

Implements ns3::IpL4Protocol.

Definition at line 85 of file icmpv4-l4-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Icmpv4L4Protocol::NotifyNewAggregate ( void  )
protectedvirtual

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.

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

Reimplemented from ns3::Object.

Definition at line 55 of file icmpv4-l4-protocol.cc.

References ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, ns3::Ipv4::Send(), and SetDownTarget().

enum IpL4Protocol::RxStatus ns3::Icmpv4L4Protocol::Receive ( Ptr< Packet p,
Ipv4Header const &  header,
Ptr< Ipv4Interface incomingInterface 
)
virtual
Parameters
ppacket to forward up
headerIPv4 Header information
incomingInterfacethe Ipv4Interface on which the packet arrived

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

Implements ns3::IpL4Protocol.

Definition at line 233 of file icmpv4-l4-protocol.cc.

References ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetSource(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Packet::RemoveHeader().

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

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

Parameters
cbcurrent Callback for the L4 protocol

Implements ns3::IpL4Protocol.

Definition at line 275 of file icmpv4-l4-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by NotifyNewAggregate().


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