ns-3
ns3::IpL4Protocol Class Reference

L4 Protocol abstract base class. More...

#include <ip-l4-protocol.h>

Inheritance diagram for ns3::IpL4Protocol:
Collaboration diagram for ns3::IpL4Protocol:

List of all members.

Public Types

enum  RxStatus { RX_OK, RX_CSUM_FAILED, RX_ENDPOINT_CLOSED, RX_ENDPOINT_UNREACH }
typedef Callback< void, Ptr
< Packet >, Ipv4Address,
Ipv4Address, uint8_t, Ptr
< Ipv4Route > > 
DownTargetCallback
typedef Callback< void, Ptr
< Packet >, Ipv6Address,
Ipv6Address, uint8_t, Ptr
< Ipv6Route > > 
DownTargetCallback6

Public Member Functions

virtual int GetProtocolNumber (void) const =0
virtual enum RxStatus Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)=0
virtual enum RxStatus Receive (Ptr< Packet > p, Ipv6Address &src, Ipv6Address &dst, Ptr< Ipv6Interface > incomingInterface)=0
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])
virtual void SetDownTarget (DownTargetCallback cb)=0
virtual void SetDownTarget6 (DownTargetCallback6 cb)=0
virtual DownTargetCallback GetDownTarget (void) const =0
virtual DownTargetCallback6 GetDownTarget6 (void) const =0
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::IpL4Protocol.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

Detailed Description

L4 Protocol abstract base class.

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


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, for

Returns:
current Callback for the L4 protocol

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

Referenced by GetTypeId().

TypeId ns3::IpL4Protocol::GetTypeId ( void  )
static

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

Attributes defined for this type:

  • ProtocolNumber: The Ip protocol number.

No TraceSources defined for this type.

Reimplemented from ns3::Object.

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

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

virtual enum RxStatus ns3::IpL4Protocol::Receive ( Ptr< Packet p,
Ipv4Header const &  header,
Ptr< Ipv4Interface incomingInterface 
)
pure 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.

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

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
Parameters:
icmpSourcethe source address of the icmp message
icmpTtlthe ttl of the icmp message
icmpTypethe 'type' field of the icmp message
icmpCodethe 'code' field of the icmp message
icmpInfoextra information dependent on the icmp message generated by Icmpv4L4Protocol
payloadSourcethe source address of the packet which triggered the icmp message
payloadDestinationthe destination address of the packet which triggered the icmp message.
payloadthe first 8 bytes of the udp header of the packet which triggered the icmp message.

Reimplemented in ns3::UdpL4Protocol.

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

Parameters:
cbcurrent Callback for the L4 protocol

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


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