ns3::TcpSocketBase Class Reference

A base class for implementation of a stream socket using TCP. More...

#include <tcp-socket-base.h>

Inheritance diagram for ns3::TcpSocketBase:

Public Member Functions
	TcpSocketBase (void)
	TcpSocketBase (const TcpSocketBase &sock)
virtual int	Bind (void)
virtual int	Bind (const Address &address)
virtual int	Bind6 (void)
	Allocate a local IPv6 endpoint for this socket. More...
virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
virtual int	Close (void)
virtual int	Connect (const Address &address)
virtual enum SocketErrno	GetErrno (void) const
virtual Ptr< Node >	GetNode (void) const
virtual uint32_t	GetRxAvailable (void) const
virtual enum SocketType	GetSocketType (void) const
virtual int	GetSockName (Address &address) const
virtual uint32_t	GetTxAvailable (void) const
virtual int	Listen (void)
virtual Ptr< Packet >	Recv (uint32_t maxSize, uint32_t flags)
virtual Ptr< Packet >	RecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)
virtual int	Send (Ptr< Packet > p, uint32_t flags)
virtual int	SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)
virtual void	SetNode (Ptr< Node > node)
virtual void	SetRtt (Ptr< RttEstimator > rtt)
virtual void	SetTcp (Ptr< TcpL4Protocol > tcp)
virtual int	ShutdownRecv (void)
virtual int	ShutdownSend (void)
Public Member Functions inherited from ns3::Socket
Ptr< NetDevice >	GetBoundNetDevice ()
	Returns socket's bound netdevice, if any. More...
uint8_t	GetIpTos (void) const
virtual uint8_t	GetIpTtl (void) const
virtual uint8_t	GetIpv6HopLimit (void) const
uint8_t	GetIpv6Tclass (void) const
bool	IsIpRecvTos (void) const
	Ask if the socket is currently passing information about IP Type of Service up the stack. More...
bool	IsIpRecvTtl (void) const
	Ask if the socket is currently passing information about IP_TTL up the stack. More...
bool	IsIpv6RecvHopLimit (void) const
	Ask if the socket is currently passing information about IPv6 Hop Limit up the stack. More...
bool	IsIpv6RecvTclass (void) const
	Ask if the socket is currently passing information about IPv6 Traffic Class up the stack. More...
bool	IsRecvPktInfo () const
	Get status indicating whether enable/disable packet information to socket. More...
Ptr< Packet >	Recv (void)
	Read a single packet from the socket. More...
int	Recv (uint8_t *buf, uint32_t size, uint32_t flags)
	Recv data (or dummy data) from the remote host. More...
Ptr< Packet >	RecvFrom (Address &fromAddress)
	Read a single packet from the socket and retrieve the sender address. More...
int	RecvFrom (uint8_t *buf, uint32_t size, uint32_t flags, Address &fromAddress)
	Read a single packet from the socket and retrieve the sender address. More...
int	Send (Ptr< Packet > p)
	Send data (or dummy data) to the remote host. More...
int	Send (const uint8_t *buf, uint32_t size, uint32_t flags)
	Send data (or dummy data) to the remote host. More...
int	SendTo (const uint8_t *buf, uint32_t size, uint32_t flags, const Address &address)
	Send data to a specified peer. More...
