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

#include <tcp-l4-protocol.h>

Inheritance diagram for ns3::TcpL4Protocol:

Public Member Functions
	TcpL4Protocol ()
	Constructor.

Ipv4EndPoint *	Allocate (void)

Ipv4EndPoint *	Allocate (Ipv4Address address)

Ipv4EndPoint *	Allocate (uint16_t port)

Ipv4EndPoint *	Allocate (Ipv4Address address, uint16_t port)

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

Ipv6EndPoint *	Allocate6 (void)

Ipv6EndPoint *	Allocate6 (Ipv6Address address)

Ipv6EndPoint *	Allocate6 (uint16_t port)

Ipv6EndPoint *	Allocate6 (Ipv6Address address, uint16_t port)

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

Ptr< Socket >	CreateSocket (void)

Ptr< Socket >	CreateSocket (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::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

SimpleRefCount &	operator= (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 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)

TcpL4Protocol &	operator= (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

Ipv4EndPointDemux *	m_endPoints

Ipv6EndPointDemux *	m_endPoints6

Ptr< Node >	m_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

RttEstimatorType: Type of RttEstimator objects.
- Set with class: TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::RttMeanDeviation
- Flags: construct write read
SocketType: Socket type of TCP objects.
- Set with class: TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::TcpNewReno
- Flags: construct write read
SocketList: The list of sockets associated to this protocol.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::TcpSocketBase >
- Flags: read

Attributes defined in parent class ns3::IpL4Protocol

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 56 of file tcp-l4-protocol.h.

Member Function Documentation

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

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(), and NS_LOG_FUNCTION_NOARGS.

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

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.

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::MakeCallback(), ns3::Object::NotifyNewAggregate(), ns3::Ipv4::Send(), ns3::Ipv6L3Protocol::Send(), and SetDownTarget().

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

virtual

Receive a packet up the protocol stack.

Parameters

p	The Packet to dump the contents into
header	IPv4 Header information
incomingInterface	The Ipv4Interface it was received on

Implements ns3::IpL4Protocol.

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

References ns3::Node::ChecksumEnabled(), ns3::TcpHeader::EnableChecksums(), ns3::TcpHeader::GetAckNumber(), ns3::Ipv4Header::GetDestination(), ns3::TcpHeader::GetDestinationPort(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), ns3::TcpHeader::GetSourcePort(), ns3::TcpHeader::InitializeChecksum(), ns3::TcpHeader::IsChecksumOk(), ns3::Ipv6Address::MakeIpv4MappedAddress(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Packet::PeekHeader(), ns3::Ipv4Address::Print(), ns3::Ipv6Header::SetDestinationAddress(), ns3::TcpHeader::SetFlags(), and ns3::Ipv6Header::SetSourceAddress().

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

icmpSource	The IP address of the source of the packet.
icmpTtl	The time to live from the IP header
icmpType	The type of the message from the ICMP header
icmpCode	The message code from the ICMP header
icmpInfo	32-bit integer carrying informational value of varying semantics.
payloadSource	The IP source address from the IP header of the packet
payloadDestination	The IP destination address from the IP header of the packet
payload	Payload of the ICMP packet

Reimplemented from ns3::IpL4Protocol.

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

References NS_LOG_DEBUG, and NS_LOG_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

packet	The packet to send
saddr	The source Ipv4Address
daddr	The destination Ipv4Address
sport	The source port number
dport	The destination port number
oif	The output interface bound. Defaults to null (unspecified).

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

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

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

cb	current Callback for the L4 protocol

Implements ns3::IpL4Protocol.

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

Referenced by NotifyNewAggregate().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::IpL4Protocol

Member Function Documentation