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

A layer between the sockets interface and IP. More...

#include <tcp-l4-protocol.h>

+ Inheritance diagram for ns3::TcpL4Protocol:
+ Collaboration diagram for ns3::TcpL4Protocol:

Public Member Functions

 TcpL4Protocol ()
 Constructor. More...
 
virtual ~TcpL4Protocol ()
 
Ipv4EndPointAllocate (void)
 
Ipv4EndPointAllocate (Ipv4Address address)
 
Ipv4EndPointAllocate (uint16_t port)
 
Ipv4EndPointAllocate (Ipv4Address address, uint16_t port)
 
Ipv4EndPointAllocate (Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort)
 
Ipv6EndPointAllocate6 (void)
 
Ipv6EndPointAllocate6 (Ipv6Address address)
 
Ipv6EndPointAllocate6 (uint16_t port)
 
Ipv6EndPointAllocate6 (Ipv6Address address, uint16_t port)
 
Ipv6EndPointAllocate6 (Ipv6Address localAddress, uint16_t localPort, Ipv6Address peerAddress, uint16_t peerPort)
 
Ptr< SocketCreateSocket (void)
 
Ptr< SocketCreateSocket (TypeId socketTypeId)
 
void DeAllocate (Ipv4EndPoint *endPoint)
 
void DeAllocate (Ipv6EndPoint *endPoint)
 
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 > interface)
 
virtual enum IpL4Protocol::RxStatus Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)
 Receive a packet up the protocol 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])
 Receive an ICMP packet. 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])
 
void Send (Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport, Ptr< NetDevice > oif=0)
 Send a packet via TCP. More...
 
void Send (Ptr< Packet > packet, Ipv6Address saddr, Ipv6Address daddr, uint16_t sport, uint16_t dport, Ptr< NetDevice > oif=0)
 
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 ~IpL4Protocol ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~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 ()
 
 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
virtual ~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 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 = 6
 

Protected Member Functions

virtual void DoDispose (void)
 
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

 TcpL4Protocol (const TcpL4Protocol &o)
 
TcpL4Protocoloperator= (const TcpL4Protocol &o)
 
void SendPacket (Ptr< Packet >, const TcpHeader &, Ipv4Address, Ipv4Address, Ptr< NetDevice > oif=0)
 
void SendPacket (Ptr< Packet >, const TcpHeader &, Ipv6Address, Ipv6Address, Ptr< NetDevice > oif=0)
 

Private Attributes

IpL4Protocol::DownTargetCallback m_downTarget
 
IpL4Protocol::DownTargetCallback6 m_downTarget6
 
Ipv4EndPointDemuxm_endPoints
 
Ipv6EndPointDemuxm_endPoints6
 
Ptr< Nodem_node
 
TypeId m_rttTypeId
 
std::vector< Ptr< TcpSocketBase > > m_sockets
 
TypeId m_socketTypeId
 

Friends

class TcpSocketBase
 

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

A layer between the sockets interface and IP.

This class allocates "endpoint" objects (ns3::Ipv4EndPoint) for TCP, and SHOULD checksum packets its receives from the socket layer going down the stack , but currently checksumming is disabled. It also receives packets from IP, and forwards them up to the endpoints.

Config Paths

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

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

Attributes

Attributes defined in parent class ns3::IpL4Protocol

  • ProtocolNumber: The Ip protocol number.

No TraceSources are defined for this type.

Definition at line 56 of file tcp-l4-protocol.h.

Constructor & Destructor Documentation

ns3::TcpL4Protocol::TcpL4Protocol ( )

Constructor.

Definition at line 89 of file tcp-l4-protocol.cc.

References NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.

ns3::TcpL4Protocol::~TcpL4Protocol ( )
virtual

Definition at line 96 of file tcp-l4-protocol.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::TcpL4Protocol::TcpL4Protocol ( const TcpL4Protocol o)
private

Member Function Documentation