void	SetAcceptCallback (Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
	Accept connection requests from remote hosts. More...
void	SetCloseCallbacks (Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
	Detect socket recv() events such as graceful shutdown or error. More...
void	SetConnectCallback (Callback< void, Ptr< Socket > > connectionSucceeded, Callback< void, Ptr< Socket > > connectionFailed)
	Specify callbacks to allow the caller to determine if the connection succeeds of fails. More...
void	SetDataSentCallback (Callback< void, Ptr< Socket >, uint32_t > dataSent)
	Notify application when a packet has been sent from transport protocol (non-standard socket call) More...
void	SetIpRecvTos (bool ipv4RecvTos)
	Tells a socket to pass information about IP Type of Service up the stack. More...
void	SetIpRecvTtl (bool ipv4RecvTtl)
	Tells a socket to pass information about IP_TTL up the stack. More...
void	SetIpTos (uint8_t ipTos)
virtual void	SetIpTtl (uint8_t ipTtl)
virtual void	SetIpv6HopLimit (uint8_t ipHopLimit)
void	SetIpv6RecvHopLimit (bool ipv6RecvHopLimit)
	Tells a socket to pass information about IPv6 Hop Limit up the stack. More...
void	SetIpv6RecvTclass (bool ipv6RecvTclass)
	Tells a socket to pass information about IPv6 Traffic Class up the stack. More...
void	SetIpv6Tclass (int ipTclass)
void	SetRecvCallback (Callback< void, Ptr< Socket > >)
	Notify application when new data is available to be read. More...
void	SetRecvPktInfo (bool flag)
	Enable/Disable receive packet information to socket. More...
void	SetSendCallback (Callback< void, Ptr< Socket >, uint32_t > sendCb)
	Notify application when space in transmit buffer is added. More...
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::TcpSocket
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Socket
static Ptr< Socket >	CreateSocket (Ptr< Node > node, TypeId tid)
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)

Protected Member Functions
virtual void	AddOptions (TcpHeader &)
virtual uint16_t	AdvertisedWindowSize (void)
virtual uint32_t	AvailableWindow (void)
virtual uint32_t	BytesInFlight (void)
void	CancelAllTimers (void)
void	CloseAndNotify (void)
void	CompleteFork (Ptr< Packet >, const TcpHeader &, const Address &fromAddress, const Address &toAdress)
void	ConnectionSucceeded (void)
void	DeallocateEndPoint (void)
virtual void	DelAckTimeout (void)
void	Destroy (void)
void	Destroy6 (void)
int	DoClose (void)
int	DoConnect (void)
virtual void	DoForwardUp (Ptr< Packet > packet, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface)
virtual void	DoForwardUp (Ptr< Packet > packet, Ipv6Header header, uint16_t port)
void	DoPeerClose (void)
virtual void	DoRetransmit (void)
virtual void	DupAck (const TcpHeader &t, uint32_t count)=0
virtual void	EstimateRtt (const TcpHeader &)
virtual Ptr< TcpSocketBase >	Fork (void)=0
void	ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
void	ForwardIcmp6 (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
void	ForwardUp (Ptr< Packet > packet, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface)
void	ForwardUp6 (Ptr< Packet > packet, Ipv6Header header, uint16_t port)
virtual bool	GetAllowBroadcast (void) const
	Query whether broadcast datagram transmissions are allowed. More...
virtual uint32_t	GetConnCount (void) const
virtual Time	GetConnTimeout (void) const
virtual uint32_t	GetDelAckMaxCount (void) const
virtual Time	GetDelAckTimeout (void) const
virtual uint32_t	GetInitialCwnd (void) const =0
virtual Time	GetPersistTimeout (void) const
virtual uint32_t	GetRcvBufSize (void) const
virtual uint32_t	GetSegSize (void) const
virtual uint32_t	GetSndBufSize (void) const
virtual uint32_t	GetSSThresh (void) const =0
virtual bool	GetTcpNoDelay (void) const
virtual void	LastAckTimeout (void)
virtual void	NewAck (SequenceNumber32 const &seq)
bool	OutOfRange (SequenceNumber32 head, SequenceNumber32 tail) const
void	PeerClose (Ptr< Packet >, const TcpHeader &)
virtual void	PersistTimeout (void)
void	ProcessClosing (Ptr< Packet >, const TcpHeader &)
void	ProcessEstablished (Ptr< Packet >, const TcpHeader &)
void	ProcessLastAck (Ptr< Packet >, const TcpHeader &)
void	ProcessListen (Ptr< Packet >, const TcpHeader &, const Address &, const Address &)
void	ProcessSynRcvd (Ptr< Packet >, const TcpHeader &, const Address &, const Address &)
void	ProcessSynSent (Ptr< Packet >, const TcpHeader &)
void	ProcessWait (Ptr< Packet >, const TcpHeader &)
virtual void	ReadOptions (const TcpHeader &)
virtual void	ReceivedAck (Ptr< Packet >, const TcpHeader &)
virtual void	ReceivedData (Ptr< Packet >, const TcpHeader &)
virtual void	Retransmit (void)
virtual void	ReTxTimeout (void)
uint32_t	SendDataPacket (SequenceNumber32 seq, uint32_t maxSize, bool withAck)
void	SendEmptyPacket (uint8_t flags)
bool	SendPendingData (bool withAck=false)
void	SendRST (void)
virtual bool	SetAllowBroadcast (bool allowBroadcast)
	Configure whether broadcast datagram transmissions are allowed. More...
virtual void	SetConnCount (uint32_t count)
virtual void	SetConnTimeout (Time timeout)
virtual void	SetDelAckMaxCount (uint32_t count)
virtual void	SetDelAckTimeout (Time timeout)
virtual void	SetInitialCwnd (uint32_t cwnd)=0
virtual void	SetPersistTimeout (Time timeout)
virtual void	SetRcvBufSize (uint32_t size)
virtual void	SetSegSize (uint32_t size)
virtual void	SetSndBufSize (uint32_t size)
virtual void	SetSSThresh (uint32_t threshold)=0
virtual void	SetTcpNoDelay (bool noDelay)
int	SetupCallback (void)
int	SetupEndpoint (void)
int	SetupEndpoint6 (void)
void	TimeWait (void)
virtual uint32_t	UnAckDataCount (void)
virtual uint32_t	Window (void)
Protected Member Functions inherited from ns3::Socket
virtual void	DoDispose (void)
bool	IsManualIpTos (void) const
bool	IsManualIpTtl (void) const
bool	IsManualIpv6HopLimit (void) const
bool	IsManualIpv6Tclass (void) const
void	NotifyConnectionFailed (void)
bool	NotifyConnectionRequest (const Address &from)
void	NotifyConnectionSucceeded (void)
void	NotifyDataRecv (void)
void	NotifyDataSent (uint32_t size)
void	NotifyErrorClose (void)
void	NotifyNewConnectionCreated (Ptr< Socket > socket, const Address &from)
void	NotifyNormalClose (void)
void	NotifySend (uint32_t spaceAvailable)
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Protected Attributes
bool	m_closeNotified
bool	m_closeOnEmpty
uint32_t	m_cnCount
uint32_t	m_cnRetries
Time	m_cnTimeout
bool	m_connected
uint32_t	m_delAckCount
EventId	m_delAckEvent
uint32_t	m_delAckMaxCount
Time	m_delAckTimeout
uint32_t	m_dupAckCount
Ipv4EndPoint *	m_endPoint
Ipv6EndPoint *	m_endPoint6
enum SocketErrno	m_errno
TracedValue< SequenceNumber32 >	m_highTxMark
Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback
Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback6
EventId	m_lastAckEvent
TracedValue< Time >	m_lastRtt
uint16_t	m_maxWinSize
double	m_msl
TracedValue< SequenceNumber32 >	m_nextTxSequence
Ptr< Node >	m_node
bool	m_noDelay
EventId	m_persistEvent
Time	m_persistTimeout
EventId	m_retxEvent
TracedValue< Time >	m_rto
Ptr< RttEstimator >	m_rtt
TracedValue< uint32_t >	m_rWnd
TcpRxBuffer	m_rxBuffer
uint32_t	m_segmentSize
bool	m_shutdownRecv
bool	m_shutdownSend
TracedValue< TcpStates_t >	m_state
Ptr< TcpL4Protocol >	m_tcp
EventId	m_timewaitEvent
TcpTxBuffer	m_txBuffer
Protected Attributes inherited from ns3::Socket
Ptr< NetDevice >	m_boundnetdevice
bool	m_recvPktInfo

Additional Inherited Members
Public Types inherited from ns3::Socket
enum	SocketErrno {   ERROR_NOTERROR, ERROR_ISCONN, ERROR_NOTCONN, ERROR_MSGSIZE,   ERROR_AGAIN, ERROR_SHUTDOWN, ERROR_OPNOTSUPP, ERROR_AFNOSUPPORT,   ERROR_INVAL, ERROR_BADF, ERROR_NOROUTETOHOST, ERROR_NODEV,   ERROR_ADDRNOTAVAIL, ERROR_ADDRINUSE, SOCKET_ERRNO_LAST }
enum	SocketType { NS3_SOCK_STREAM, NS3_SOCK_SEQPACKET, NS3_SOCK_DGRAM, NS3_SOCK_RAW }
Static Public Attributes inherited from ns3::TcpSocket
static const char *const	TcpStateName [LAST_STATE] = { "CLOSED", "LISTEN", "SYN_SENT", "SYN_RCVD", "ESTABLISHED", "CLOSE_WAIT", "LAST_ACK", "FIN_WAIT_1", "FIN_WAIT_2", "CLOSING", "TIME_WAIT" }

Detailed Description

A base class for implementation of a stream socket using TCP.

This class contains the essential components of TCP, as well as a sockets interface for upper layers to call. This serves as a base for other TCP functions where the sliding window mechanism is handled here. This class provides connection orientation and sliding window flow control. Part of this class is modified from the original NS-3 TCP socket implementation (TcpSocketImpl) by Raj Bhattacharjea raj.b.nosp@m.@gat.nosp@m.ech.e.nosp@m.du of Georgia Tech.

Config Paths

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

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

Attributes

• MaxSegLifetime: Maximum segment lifetime in seconds, use for TIME_WAIT state transition to CLOSED state
  • Set with class: ns3::DoubleValue
  • Underlying type: double 0:1.79769e+308
  • Initial value: 120
  • Flags: construct write read
• MaxWindowSize: Max size of advertised window
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 0:65535
  • Initial value: 65535
  • Flags: construct write read
• IcmpCallback: Callback invoked whenever an icmp error is received on this socket.
  • Set with class: CallbackValue
  • Underlying type: Callback
  • Initial value: 0
  • Flags: construct write read
• IcmpCallback6: Callback invoked whenever an icmpv6 error is received on this socket.
  • Set with class: CallbackValue
  • Underlying type: Callback
  • Initial value: 0
  • Flags: construct write read

Attributes defined in parent class ns3::TcpSocket

• SndBufSize: TcpSocket maximum transmit buffer size (bytes)
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 131072
  • Flags: construct write read
• RcvBufSize: TcpSocket maximum receive buffer size (bytes)
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 131072
  • Flags: construct write read
• SegmentSize: TCP maximum segment size in bytes (may be adjusted based on MTU discovery)
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 536
  • Flags: construct write read
• SlowStartThreshold: TCP slow start threshold (bytes)
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 65535
  • Flags: construct write read
• InitialCwnd: TCP initial congestion window size (segments)
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 1
  • Flags: construct write read
• ConnTimeout: TCP retransmission timeout when opening connection (seconds)
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: +3000000000.0ns
  • Flags: construct write read
• ConnCount: Number of connection attempts (SYN retransmissions) before returning failure
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 6
  • Flags: construct write read
• DelAckTimeout: Timeout value for TCP delayed acks, in seconds
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: +200000000.0ns
  • Flags: construct write read
• DelAckCount: Number of packets to wait before sending a TCP ack
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Initial value: 2
  • Flags: construct write read
• TcpNoDelay: Set to true to disable Nagle's algorithm
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: true
  • Flags: construct write read
• PersistTimeout: Persist timeout to probe for rx window
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: +6000000000.0ns
  • Flags: construct write read

TraceSources

• RTO: Retransmission timeout
• RTT: Last RTT sample
• NextTxSequence: Next sequence number to send (SND.NXT)
• HighestSequence: Highest sequence number ever sent in socket's life time
• State: TCP state
• RWND: Remote side's flow control window

Definition at line 61 of file tcp-socket-base.h.

Constructor & Destructor Documentation

ns3::TcpSocketBase::TcpSocketBase

(

void

)

Create an unbound TCP socket

Definition at line 108 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION.

ns3::TcpSocketBase::TcpSocketBase

(

const TcpSocketBase &

sock

)

Clone a TCP socket, for use upon receiving a connection request in LISTEN state

Definition at line 135 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Socket::SetConnectCallback(), ns3::Socket::SetDataSentCallback(), ns3::Socket::SetRecvCallback(), and ns3::Socket::SetSendCallback().

Member Function Documentation

void ns3::TcpSocketBase::AddOptions ( TcpHeader &  )

protectedvirtual

Placeholder function for future extension that changes the TCP header

Definition at line 2428 of file tcp-socket-base.cc.

Referenced by DoForwardUp(), SendDataPacket(), and SendEmptyPacket().

int ns3::TcpSocketBase::Bind ( void  )

virtual

Inherit from Socket class: Bind socket to an end-point in TcpL4Protocol

Implements ns3::Socket.

Definition at line 258 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION, and SetupCallback().

Referenced by BindToNetDevice(), and Connect().

int ns3::TcpSocketBase::Bind ( const Address &  address )

virtual

Inherit from Socket class: Bind socket (with specific address) to an end-point in TcpL4Protocol

Implements ns3::Socket.

Definition at line 287 of file tcp-socket-base.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and SetupCallback().

int ns3::TcpSocketBase::Bind6 ( void  )

virtual

Allocate a local IPv6 endpoint for this socket.

Returns

0 on success, -1 on failure.

Implements ns3::Socket.

Definition at line 272 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION, and SetupCallback().

Referenced by Connect().

void ns3::TcpSocketBase::BindToNetDevice ( Ptr< NetDevice >  netdevice )

virtual

Inherit from Socket class: Bind this socket to the specified NetDevice

Reimplemented from ns3::Socket.

Definition at line 648 of file tcp-socket-base.cc.

References Bind(), ns3::Socket::BindToNetDevice(), NS_ASSERT, and NS_LOG_FUNCTION.

int ns3::TcpSocketBase::Close ( void  )

virtual

Inherit from Socket class: Kill this socket and signal the peer (if any)

Implements ns3::Socket.

Definition at line 446 of file tcp-socket-base.cc.

References DoClose(), NS_LOG_FUNCTION, NS_LOG_INFO, SendRST(), and ns3::TcpTxBuffer::SizeFromSequence().

Referenced by DoPeerClose().

void ns3::TcpSocketBase::CloseAndNotify ( void  )

protected

Peacefully close the socket by notifying the upper layer and deallocate end point

Definition at line 763 of file tcp-socket-base.cc.

References DeallocateEndPoint(), NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by DoClose(), DoConnect(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), SendEmptyPacket(), and TimeWait().

void ns3::TcpSocketBase::CompleteFork ( Ptr< Packet >  p, const TcpHeader &  h, const Address &  fromAddress, const Address &  toAddress  )

protected

This function is called only if a SYN received in LISTEN state. After TcpSocketBase cloned, allocate a new end point to handle the incoming connection and send a SYN+ACK to complete the handshake.

Definition at line 1776 of file tcp-socket-base.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::TcpHeader::GetSequenceNumber(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), NS_LOG_INFO, SendEmptyPacket(), and SetupCallback().

Referenced by ProcessListen().

int ns3::TcpSocketBase::Connect ( const Address &  address )

virtual

Inherit from Socket class: Initiate connection to a remote address:port

Implements ns3::Socket.

Reimplemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, and ns3::TcpNewReno.

Definition at line 357 of file tcp-socket-base.cc.

References Bind(), Bind6(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), DoConnect(), ns3::InetSocketAddress::GetIpv4(), ns3::Ipv6Address::GetIpv4MappedAddress(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Ipv6Address::IsIpv4MappedAddress(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Ipv6EndPoint::SetPeer(), and SetupEndpoint().

Referenced by ns3::TcpNewReno::Connect(), ns3::TcpReno::Connect(), ns3::TcpTahoe::Connect(), and ns3::TcpWestwood::Connect().

void ns3::TcpSocketBase::DeallocateEndPoint ( void  )

protected

Deallocate the end point and cancel all the timers

Definition at line 1681 of file tcp-socket-base.cc.

References ns3::Ipv6EndPoint::SetDestroyCallback().

Referenced by CloseAndNotify(), and SendRST().

void ns3::TcpSocketBase::Destroy ( void  )

protected

Kill this socket. This is a callback function configured to m_endpoint in SetupCallback(), invoked when the endpoint is destroyed.

Definition at line 1515 of file tcp-socket-base.cc.

References ns3::Simulator::GetDelayLeft(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by SetupCallback().

void ns3::TcpSocketBase::Destroy6 ( void  )

protected

Kill this socket. This is a callback function configured to m_endpoint in SetupCallback(), invoked when the endpoint is destroyed.

Definition at line 1536 of file tcp-socket-base.cc.

References ns3::Simulator::GetDelayLeft(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by SetupCallback().

int ns3::TcpSocketBase::DoClose ( void  )

protected

Do the action to close the socket. Usually send a packet with appropriate flags depended on the current m_state.

Definition at line 721 of file tcp-socket-base.cc.

References CloseAndNotify(), NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), and SendRST().

Referenced by Close().

int ns3::TcpSocketBase::DoConnect ( void  )

protected

Perform the real connection tasks: Send SYN if allowed, RST if invalid

Definition at line 698 of file tcp-socket-base.cc.

References CloseAndNotify(), NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), and SendRST().

Referenced by Connect().

void ns3::TcpSocketBase::DoForwardUp ( Ptr< Packet >  packet, Ipv4Header  header, uint16_t  port, Ptr< Ipv4Interface >  incomingInterface  )

protectedvirtual

The real function to handle the incoming packet from lower layers. This is wrapped by ForwardUp() so that this function can be overloaded by daughter classes.

Definition at line 847 of file tcp-socket-base.cc.

References AddOptions(), ns3::EventId::Cancel(), EstimateRtt(), ns3::Ipv4Header::GetDestination(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), NS_LOG_LOGIC, OutOfRange(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessListen(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReadOptions(), ns3::Packet::RemoveHeader(), SendEmptyPacket(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), and ns3::TcpHeader::SetWindowSize().

Referenced by ForwardUp().

void ns3::TcpSocketBase::DoPeerClose ( void  )

protected

Received a in-sequence FIN. Close down this socket.

Definition at line 1476 of file tcp-socket-base.cc.

References Close(), NS_ASSERT, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Simulator::Schedule(), and SendEmptyPacket().

Referenced by PeerClose().

void ns3::TcpSocketBase::EstimateRtt ( const TcpHeader &  tcpHeader )

protectedvirtual

Called by ForwardUp() to estimate RTT

Reimplemented in ns3::TcpWestwood.

Definition at line 2075 of file tcp-socket-base.cc.

References ns3::TcpHeader::GetAckNumber(), and NS_LOG_FUNCTION.

Referenced by DoForwardUp(), and ns3::TcpWestwood::EstimateRtt().

void ns3::TcpSocketBase::ForwardUp ( Ptr< Packet >  packet, Ipv4Header  header, uint16_t  port, Ptr< Ipv4Interface >  incomingInterface  )

protected

Function called by the L3 protocol when it received a packet to pass on to the TCP. This function is registered as the "RxCallback" function in SetupCallback(), which invoked by Bind(), and CompleteFork()

Definition at line 805 of file tcp-socket-base.cc.

References DoForwardUp().

Referenced by SetupCallback().

bool ns3::TcpSocketBase::GetAllowBroadcast ( void  ) const

protectedvirtual

Query whether broadcast datagram transmissions are allowed.

This method corresponds to using getsockopt() SO_BROADCAST of real network or BSD sockets.

Returns

true if broadcast is allowed, false otherwise

Implements ns3::Socket.

Definition at line 2415 of file tcp-socket-base.cc.

enum Socket::SocketErrno ns3::TcpSocketBase::GetErrno ( void  ) const

virtual

Inherit from Socket class: Returns error code

Implements ns3::Socket.

Definition at line 236 of file tcp-socket-base.cc.

Ptr< Node > ns3::TcpSocketBase::GetNode ( void  ) const

virtual

Inherit from Socket class: Returns associated node

Implements ns3::Socket.

Definition at line 250 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::TcpSocketBase::GetRxAvailable ( void  ) const

virtual

Inherit from Socket class: Get the max number of bytes an app can read

Implements ns3::Socket.

Definition at line 618 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION.

enum Socket::SocketType ns3::TcpSocketBase::GetSocketType ( void  ) const

virtual

Inherit from Socket class: Returns socket type, NS3_SOCK_STREAM

Implements ns3::Socket.

Definition at line 243 of file tcp-socket-base.cc.

int ns3::TcpSocketBase::GetSockName ( Address &  address ) const

virtual

Inherit from Socket class: Return local address:port

Implements ns3::Socket.

Definition at line 626 of file tcp-socket-base.cc.

References ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv4Address::GetZero(), and NS_LOG_FUNCTION.

uint32_t ns3::TcpSocketBase::GetTxAvailable ( void  ) const

virtual

Inherit from Socket class: Get the max number of bytes an app can send

Implements ns3::Socket.

Definition at line 610 of file tcp-socket-base.cc.

References ns3::TcpTxBuffer::Available(), and NS_LOG_FUNCTION.

Referenced by ProcessSynRcvd().

int ns3::TcpSocketBase::Listen ( void  )

virtual

Inherit from Socket class: Listen on the endpoint for an incoming connection

Implements ns3::Socket.

Reimplemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, and ns3::TcpNewReno.

Definition at line 429 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by ns3::TcpNewReno::Listen(), ns3::TcpReno::Listen(), ns3::TcpTahoe::Listen(), and ns3::TcpWestwood::Listen().

bool ns3::TcpSocketBase::OutOfRange ( SequenceNumber32  head, SequenceNumber32  tail  ) const

protected

Tell if a sequence number range is out side the range that my rx buffer can accpet

Definition at line 785 of file tcp-socket-base.cc.

Referenced by DoForwardUp().

void ns3::TcpSocketBase::PeerClose ( Ptr< Packet >  p, const TcpHeader &  tcpHeader  )

protected

Peer sent me a FIN. Remember its sequence in rx buffer.

Definition at line 1439 of file tcp-socket-base.cc.

References DoPeerClose(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_LOGIC.

Referenced by ProcessEstablished(), and ProcessSynRcvd().

void ns3::TcpSocketBase::ProcessClosing ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protected

Received a packet upon CLOSING

Definition at line 1371 of file tcp-socket-base.cc.

References CloseAndNotify(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), NS_LOG_FUNCTION, NS_LOG_LOGIC, SendEmptyPacket(), SendRST(), and TimeWait().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessEstablished ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protected

Received a packet upon ESTABLISHED state. This function is mimicking the role of tcp_rcv_established() in tcp_input.c in Linux kernel.

Definition at line 1040 of file tcp-socket-base.cc.

References CloseAndNotify(), ns3::TcpHeader::GetFlags(), NS_LOG_FUNCTION, NS_LOG_LOGIC, PeerClose(), ReceivedAck(), and SendRST().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessLastAck ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protected

Received a packet upon LAST_ACK

Definition at line 1403 of file tcp-socket-base.cc.

References CloseAndNotify(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), NS_LOG_FUNCTION, NS_LOG_LOGIC, SendEmptyPacket(), and SendRST().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessListen ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader, const Address &  fromAddress, const Address &  toAddress  )

protected

Received a packet upon LISTEN state.

Definition at line 1122 of file tcp-socket-base.cc.

References CompleteFork(), ns3::TcpHeader::GetFlags(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::ScheduleNow().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessSynRcvd ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader, const Address &  fromAddress, const Address &  toAddress  )

protected

Received a packet upon SYN_RCVD

Definition at line 1210 of file tcp-socket-base.cc.

References ns3::EventId::Cancel(), CloseAndNotify(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), GetTxAvailable(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PeerClose(), ReceivedAck(), SendEmptyPacket(), SendRST(), ns3::TcpTxBuffer::SetHeadSequence(), and ns3::Ipv6EndPoint::SetPeer().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessSynSent ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protected

Received a packet upon SYN_SENT

Definition at line 1152 of file tcp-socket-base.cc.

References ns3::EventId::Cancel(), CloseAndNotify(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Simulator::ScheduleNow(), SendEmptyPacket(), SendPendingData(), SendRST(), and ns3::TcpTxBuffer::SetHeadSequence().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ProcessWait ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protected

Received a packet upon CLOSE_WAIT, FIN_WAIT_1, or FIN_WAIT_2 states

Definition at line 1300 of file tcp-socket-base.cc.

References CloseAndNotify(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ReceivedAck(), SendEmptyPacket(), SendRST(), ns3::TcpTxBuffer::Size(), and TimeWait().

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ReadOptions ( const TcpHeader &  )

protectedvirtual

Placeholder function for future extension that reads more from the TCP header

Definition at line 2422 of file tcp-socket-base.cc.

Referenced by DoForwardUp().

void ns3::TcpSocketBase::ReceivedAck ( Ptr< Packet >  packet, const TcpHeader &  tcpHeader  )

protectedvirtual

Process the newly received ACK

Reimplemented in ns3::TcpWestwood.

Definition at line 1085 of file tcp-socket-base.cc.

References ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::Packet::GetSize(), ns3::TcpTxBuffer::HeadSequence(), NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ProcessEstablished(), ProcessSynRcvd(), ProcessWait(), and ns3::TcpWestwood::ReceivedAck().

Ptr< Packet > ns3::TcpSocketBase::Recv ( uint32_t  maxSize, uint32_t  flags  )

virtual

Inherit from Socket class: Return data to upper-layer application. Parameter flags is not used. Data is returned as a packet of size no larger than maxSize

Implements ns3::Socket.

Definition at line 558 of file tcp-socket-base.cc.

References ns3::Packet::AddPacketTag(), ns3::TcpRxBuffer::Extract(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Ptr< Packet > ns3::TcpSocketBase::RecvFrom ( uint32_t  maxSize, uint32_t  flags, Address &  fromAddress  )

virtual

Inherit from Socket class: Recv and return the remote's address

Implements ns3::Socket.

Definition at line 585 of file tcp-socket-base.cc.

References ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), ns3::Ipv4Address::GetZero(), NS_LOG_FUNCTION, and ns3::Socket::Recv().

int ns3::TcpSocketBase::Send ( Ptr< Packet >  p, uint32_t  flags  )

virtual

Inherit from Socket class: Send a packet. Parameter flags is not used. Packet has no TCP header. Invoked by upper-layer application

Implements ns3::Socket.

Definition at line 516 of file tcp-socket-base.cc.

References ns3::TcpTxBuffer::Add(), ns3::Packet::GetSize(), NS_ABORT_MSG_IF, NS_LOG_FUNCTION, NS_LOG_LOGIC, SendPendingData(), and ns3::TcpTxBuffer::Size().

Referenced by SendTo().

uint32_t ns3::TcpSocketBase::SendDataPacket ( SequenceNumber32  seq, uint32_t  maxSize, bool  withAck  )

protected

Extract at most maxSize bytes from the TxBuffer at sequence seq, add the TCP header, and send to TcpL4Protocol

Definition at line 1825 of file tcp-socket-base.cc.

References AddOptions(), ns3::Packet::AddPacketTag(), ns3::TcpTxBuffer::CopyFromSequence(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), ns3::EventId::IsExpired(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), ns3::TcpHeader::SetWindowSize(), and ns3::TcpTxBuffer::SizeFromSequence().

Referenced by ns3::TcpNewReno::DupAck(), and SendPendingData().

void ns3::TcpSocketBase::SendEmptyPacket ( uint8_t  flags )

protected

Send an empty packet with specified TCP flags

Definition at line 1556 of file tcp-socket-base.cc.

References AddOptions(), ns3::Packet::AddPacketTag(), ns3::EventId::Cancel(), CloseAndNotify(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::EventId::IsExpired(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, and ns3::Simulator::Schedule().

Referenced by CompleteFork(), DoClose(), DoConnect(), DoForwardUp(), DoPeerClose(), ProcessClosing(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), SendRST(), and ShutdownSend().

bool ns3::TcpSocketBase::SendPendingData ( bool  withAck = false )

protected

Send as much pending data as possible according to the Tx window. Note that this function did not implement the PSH flag

Definition at line 1932 of file tcp-socket-base.cc.

References ns3::TcpTxBuffer::HeadSequence(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, SendDataPacket(), ns3::TcpTxBuffer::Size(), and ns3::TcpTxBuffer::SizeFromSequence().

Referenced by ns3::TcpNewReno::DupAck(), ns3::TcpWestwood::DupAck(), ProcessSynSent(), and Send().

void ns3::TcpSocketBase::SendRST ( void  )

protected

This function closes the endpoint completely. Called upon RST_TX action.

Definition at line 1671 of file tcp-socket-base.cc.

References DeallocateEndPoint(), NS_LOG_FUNCTION, and SendEmptyPacket().

Referenced by Close(), DoClose(), DoConnect(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), and ProcessWait().

int ns3::TcpSocketBase::SendTo ( Ptr< Packet >  p, uint32_t  flags, const Address &  address  )

virtual

Inherit from Socket class: In TcpSocketBase, it is same as Send() call

Implements ns3::Socket.

Definition at line 550 of file tcp-socket-base.cc.

References Send().

bool ns3::TcpSocketBase::SetAllowBroadcast ( bool  allowBroadcast )

protectedvirtual

Configure whether broadcast datagram transmissions are allowed.

This method corresponds to using setsockopt() SO_BROADCAST of real network or BSD sockets. If set on a socket, this option will enable or disable packets to be transmitted to broadcast destination addresses.

Parameters

allowBroadcast

Whether broadcast is allowed

Returns

true if operation succeeds

Implements ns3::Socket.

Definition at line 2408 of file tcp-socket-base.cc.

void ns3::TcpSocketBase::SetNode ( Ptr< Node >  node )

virtual

Associate a node with this TCP socket

Definition at line 215 of file tcp-socket-base.cc.

void ns3::TcpSocketBase::SetRtt ( Ptr< RttEstimator >  rtt )

virtual

Set an RTT estimator with this socket

Definition at line 229 of file tcp-socket-base.cc.

void ns3::TcpSocketBase::SetSndBufSize ( uint32_t  size )

protectedvirtual

Below are the attribute get/set functions

Implements ns3::TcpSocket.

Definition at line 2299 of file tcp-socket-base.cc.

References ns3::TcpTxBuffer::SetMaxBufferSize().

void ns3::TcpSocketBase::SetTcp ( Ptr< TcpL4Protocol >  tcp )

virtual

Associate the L4 protocol (e.g. mux/demux) with this socket

Definition at line 222 of file tcp-socket-base.cc.

int ns3::TcpSocketBase::SetupCallback ( void  )

protected

Clean up after Bind. Set up callback functions in the end-point.

Definition at line 672 of file tcp-socket-base.cc.

References Destroy(), Destroy6(), ForwardUp(), ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::Ipv6EndPoint::SetDestroyCallback(), ns3::Ipv6EndPoint::SetIcmpCallback(), and ns3::Ipv6EndPoint::SetRxCallback().

Referenced by Bind(), Bind6(), and CompleteFork().

int ns3::TcpSocketBase::SetupEndpoint ( void  )

protected

Configure the endpoint to a local address. Called by Connect() if Bind() didn't specify one.

Definition at line 1713 of file tcp-socket-base.cc.

References ns3::Object::GetObject(), ns3::Ipv4Route::GetSource(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Ipv4Header::SetDestination().

Referenced by Connect().

int ns3::TcpSocketBase::ShutdownRecv ( void  )

virtual

Inherit from Socket class: Signal a termination of receive

Implements ns3::Socket.

Definition at line 506 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION.

int ns3::TcpSocketBase::ShutdownSend ( void  )

virtual

Inherit from Socket class: Signal a termination of send

Implements ns3::Socket.

Definition at line 472 of file tcp-socket-base.cc.

References NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), and ns3::TcpTxBuffer::Size().

void ns3::TcpSocketBase::TimeWait ( void  )

protected

Move TCP to Time_Wait state and schedule a transition to Closed state

Definition at line 2285 of file tcp-socket-base.cc.

References CloseAndNotify(), NS_LOG_INFO, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by ProcessClosing(), and ProcessWait().

---

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

• src/internet/model/tcp-socket-base.h
• src/internet/model/tcp-socket-base.cc