Ipv4EndPoint * ns3::TcpL4Protocol::Allocate ( void  )

Definition at line 202 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::TcpL4Protocol::Allocate ( Ipv4Address  address)

Definition at line 209 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::TcpL4Protocol::Allocate ( uint16_t  port)

Definition at line 216 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::TcpL4Protocol::Allocate ( Ipv4Address  address,
uint16_t  port 
)

Definition at line 223 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv4EndPoint * ns3::TcpL4Protocol::Allocate ( Ipv4Address  localAddress,
uint16_t  localPort,
Ipv4Address  peerAddress,
uint16_t  peerPort 
)

Definition at line 230 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6EndPoint * ns3::TcpL4Protocol::Allocate6 ( void  )

Definition at line 246 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

Ipv6EndPoint * ns3::TcpL4Protocol::Allocate6 ( Ipv6Address  address)

Definition at line 253 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6EndPoint * ns3::TcpL4Protocol::Allocate6 ( uint16_t  port)

Definition at line 260 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6EndPoint * ns3::TcpL4Protocol::Allocate6 ( Ipv6Address  address,
uint16_t  port 
)

Definition at line 267 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ipv6EndPoint * ns3::TcpL4Protocol::Allocate6 ( Ipv6Address  localAddress,
uint16_t  localPort,
Ipv6Address  peerAddress,
uint16_t  peerPort 
)

Definition at line 274 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::Allocate(), m_endPoints6, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ptr< Socket > ns3::TcpL4Protocol::CreateSocket ( void  )
Returns
A smart Socket pointer to a TcpSocket allocated by this instance of the TCP protocol

Definition at line 196 of file tcp-l4-protocol.cc.

References m_socketTypeId.

Ptr< Socket > ns3::TcpL4Protocol::CreateSocket ( TypeId  socketTypeId)
void ns3::TcpL4Protocol::DeAllocate ( Ipv4EndPoint endPoint)

Definition at line 239 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPointDemux::DeAllocate(), m_endPoints, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::TcpL4Protocol::DeAllocate ( Ipv6EndPoint endPoint)

Definition at line 283 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPointDemux::DeAllocate(), m_endPoints6, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::TcpL4Protocol::DoDispose ( void  )
protectedvirtual

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 155 of file tcp-l4-protocol.cc.

References ns3::Object::DoDispose(), m_downTarget, m_downTarget6, m_endPoints, m_endPoints6, m_node, m_sockets, NS_LOG_FUNCTION_NOARGS, and ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify().

+ Here is the call graph for this function:

IpL4Protocol::DownTargetCallback ns3::TcpL4Protocol::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 708 of file tcp-l4-protocol.cc.

References m_downTarget.

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

Implements ns3::IpL4Protocol.

Definition at line 720 of file tcp-l4-protocol.cc.

References m_downTarget6.

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

Implements ns3::IpL4Protocol.

Definition at line 149 of file tcp-l4-protocol.cc.

References PROT_NUMBER.

TypeId ns3::TcpL4Protocol::GetTypeId ( void  )
static
void ns3::TcpL4Protocol::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 113 of file tcp-l4-protocol.cc.

References ns3::Object::AggregateObject(), ns3::Object::GetObject(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_downTarget, m_downTarget6, m_node, ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), ns3::Ipv4::Send(), ns3::Ipv6L3Protocol::Send(), SetDownTarget(), SetDownTarget6(), and SetNode().

+ Here is the call graph for this function:

TcpL4Protocol& ns3::TcpL4Protocol::operator= ( const TcpL4Protocol o)
private
void ns3::TcpL4Protocol::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
icmpSourceThe IP address of the source of the packet.
icmpTtlThe time to live from the IP header
icmpTypeThe type of the message from the ICMP header
icmpCodeThe message code from the ICMP header
icmpInfo32-bit integer carrying informational value of varying semantics.
payloadSourceThe IP source address from the IP header of the packet
payloadDestinationThe IP destination address from the IP header of the packet
payloadPayload of the ICMP packet

Reimplemented from ns3::IpL4Protocol.

Definition at line 290 of file tcp-l4-protocol.cc.

References ns3::Ipv4EndPoint::ForwardIcmp(), m_endPoints, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Ipv4EndPointDemux::SimpleLookup().

+ Here is the call graph for this function:

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

Reimplemented from ns3::IpL4Protocol.

Definition at line 317 of file tcp-l4-protocol.cc.

References ns3::Ipv6EndPoint::ForwardIcmp(), m_endPoints6, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Ipv6EndPointDemux::SimpleLookup().

+ Here is the call graph for this function:

void ns3::TcpL4Protocol::Send ( Ptr< Packet packet,
Ipv4Address  saddr,
Ipv4Address  daddr,
uint16_t  sport,
uint16_t  dport,
Ptr< NetDevice oif = 0 
)

Send a packet via TCP.

Parameters
packetThe packet to send
saddrThe source Ipv4Address
daddrThe destination Ipv4Address
sportThe source port number
dportThe destination port number
oifThe output interface bound. Defaults to null (unspecified).

Definition at line 514 of file tcp-l4-protocol.cc.

References ns3::TcpHeader::ACK, ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::TcpHeader::EnableChecksums(), ns3::Object::GetObject(), ns3::TcpHeader::InitializeChecksum(), m_node, NS_LOG_ERROR, NS_LOG_FUNCTION, PROT_NUMBER, ns3::TcpHeader::SetAckNumber(), ns3::Ipv4Header::SetDestination(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::Ipv4Header::SetProtocol(), and ns3::TcpHeader::SetSourcePort().

+ Here is the call graph for this function:

void ns3::TcpL4Protocol::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 702 of file tcp-l4-protocol.cc.

References m_downTarget.

Referenced by NotifyNewAggregate().

+ Here is the caller graph for this function:

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

Implements ns3::IpL4Protocol.

Definition at line 714 of file tcp-l4-protocol.cc.

References m_downTarget6.

Referenced by NotifyNewAggregate().

+ Here is the caller graph for this function:

void ns3::TcpL4Protocol::SetNode ( Ptr< Node node)

Definition at line 102 of file tcp-l4-protocol.cc.

References m_node.

Referenced by NotifyNewAggregate().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class TcpSocketBase
friend

Definition at line 162 of file tcp-l4-protocol.h.

Member Data Documentation

IpL4Protocol::DownTargetCallback ns3::TcpL4Protocol::m_downTarget
private
IpL4Protocol::DownTargetCallback6 ns3::TcpL4Protocol::m_downTarget6
private
Ipv4EndPointDemux* ns3::TcpL4Protocol::m_endPoints
private

Definition at line 157 of file tcp-l4-protocol.h.

Referenced by Allocate(), DeAllocate(), DoDispose(), Receive(), and ReceiveIcmp().

Ipv6EndPointDemux* ns3::TcpL4Protocol::m_endPoints6
private

Definition at line 158 of file tcp-l4-protocol.h.

Referenced by Allocate6(), DeAllocate(), DoDispose(), Receive(), and ReceiveIcmp().

Ptr<Node> ns3::TcpL4Protocol::m_node
private
TypeId ns3::TcpL4Protocol::m_rttTypeId
private

Definition at line 159 of file tcp-l4-protocol.h.

Referenced by CreateSocket(), and GetTypeId().

std::vector<Ptr<TcpSocketBase> > ns3::TcpL4Protocol::m_sockets
private

Definition at line 170 of file tcp-l4-protocol.h.

Referenced by CreateSocket(), DoDispose(), and GetTypeId().

TypeId ns3::TcpL4Protocol::m_socketTypeId
private

Definition at line 160 of file tcp-l4-protocol.h.

Referenced by CreateSocket(), and GetTypeId().

const uint8_t ns3::TcpL4Protocol::PROT_NUMBER = 6
static

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