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

#include <tcp-socket-base.h>

Inheritance diagram for ns3::TcpSocketBase:

Collaboration diagram for ns3::TcpSocketBase:

Public Member Functions
	TcpSocketBase (void)
	Create an unbound TCP socket. More...

	TcpSocketBase (const TcpSocketBase &sock)
	Clone a TCP socket, for use upon receiving a connection request in LISTEN state. More...

virtual	~TcpSocketBase (void)

virtual int	Bind (void)
	Allocate a local IPv4 endpoint for this socket. More...

virtual int	Bind (const Address &address)
	Allocate a local endpoint for this socket. More...

virtual int	Bind6 (void)
	Allocate a local IPv6 endpoint for this socket. More...

virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device. More...

virtual int	Close (void)
	Close a socket. More...

virtual int	Connect (const Address &address)
	Initiate a connection to a remote host. More...

virtual enum SocketErrno	GetErrno (void) const
	Get last error number. More...

virtual Ptr< Node >	GetNode (void) const
	Return the node this socket is associated with. More...

virtual uint32_t	GetRxAvailable (void) const
	Return number of bytes which can be returned from one or multiple calls to Recv. More...

virtual enum SocketType	GetSocketType (void) const

virtual int	GetSockName (Address &address) const
	Get socket address. More...

virtual uint32_t	GetTxAvailable (void) const
	Returns the number of bytes which can be sent in a single call to Send. More...

virtual int	Listen (void)
	Listen for incoming connections. More...

virtual Ptr< Packet >	Recv (uint32_t maxSize, uint32_t flags)
	Read data from the socket. More...

virtual Ptr< Packet >	RecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)
	Read a single packet from the socket and retrieve the sender address. More...

virtual int	Send (Ptr< Packet > p, uint32_t flags)
	Send data (or dummy data) to the remote host. More...

virtual int	SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)
	Send data to a specified peer. More...

virtual void	SetNode (Ptr< Node > node)
	Set the associated node. More...

virtual void	SetRtt (Ptr< RttEstimator > rtt)
	Set the associated RTT estimator. More...

virtual void	SetTcp (Ptr< TcpL4Protocol > tcp)
	Set the associated TCP L4 protocol. More...

virtual int	ShutdownRecv (void)

virtual int	ShutdownSend (void)

Public Member Functions inherited from ns3::TcpSocket
	TcpSocket (void)

virtual	~TcpSocket (void)

Public Member Functions inherited from ns3::Socket
	Socket (void)

virtual	~Socket (void)

Ptr< NetDevice >	GetBoundNetDevice ()
	Returns socket's bound netdevice, if any. More...

uint8_t	GetIpTos (void) const
	Query the value of IP Type of Service of this socket. More...

virtual uint8_t	GetIpTtl (void) const
	Query the value of IP Time to Live field of this socket. More...

virtual uint8_t	GetIpv6HopLimit (void) const
	Query the value of IP Hop Limit field of this socket. More...

uint8_t	GetIpv6Tclass (void) const
	Query the value of IPv6 Traffic Class field of this socket. More...

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)
	Manually set IP Type of Service field. More...

virtual void	SetIpTtl (uint8_t ipTtl)
	Manually set IP Time to Live field. More...

virtual void	SetIpv6HopLimit (uint8_t ipHopLimit)
	Manually set IPv6 Hop Limit. More...

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)
	Manually set IPv6 Traffic Class field. More...

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
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::TcpSocket
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Socket
static Ptr< Socket >	CreateSocket (Ptr< Node > node, TypeId tid)
	This method wraps the creation of sockets that is performed on a given node by a SocketFactory specified by TypeId. More...

static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
virtual void	AddOptions (TcpHeader &tcpHeader)
	Add option to outgoing packets. More...

virtual uint16_t	AdvertisedWindowSize (void)
	The amount of Rx window announced to the peer. More...

virtual uint32_t	AvailableWindow (void)
	Return unfilled portion of window. More...

virtual uint32_t	BytesInFlight (void)
	Return total bytes in flight. More...

void	CancelAllTimers (void)
	Cancel all timer when endpoint is deleted. More...

void	CloseAndNotify (void)
	Peacefully close the socket by notifying the upper layer and deallocate end point. More...

void	CompleteFork (Ptr< Packet > p, const TcpHeader &tcpHeader, const Address &fromAddress, const Address &toAddress)
	Complete a connection by forking the socket. More...

void	ConnectionSucceeded (void)
	Schedule-friendly wrapper for Socket::NotifyConnectionSucceeded() More...

void	DeallocateEndPoint (void)
	Deallocate m_endPoint. More...

virtual void	DelAckTimeout (void)
	Action upon delay ACK timeout, i.e. More...

void	Destroy (void)
	Kill this socket by zeroing its attributes (IPv4) More...

void	Destroy6 (void)
	Kill this socket by zeroing its attributes (IPv6) More...

int	DoClose (void)
	Close a socket by sending RST, FIN, or FIN+ACK, depend on the current state. More...

int	DoConnect (void)
	Perform the real connection tasks: Send SYN if allowed, RST if invalid. More...

virtual void	DoForwardUp (Ptr< Packet > packet, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface)
	Called by TcpSocketBase::ForwardUp(). More...

virtual void	DoForwardUp (Ptr< Packet > packet, Ipv6Header header, uint16_t port)
	Called by TcpSocketBase::ForwardUp6(). More...

void	DoPeerClose (void)
	FIN is in sequence, notify app and respond with a FIN. More...

virtual void	DoRetransmit (void)
	Retransmit the oldest packet. More...

virtual void	DupAck (const TcpHeader &tcpHeader, uint32_t count)=0
	Received dupack (duplicate ACK) More...

virtual void	EstimateRtt (const TcpHeader &tcpHeader)
	Take into account the packet for RTT estimation. More...

virtual Ptr< TcpSocketBase >	Fork (void)=0
	Call CopyObject<> to clone me. More...

void	ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
	Called by the L3 protocol when it received an ICMP packet to pass on to TCP. More...

void	ForwardIcmp6 (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
	Called by the L3 protocol when it received an ICMPv6 packet to pass on to TCP. More...

void	ForwardUp (Ptr< Packet > packet, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface)
	Called by the L3 protocol when it received a packet to pass on to TCP. More...

void	ForwardUp6 (Ptr< Packet > packet, Ipv6Header header, uint16_t port, Ptr< Ipv6Interface > incomingInterface)
	Called by the L3 protocol when it received a packet to pass on to TCP. More...

virtual bool	GetAllowBroadcast (void) const
	Query whether broadcast datagram transmissions are allowed. More...

virtual uint32_t	GetConnCount (void) const
	Get the number of connection retries before giving up. More...

virtual Time	GetConnTimeout (void) const
	Get the connection timeout. More...

virtual uint32_t	GetDelAckMaxCount (void) const
	Get the number of packet to fire an ACK before delay timeout. More...

virtual Time	GetDelAckTimeout (void) const
	Get the time to delay an ACK. More...

virtual uint32_t	GetInitialCwnd (void) const =0
	Get the initial Congestion Window. More...

virtual Time	GetPersistTimeout (void) const
	Get the timout for persistent connection. More...

virtual uint32_t	GetRcvBufSize (void) const
	Get the receive buffer size. More...

virtual uint32_t	GetSegSize (void) const
	Get the segment size. More...

virtual uint32_t	GetSndBufSize (void) const
	Get the send buffer size. More...

virtual uint32_t	GetSSThresh (void) const =0
	Get the Slow Start Threshold. More...

virtual bool	GetTcpNoDelay (void) const
	Check if Nagle's algorithm is enabled or not. More...

virtual void	LastAckTimeout (void)
	Timeout at LAST_ACK, close the connection. More...

virtual void	NewAck (SequenceNumber32 const &seq)
	Update buffers w.r.t. More...

bool	OutOfRange (SequenceNumber32 head, SequenceNumber32 tail) const
	Check if a sequence number range is within the rx window. More...

void	PeerClose (Ptr< Packet > p, const TcpHeader &tcpHeader)
	Received a FIN from peer, notify rx buffer. More...

virtual void	PersistTimeout (void)
	Send 1 byte probe to get an updated window size. More...

void	ProcessClosing (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received a packet upon CLOSING. More...

void	ProcessEstablished (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received a packet upon ESTABLISHED state. More...

void	ProcessLastAck (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received a packet upon LAST_ACK. More...

void	ProcessListen (Ptr< Packet > packet, const TcpHeader &tcpHeader, const Address &fromAddress, const Address &toAddress)
	Received a packet upon LISTEN state. More...

void	ProcessSynRcvd (Ptr< Packet > packet, const TcpHeader &tcpHeader, const Address &fromAddress, const Address &toAddress)
	Received a packet upon SYN_RCVD. More...

void	ProcessSynSent (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received a packet upon SYN_SENT. More...

void	ProcessWait (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received a packet upon CLOSE_WAIT, FIN_WAIT_1, FIN_WAIT_2. More...

virtual void	ReadOptions (const TcpHeader &tcpHeader)
	Read option from incoming packets. More...

virtual void	ReceivedAck (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Received an ACK packet. More...

virtual void	ReceivedData (Ptr< Packet > packet, const TcpHeader &tcpHeader)
	Recv of a data, put into buffer, call L7 to get it if necessary. More...

virtual void	Retransmit (void)
	Halving cwnd and call DoRetransmit() More...

virtual void	ReTxTimeout (void)
	Call Retransmit() upon RTO event. More...

uint32_t	SendDataPacket (SequenceNumber32 seq, uint32_t maxSize, bool withAck)
	Extract at most maxSize bytes from the TxBuffer at sequence seq, add the TCP header, and send to TcpL4Protocol. More...

void	SendEmptyPacket (uint8_t flags)
	Send a empty packet that carries a flag, e.g. More...

bool	SendPendingData (bool withAck=false)
	Send as much pending data as possible according to the Tx window. More...

void	SendRST (void)
	Send reset and tear down this socket. More...

virtual bool	SetAllowBroadcast (bool allowBroadcast)
	Configure whether broadcast datagram transmissions are allowed. More...

virtual void	SetConnCount (uint32_t count)
	Set the number of connection retries before giving up. More...

virtual void	SetConnTimeout (Time timeout)
	Set the connection timeout. More...

virtual void	SetDelAckMaxCount (uint32_t count)
	Set the number of packet to fire an ACK before delay timeout. More...

virtual void	SetDelAckTimeout (Time timeout)
	Set the time to delay an ACK. More...

virtual void	SetInitialCwnd (uint32_t cwnd)=0
	Set the initial Congestion Window. More...

virtual void	SetPersistTimeout (Time timeout)
	Set the timout for persistent connection. More...

virtual void	SetRcvBufSize (uint32_t size)
	Set the receive buffer size. More...

virtual void	SetSegSize (uint32_t size)
	Set the segment size. More...

virtual void	SetSndBufSize (uint32_t size)
	Set the send buffer size. More...

virtual void	SetSSThresh (uint32_t threshold)=0
	Set the Slow Start Threshold. More...

virtual void	SetTcpNoDelay (bool noDelay)
	Enable/Disable Nagle's algorithm. More...

int	SetupCallback (void)
	Common part of the two Bind(), i.e. More...

int	SetupEndpoint (void)
	Configure the endpoint to a local address. More...

int	SetupEndpoint6 (void)
	Configure the endpoint v6 to a local address. More...

void	TimeWait (void)
	Move from CLOSING or FIN_WAIT_2 to TIME_WAIT state. More...

virtual uint32_t	UnAckDataCount (void)
	Return count of number of unacked bytes. More...

virtual uint32_t	Window (void)
	Return the max possible number of unacked bytes. More...

Protected Member Functions inherited from ns3::Socket
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

bool	IsManualIpTos (void) const
	Checks if the socket has a specific IPv4 ToS set. More...

bool	IsManualIpTtl (void) const
	Checks if the socket has a specific IPv4 TTL set. More...

bool	IsManualIpv6HopLimit (void) const
	Checks if the socket has a specific IPv6 Hop Limit set. More...

bool	IsManualIpv6Tclass (void) const
	Checks if the socket has a specific IPv6 Tclass set. More...

void	NotifyConnectionFailed (void)
	Notify through the callback (if set) that the connection has not been established due to an error. More...

bool	NotifyConnectionRequest (const Address &from)
	Notify through the callback (if set) that an incoming connection is being requested by a remote host. More...

void	NotifyConnectionSucceeded (void)
	Notify through the callback (if set) that the connection has been established. More...

void	NotifyDataRecv (void)
	Notify through the callback (if set) that some data have been received. More...

void	NotifyDataSent (uint32_t size)
	Notify through the callback (if set) that some data have been sent. More...

void	NotifyErrorClose (void)
	Notify through the callback (if set) that the connection has been closed due to an error. More...

void	NotifyNewConnectionCreated (Ptr< Socket > socket, const Address &from)
	Notify through the callback (if set) that a new connection has been created. More...

void	NotifyNormalClose (void)
	Notify through the callback (if set) that the connection has been closed. More...

void	NotifySend (uint32_t spaceAvailable)
	Notify through the callback (if set) that some data have been sent. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Protected Attributes
bool	m_closeNotified
	Told app to close socket. More...

bool	m_closeOnEmpty
	Close socket upon tx buffer emptied. More...

uint32_t	m_cnCount
	Count of remaining connection retries. More...

uint32_t	m_cnRetries
	Number of connection retries before giving up. More...

Time	m_cnTimeout
	Timeout for connection retry. More...

bool	m_connected
	Connection established. More...

uint32_t	m_delAckCount
	Delayed ACK counter. More...

EventId	m_delAckEvent
	Delayed ACK timeout event. More...

uint32_t	m_delAckMaxCount
	Number of packet to fire an ACK before delay timeout. More...

Time	m_delAckTimeout
	Time to delay an ACK. More...

uint32_t	m_dupAckCount
	Dupack counter. More...

Ipv4EndPoint *	m_endPoint
	the IPv4 endpoint More...

Ipv6EndPoint *	m_endPoint6
	the IPv6 endpoint More...

enum SocketErrno	m_errno
	Socket error code. More...

TracedValue< SequenceNumber32 >	m_highTxMark
	Highest seqno ever sent, regardless of ReTx. More...

Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback
	ICMP callback. More...

Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback6
	ICMPv6 callback. More...

EventId	m_lastAckEvent
	Last ACK timeout event. More...

TracedValue< Time >	m_lastRtt
	Last RTT sample collected. More...

uint16_t	m_maxWinSize
	Maximum window size to advertise. More...

double	m_msl
	Max segment lifetime. More...

TracedValue< SequenceNumber32 >	m_nextTxSequence
	Next seqnum to be sent (SND.NXT), ReTx pushes it back. More...

Ptr< Node >	m_node
	the associated node More...

bool	m_noDelay
	Set to true to disable Nagle's algorithm. More...

EventId	m_persistEvent
	Persist event: Send 1 byte to probe for a non-zero Rx window. More...

Time	m_persistTimeout
	Time between sending 1-byte probes. More...

EventId	m_retxEvent
	Retransmission event. More...

TracedValue< Time >	m_rto
	Retransmit timeout. More...

Ptr< RttEstimator >	m_rtt
	Round trip time estimator. More...

TracedValue< uint32_t >	m_rWnd
	Flow control window at remote side. More...

TcpRxBuffer	m_rxBuffer
	Rx buffer (reordering buffer) More...

uint32_t	m_segmentSize
	Segment size. More...

bool	m_shutdownRecv
	Receive no longer allowed. More...

bool	m_shutdownSend
	Send no longer allowed. More...

TracedValue< TcpStates_t >	m_state
	TCP state. More...

Ptr< TcpL4Protocol >	m_tcp
	the associated TCP L4 protocol More...

EventId	m_timewaitEvent
	TIME_WAIT expiration event: Move this socket to CLOSED state. More...

TcpTxBuffer	m_txBuffer
	Tx buffer. More...

Protected Attributes inherited from ns3::Socket
Ptr< NetDevice >	m_boundnetdevice
	the device this socket is bound to (might be null). More...

bool	m_recvPktInfo
	if the socket should add packet info tags to the packet forwarded to L4. More...

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 }
	Enumeration of the possible errors returned by a socket. More...

enum	SocketType { NS3_SOCK_STREAM, NS3_SOCK_SEQPACKET, NS3_SOCK_DGRAM, NS3_SOCK_RAW }
	Enumeration of the possible socket types. More...

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" }
	Literal names of TCP states for use in log messages. More...

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: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- 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: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- 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: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- 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 62 of file tcp-socket-base.h.

Constructor & Destructor Documentation

ns3::TcpSocketBase::TcpSocketBase ( void )

Create an unbound TCP socket.

Definition at line 109 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.

Parameters

sock	the original Tcp Socket

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

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

Here is the call graph for this function:

ns3::TcpSocketBase::~TcpSocketBase ( void )

virtual

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

References CancelAllTimers(), m_endPoint, m_endPoint6, m_node, m_tcp, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

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

protectedvirtual

Add option to outgoing packets.

Parameters

tcpHeader the packet's TCP header

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

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

Here is the caller graph for this function:

uint16_t ns3::TcpSocketBase::AdvertisedWindowSize ( void )

protectedvirtual

The amount of Rx window announced to the peer.

Returns: size of Rx window announced to the peer

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

References m_maxWinSize, m_rxBuffer, ns3::TcpRxBuffer::MaxBufferSize(), and ns3::TcpRxBuffer::Size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TcpSocketBase::AvailableWindow ( void )

protectedvirtual

Return unfilled portion of window.

Returns: unfilled portion of window

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

References NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, UnAckDataCount(), and Window().

Referenced by SendPendingData().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::Bind ( void )

virtual

Allocate a local IPv4 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

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

References ns3::Socket::ERROR_ADDRNOTAVAIL, m_endPoint, m_errno, m_tcp, NS_LOG_FUNCTION, and SetupCallback().

Referenced by BindToNetDevice(), and Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Allocate a local endpoint for this socket.

Parameters

address the address to try to allocate

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::Socket::ERROR_ADDRINUSE, ns3::Socket::ERROR_ADDRNOTAVAIL, ns3::Socket::ERROR_INVAL, ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_endPoint, m_endPoint6, m_errno, m_tcp, NS_LOG_FUNCTION, NS_LOG_LOGIC, port, and SetupCallback().

Here is the call graph for this function:

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 273 of file tcp-socket-base.cc.

References ns3::Socket::ERROR_ADDRNOTAVAIL, m_endPoint6, m_errno, m_tcp, NS_LOG_FUNCTION, and SetupCallback().

Referenced by Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Bind a socket to specific device.

This method corresponds to using setsockopt() SO_BINDTODEVICE of real network or BSD sockets. If set on a socket, this option will force packets to leave the bound device regardless of the device that IP routing would naturally choose. In the receive direction, only packets received from the bound interface will be delivered.

This option has no particular relationship to binding sockets to an address via Socket::Bind (). It is possible to bind sockets to a specific IP address on the bound interface by calling both Socket::Bind (address) and Socket::BindToNetDevice (device), but it is also possible to bind to mismatching device and address, even if the socket can not receive any packets as a result.

Parameters

netdevice Pointer to Netdevice of desired interface

Returns: nothing

Reimplemented from ns3::Socket.

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

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

Here is the call graph for this function:

uint32_t ns3::TcpSocketBase::BytesInFlight ( void )

protectedvirtual

Return total bytes in flight.

Returns: total bytes in flight

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

References ns3::TracedValue< T >::Get(), ns3::TcpTxBuffer::HeadSequence(), m_highTxMark, m_txBuffer, and NS_LOG_FUNCTION.

Referenced by ns3::TcpNewReno::DupAck(), ns3::TcpReno::DupAck(), ns3::TcpNewReno::NewAck(), ns3::TcpNewReno::Retransmit(), and ns3::TcpReno::Retransmit().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::CancelAllTimers ( void )

protected

Cancel all timer when endpoint is deleted.

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

References ns3::EventId::Cancel(), m_delAckEvent, m_lastAckEvent, m_persistEvent, m_retxEvent, and m_timewaitEvent.

Referenced by CloseAndNotify(), DeallocateEndPoint(), Destroy(), Destroy6(), TimeWait(), and ~TcpSocketBase().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::Close ( void )

virtual

Close a socket.

Returns: zero on success, -1 on failure.

After the Close call, the socket is no longer valid, and cannot safely be used for subsequent operations.

Internal:: First we check to see if there is any unread rx data. Bug 426 claims we should send reset in this case.

Implements ns3::Socket.

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

References DoClose(), m_closeOnEmpty, m_nextTxSequence, m_rxBuffer, m_state, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, SendRST(), ns3::TcpRxBuffer::Size(), ns3::TcpTxBuffer::SizeFromSequence(), and ns3::TcpSocket::TcpStateName.

Referenced by DoPeerClose().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::CloseAndNotify ( void )

protected

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

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

References CancelAllTimers(), ns3::CLOSED, DeallocateEndPoint(), m_closeNotified, m_state, ns3::Socket::NotifyNormalClose(), NS_LOG_FUNCTION, NS_LOG_INFO, ns3::TcpSocket::TcpStateName, and ns3::TIME_WAIT.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Complete a connection by forking the socket.

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.

Parameters

p	the packet triggering the fork
tcpHeader	the TCP header of the triggering packet
fromAddress	the address of the remote host
toAddress	the address the connection is directed to

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

References ns3::TcpHeader::ACK, ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::TcpHeader::GetSequenceNumber(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_cnCount, m_cnRetries, m_endPoint, m_endPoint6, m_rxBuffer, m_state, m_tcp, NS_LOG_INFO, SendEmptyPacket(), ns3::TcpRxBuffer::SetNextRxSequence(), SetupCallback(), ns3::TcpHeader::SYN, and ns3::SYN_RCVD.

Referenced by ProcessListen().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Initiate a connection to a remote host.

Parameters

address Address of remote.

Returns: 0 on success, -1 on error (in which case errno is set).

Implements ns3::Socket.

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

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

References Bind(), Bind6(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), DoConnect(), ns3::Socket::ERROR_INVAL, ns3::InetSocketAddress::GetIpv4(), ns3::Ipv6Address::GetIpv4MappedAddress(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::Ipv6Address::IsIpv4MappedAddress(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_cnCount, m_cnRetries, m_endPoint, m_endPoint6, m_errno, m_rtt, NS_ASSERT, NS_LOG_FUNCTION, ns3::Ipv4EndPoint::SetPeer(), ns3::Ipv6EndPoint::SetPeer(), SetupEndpoint(), and SetupEndpoint6().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::ConnectionSucceeded ( void )

protected

Schedule-friendly wrapper for Socket::NotifyConnectionSucceeded()

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

References GetTxAvailable(), ns3::Socket::NotifyConnectionSucceeded(), and ns3::Socket::NotifySend().

Referenced by ProcessSynSent().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::DeallocateEndPoint ( void )

protected

Deallocate m_endPoint.

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

References CancelAllTimers(), m_endPoint, m_endPoint6, m_tcp, ns3::Ipv4EndPoint::SetDestroyCallback(), and ns3::Ipv6EndPoint::SetDestroyCallback().

Referenced by CloseAndNotify(), and SendRST().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::DelAckTimeout ( void )

protectedvirtual

Action upon delay ACK timeout, i.e.

send an ACK

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

References ns3::TcpHeader::ACK, m_delAckCount, and SendEmptyPacket().

Referenced by ReceivedData().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::Destroy ( void )

protected

Kill this socket by zeroing its attributes (IPv4)

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

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

References CancelAllTimers(), ns3::Simulator::GetDelayLeft(), m_endPoint, m_retxEvent, m_tcp, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by SetupCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::Destroy6 ( void )

protected

Kill this socket by zeroing its attributes (IPv6)

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

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

References CancelAllTimers(), ns3::Simulator::GetDelayLeft(), m_endPoint6, m_retxEvent, m_tcp, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by SetupCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::DoClose ( void )

protected

Close a socket by sending RST, FIN, or FIN+ACK, depend on the current state.

Returns: 0 on success

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

References ns3::TcpHeader::ACK, ns3::CLOSE_WAIT, CloseAndNotify(), ns3::CLOSED, ns3::CLOSING, ns3::ESTABLISHED, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::FIN_WAIT_2, ns3::LAST_ACK, ns3::LISTEN, m_state, NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), SendRST(), ns3::SYN_RCVD, ns3::SYN_SENT, and ns3::TIME_WAIT.

Referenced by Close().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::DoConnect ( void )

protected

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

Returns: 0 on success

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

References ns3::CLOSE_WAIT, CloseAndNotify(), ns3::CLOSED, ns3::LAST_ACK, ns3::LISTEN, m_state, NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), SendRST(), ns3::TcpHeader::SYN, ns3::SYN_SENT, ns3::TcpSocket::TcpStateName, and ns3::TIME_WAIT.

Referenced by Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protectedvirtual

Called by TcpSocketBase::ForwardUp().

Parameters

packet	the incoming packet
header	the packet's IPv4 header
port	the incoming port
incomingInterface	the incoming interface

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

References ns3::TcpHeader::ACK, AddOptions(), AdvertisedWindowSize(), ns3::EventId::Cancel(), ns3::CLOSE_WAIT, ns3::CLOSED, ns3::CLOSING, ns3::ESTABLISHED, EstimateRtt(), ns3::FIN_WAIT_1, ns3::FIN_WAIT_2, ns3::TracedValue< T >::Get(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), ns3::LAST_ACK, ns3::LISTEN, ns3::Socket::m_boundnetdevice, m_endPoint, m_nextTxSequence, m_persistEvent, m_rWnd, m_rxBuffer, m_state, m_tcp, ns3::TcpRxBuffer::MaxRxSequence(), ns3::TcpRxBuffer::NextRxSequence(), NS_LOG_LOGIC, OutOfRange(), port, ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessListen(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ns3::TcpHeader::PSH, ReadOptions(), ns3::Packet::RemoveHeader(), ns3::TcpHeader::RST, SendEmptyPacket(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), ns3::TcpHeader::SetWindowSize(), ns3::SYN_RCVD, ns3::SYN_SENT, ns3::TcpSocket::TcpStateName, ns3::TIME_WAIT, and ns3::TcpHeader::URG.

Referenced by ForwardUp(), and ForwardUp6().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protectedvirtual

Called by TcpSocketBase::ForwardUp6().

Parameters

packet	the incoming packet
header	the packet's IPv6 header
port	the incoming port

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

References ns3::TcpHeader::ACK, AddOptions(), AdvertisedWindowSize(), ns3::EventId::Cancel(), ns3::CLOSE_WAIT, ns3::CLOSED, ns3::CLOSING, ns3::ESTABLISHED, EstimateRtt(), ns3::FIN_WAIT_1, ns3::FIN_WAIT_2, ns3::TracedValue< T >::Get(), ns3::Ipv6Header::GetDestinationAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), ns3::Ipv6Header::GetSourceAddress(), ns3::LAST_ACK, ns3::LISTEN, ns3::Socket::m_boundnetdevice, m_endPoint6, m_nextTxSequence, m_persistEvent, m_rWnd, m_rxBuffer, m_state, m_tcp, ns3::TcpRxBuffer::MaxRxSequence(), ns3::TcpRxBuffer::NextRxSequence(), NS_LOG_LOGIC, OutOfRange(), port, ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessListen(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ns3::TcpHeader::PSH, ReadOptions(), ns3::Packet::RemoveHeader(), ns3::TcpHeader::RST, SendEmptyPacket(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), ns3::TcpHeader::SetWindowSize(), ns3::SYN_RCVD, ns3::SYN_SENT, ns3::TcpSocket::TcpStateName, ns3::TIME_WAIT, and ns3::TcpHeader::URG.

Here is the call graph for this function:

void ns3::TcpSocketBase::DoPeerClose ( void )

protected

FIN is in sequence, notify app and respond with a FIN.

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

References ns3::TcpHeader::ACK, Close(), ns3::CLOSE_WAIT, ns3::ESTABLISHED, ns3::LAST_ACK, LastAckTimeout(), m_closeNotified, m_lastAckEvent, m_rtt, m_shutdownSend, m_state, ns3::Socket::NotifyNormalClose(), NS_ASSERT, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Simulator::Schedule(), SendEmptyPacket(), ns3::SYN_RCVD, and ns3::TcpSocket::TcpStateName.

Referenced by PeerClose(), and ReceivedData().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::DoRetransmit ( void )

protectedvirtual

Retransmit the oldest packet.

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

References ns3::CLOSING, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::TcpTxBuffer::HeadSequence(), m_cnCount, m_nextTxSequence, m_segmentSize, m_state, m_txBuffer, ns3::Socket::NotifyConnectionFailed(), NS_LOG_FUNCTION, NS_LOG_LOGIC, SendDataPacket(), SendEmptyPacket(), ns3::TcpTxBuffer::Size(), ns3::TcpHeader::SYN, and ns3::SYN_SENT.

Referenced by ns3::TcpNewReno::DupAck(), ns3::TcpReno::DupAck(), ns3::TcpTahoe::DupAck(), ns3::TcpWestwood::DupAck(), ns3::TcpNewReno::NewAck(), ns3::TcpNewReno::Retransmit(), ns3::TcpReno::Retransmit(), ns3::TcpTahoe::Retransmit(), ns3::TcpWestwood::Retransmit(), and Retransmit().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void ns3::TcpSocketBase::DupAck	(	const TcpHeader &	tcpHeader,
		uint32_t	count
	)

protectedpure virtual

Received dupack (duplicate ACK)

Parameters

tcpHeader	the packet's TCP header
count	counter of duplicate ACKs

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

Referenced by ReceivedAck().

Here is the caller graph for this function:

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

protectedvirtual

Take into account the packet for RTT estimation.

Parameters

tcpHeader the packet's TCP header

Reimplemented in ns3::TcpWestwood.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Ptr<TcpSocketBase> ns3::TcpSocketBase::Fork ( void )

protectedpure virtual

Call CopyObject<> to clone me.

Returns: a copy of the socket

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

Referenced by ProcessListen().

Here is the caller graph for this function:

void ns3::TcpSocketBase::ForwardIcmp	(	Ipv4Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo
	)

protected

Called by the L3 protocol when it received an ICMP packet to pass on to TCP.

Parameters

icmpSource	the ICMP source address
icmpTtl	the ICMP Time to Live
icmpType	the ICMP Type
icmpCode	the ICMP Code
icmpInfo	the ICMP Info

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

References m_icmpCallback, and NS_LOG_FUNCTION.

Referenced by SetupCallback().

Here is the caller graph for this function:

void ns3::TcpSocketBase::ForwardIcmp6	(	Ipv6Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo
	)

protected

Called by the L3 protocol when it received an ICMPv6 packet to pass on to TCP.

Parameters

icmpSource	the ICMP source address
icmpTtl	the ICMP Time to Live
icmpType	the ICMP Type
icmpCode	the ICMP Code
icmpInfo	the ICMP Info

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

References m_icmpCallback6, and NS_LOG_FUNCTION.

Referenced by SetupCallback().

Here is the caller graph for this function:

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

protected

Called by the L3 protocol when it received a packet to pass on to TCP.

Parameters

packet	the incoming packet
header	the packet's IPv4 header
port	the incoming port
incomingInterface	the incoming interface

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

References DoForwardUp().

Referenced by SetupCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::ForwardUp6	(	Ptr< Packet >	packet,
		Ipv6Header	header,
		uint16_t	port,
		Ptr< Ipv6Interface >	incomingInterface
	)

protected

Called by the L3 protocol when it received a packet to pass on to TCP.

Parameters

packet	the incoming packet
header	the packet's IPv6 header
port	the incoming port
incomingInterface	the incoming interface

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

References DoForwardUp().

Referenced by SetupCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

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 2417 of file tcp-socket-base.cc.

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

protectedvirtual

Get the number of connection retries before giving up.

Returns: the number of connection retries

Implements ns3::TcpSocket.

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

References m_cnRetries.

Time ns3::TcpSocketBase::GetConnTimeout ( void ) const

protectedvirtual

Get the connection timeout.

Returns: the connection timeout

Implements ns3::TcpSocket.

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

References m_cnTimeout.

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

protectedvirtual

Get the number of packet to fire an ACK before delay timeout.

Returns: the number of packet to fire an ACK before delay timeout

Implements ns3::TcpSocket.

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

References m_delAckMaxCount.

Time ns3::TcpSocketBase::GetDelAckTimeout ( void ) const

protectedvirtual

Get the time to delay an ACK.

Returns: the time to delay an ACK

Implements ns3::TcpSocket.

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

References m_delAckTimeout.

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

virtual

Get last error number.

Returns: the errno associated to the last call which failed in this socket. Each socket's errno is initialized to zero when the socket is created.

Implements ns3::Socket.

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

References m_errno.

virtual uint32_t ns3::TcpSocketBase::GetInitialCwnd ( void ) const

protectedpure virtual

Get the initial Congestion Window.

Returns: the initial congestion window (in bytes)

Implements ns3::TcpSocket.

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

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

virtual

Return the node this socket is associated with.

Returns: the node

Implements ns3::Socket.

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

References m_node, and NS_LOG_FUNCTION_NOARGS.

Time ns3::TcpSocketBase::GetPersistTimeout ( void ) const

protectedvirtual

Get the timout for persistent connection.

When the timout expires, send 1-byte data to probe for the window size at the receiver when the local knowledge tells that the receiver has zero window size

Returns: the persistent timout

Implements ns3::TcpSocket.

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

References m_persistTimeout.

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

protectedvirtual

Get the receive buffer size.

Returns: the buffer size (in bytes)

Implements ns3::TcpSocket.

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

References m_rxBuffer, and ns3::TcpRxBuffer::MaxBufferSize().

Here is the call graph for this function:

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

virtual

Return number of bytes which can be returned from one or multiple calls to Recv.

Must be possible to call this method from the Recv callback.

Returns: the number of bytes which can be returned from one or multiple Recv calls.

Implements ns3::Socket.

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

References ns3::TcpRxBuffer::Available(), m_rxBuffer, and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

protectedvirtual

Get the segment size.

Returns: the segment size (in bytes)

Implements ns3::TcpSocket.

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

References m_segmentSize.

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

protectedvirtual

Get the send buffer size.

Returns: the buffer size (in bytes)

Implements ns3::TcpSocket.

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

References m_txBuffer, and ns3::TcpTxBuffer::MaxBufferSize().

Here is the call graph for this function:

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

virtual

Returns: the socket type, analogous to getsockopt (SO_TYPE)

Implements ns3::Socket.

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

References ns3::Socket::NS3_SOCK_STREAM.

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

virtual

Get socket address.

Parameters

address the address name this socket is associated with.

Returns: 0 if success, -1 otherwise

Implements ns3::Socket.

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

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

Here is the call graph for this function:

virtual uint32_t ns3::TcpSocketBase::GetSSThresh ( void ) const

protectedpure virtual

Get the Slow Start Threshold.

Returns: the Slow Start Threshold (in bytes)

Implements ns3::TcpSocket.

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

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

protectedvirtual

Check if Nagle's algorithm is enabled or not.

Returns: true if Nagle's algorithm is DISABLED

Implements ns3::TcpSocket.

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

References m_noDelay.

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

virtual

Returns the number of bytes which can be sent in a single call to Send.

For datagram sockets, this returns the number of bytes that can be passed atomically through the underlying protocol.

For stream sockets, this returns the available space in bytes left in the transmit buffer.

Returns: The number of bytes which can be sent in a single Send call.

Implements ns3::Socket.

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

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

Referenced by ConnectionSucceeded(), NewAck(), and ProcessSynRcvd().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::TcpSocketBase::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References m_highTxMark, m_icmpCallback, m_icmpCallback6, m_lastRtt, m_maxWinSize, m_msl, m_nextTxSequence, m_rto, m_rWnd, m_state, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::TcpSocketBase::LastAckTimeout ( void )

protectedvirtual

Timeout at LAST_ACK, close the connection.

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

References ns3::EventId::Cancel(), CloseAndNotify(), ns3::LAST_ACK, m_closeNotified, m_lastAckEvent, m_state, and NS_LOG_FUNCTION.

Referenced by DoPeerClose().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::Listen ( void )

virtual

Listen for incoming connections.

Returns: 0 on success, -1 on error (in which case errno is set).

Implements ns3::Socket.

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

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

References ns3::CLOSED, ns3::Socket::ERROR_INVAL, ns3::LISTEN, m_errno, m_state, NS_LOG_FUNCTION, and NS_LOG_INFO.

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

Here is the caller graph for this function:

void ns3::TcpSocketBase::NewAck ( SequenceNumber32 const & seq )

protectedvirtual

Update buffers w.r.t.

ACK

Parameters

seq	the sequence number

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

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

References ns3::EventId::Cancel(), ns3::CLOSING, ns3::TcpTxBuffer::DiscardUpTo(), ns3::FIN_WAIT_1, ns3::TracedValue< T >::Get(), ns3::Simulator::GetDelayLeft(), GetTxAvailable(), ns3::TcpTxBuffer::HeadSequence(), ns3::EventId::IsExpired(), m_connected, m_nextTxSequence, m_persistEvent, m_persistTimeout, m_retxEvent, m_rto, m_rtt, m_rWnd, m_state, m_txBuffer, ns3::Socket::NotifySend(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, PersistTimeout(), ReTxTimeout(), ns3::Simulator::Schedule(), SendPendingData(), ns3::TcpTxBuffer::Size(), and ns3::SYN_RCVD.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Check if a sequence number range is within the rx window.

Parameters

head	start of the Sequence window
tail	end of the Sequence window

Returns: true if it is in range

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

References ns3::CLOSE_WAIT, ns3::CLOSING, ns3::LAST_ACK, ns3::LISTEN, m_rxBuffer, m_state, ns3::TcpRxBuffer::MaxRxSequence(), ns3::TcpRxBuffer::NextRxSequence(), ns3::SYN_RCVD, and ns3::SYN_SENT.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a FIN from peer, notify rx buffer.

Parameters

p	the packet
tcpHeader	the packet's TCP header

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

References ns3::CLOSING, DoPeerClose(), ns3::FIN_WAIT_1, ns3::TcpRxBuffer::Finished(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), m_rxBuffer, m_state, ns3::TcpRxBuffer::MaxRxSequence(), ns3::TcpRxBuffer::NextRxSequence(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ReceivedData(), and ns3::TcpRxBuffer::SetFinSequence().

Referenced by ProcessEstablished(), and ProcessSynRcvd().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::PersistTimeout ( void )

protectedvirtual

Send 1 byte probe to get an updated window size.

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

References AddOptions(), AdvertisedWindowSize(), ns3::TcpTxBuffer::CopyFromSequence(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Socket::m_boundnetdevice, m_endPoint, m_endPoint6, m_nextTxSequence, m_persistEvent, m_persistTimeout, m_rxBuffer, m_tcp, m_txBuffer, ns3::TcpRxBuffer::NextRxSequence(), ns3::Simulator::Now(), NS_LOG_LOGIC, ns3::Simulator::Schedule(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), and ns3::TcpHeader::SetWindowSize().

Referenced by NewAck().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon CLOSING.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_rxBuffer, ns3::TcpRxBuffer::NextRxSequence(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), TimeWait(), and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpRxBuffer::Finished(), ns3::TcpHeader::GetFlags(), m_rxBuffer, NS_LOG_FUNCTION, NS_LOG_LOGIC, PeerClose(), ns3::TcpHeader::PSH, ReceivedAck(), ReceivedData(), ns3::TcpHeader::RST, SendRST(), ns3::TcpHeader::SYN, and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon LAST_ACK.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_rxBuffer, ns3::TcpRxBuffer::NextRxSequence(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedData(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon LISTEN state.

Parameters

packet	the packet
tcpHeader	the packet's TCP header
fromAddress	the source address
toAddress	the destination address

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

References CompleteFork(), Fork(), ns3::TcpHeader::GetFlags(), ns3::Socket::NotifyConnectionRequest(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ns3::Simulator::ScheduleNow(), ns3::TcpHeader::SYN, and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon SYN_RCVD.

Parameters

packet	the packet
tcpHeader	the packet's TCP header
fromAddress	the source address
toAddress	the destination address

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

References ns3::TcpHeader::ACK, ns3::EventId::Cancel(), CloseAndNotify(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::ESTABLISHED, ns3::TcpHeader::FIN, ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), GetTxAvailable(), m_connected, m_delAckCount, m_delAckMaxCount, m_endPoint, m_endPoint6, m_highTxMark, m_nextTxSequence, m_retxEvent, m_rxBuffer, m_state, m_txBuffer, ns3::TcpRxBuffer::NextRxSequence(), ns3::Socket::NotifyNewConnectionCreated(), ns3::Socket::NotifySend(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PeerClose(), ns3::TcpHeader::PSH, ReceivedAck(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), ns3::TcpTxBuffer::SetHeadSequence(), ns3::TcpRxBuffer::SetNextRxSequence(), ns3::Ipv4EndPoint::SetPeer(), ns3::Ipv6EndPoint::SetPeer(), ns3::TcpHeader::SYN, and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon SYN_SENT.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, ns3::EventId::Cancel(), CloseAndNotify(), ConnectionSucceeded(), ns3::ESTABLISHED, ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_cnCount, m_cnRetries, m_connected, m_delAckCount, m_delAckMaxCount, m_highTxMark, m_nextTxSequence, m_retxEvent, m_rxBuffer, m_state, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedData(), ns3::TcpHeader::RST, ns3::Simulator::ScheduleNow(), SendEmptyPacket(), SendPendingData(), SendRST(), ns3::TcpTxBuffer::SetHeadSequence(), ns3::TcpRxBuffer::SetNextRxSequence(), ns3::TcpHeader::SYN, ns3::SYN_RCVD, and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Received a packet upon CLOSE_WAIT, FIN_WAIT_1, FIN_WAIT_2.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::CLOSING, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::FIN_WAIT_2, ns3::TcpRxBuffer::Finished(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), m_highTxMark, m_rxBuffer, m_shutdownRecv, m_state, m_txBuffer, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedAck(), ReceivedData(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), ns3::TcpRxBuffer::SetFinSequence(), ns3::TcpTxBuffer::Size(), ns3::TcpHeader::SYN, TimeWait(), and ns3::TcpHeader::URG.

Referenced by DoForwardUp().

Here is the call graph for this function:

Here is the caller graph for this function:

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

protectedvirtual

Read option from incoming packets.

Parameters

tcpHeader the packet's TCP header

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

Referenced by DoForwardUp().

Here is the caller graph for this function:

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

protectedvirtual

Received an ACK packet.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

Reimplemented in ns3::TcpWestwood.

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

References ns3::TcpHeader::ACK, DupAck(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::Packet::GetSize(), ns3::TcpTxBuffer::HeadSequence(), m_dupAckCount, m_nextTxSequence, m_txBuffer, NewAck(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ReceivedData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

protectedvirtual

Recv of a data, put into buffer, call L7 to get it if necessary.

Parameters

packet	the packet
tcpHeader	the packet's TCP header

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

References ns3::TcpHeader::ACK, ns3::TcpRxBuffer::Add(), ns3::TcpRxBuffer::Available(), ns3::EventId::Cancel(), DelAckTimeout(), DoPeerClose(), ns3::TcpHeader::FIN, ns3::TcpRxBuffer::Finished(), ns3::TcpHeader::GetAckNumber(), ns3::Simulator::GetDelayLeft(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::EventId::IsExpired(), m_closeNotified, m_delAckCount, m_delAckEvent, m_delAckMaxCount, m_delAckTimeout, m_rxBuffer, m_shutdownRecv, ns3::TcpRxBuffer::NextRxSequence(), ns3::Socket::NotifyDataRecv(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::Simulator::Schedule(), SendEmptyPacket(), and ns3::TcpRxBuffer::Size().

Referenced by PeerClose(), ProcessEstablished(), ProcessLastAck(), ProcessSynSent(), ProcessWait(), and ReceivedAck().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Read data from the socket.

This function matches closely in semantics to the recv() function call in the standard C library (libc): ssize_t recv (int s, void *buf, size_t len, int flags); except that the receive I/O is asynchronous. This is the primary Recv method at this low-level API and must be implemented by subclasses.

This method is normally used only on a connected socket. In a typical blocking sockets model, this call would block until at least one byte is returned or the connection closes. In ns-3 at this API, the call returns immediately in such a case and returns 0 if nothing is available to be read. However, an application can set a callback, ns3::SetRecvCallback, to be notified of data being available to be read (when it conceptually unblocks); this is an asynchronous I/O model for recv().

This variant of Recv() uses class ns3::Packet to encapsulate data, rather than providing a raw pointer and length field. This allows an ns-3 application to attach tags if desired (such as a flow ID) and may allow the simulator to avoid some data copies. Despite the appearance of receiving Packets on a stream socket, just think of it as a fancy byte buffer with streaming semantics.

The semantics depend on the type of socket. For a datagram socket, each Recv() returns the data from at most one Send(), and order is not necessarily preserved. For a stream socket, the bytes are delivered in order, and on-the-wire packet boundaries are not preserved.

The flags argument is formed by or'ing one or more of the values: MSG_OOB process out-of-band data MSG_PEEK peek at incoming message None of these flags are supported for now.

Some variants of Recv() are supported as additional API, including RecvFrom(), overloaded Recv() without arguments, and variants that use raw character buffers.

Parameters

maxSize	reader will accept packet up to maxSize
flags	Socket control flags

Returns: Ptr<Packet> of the next in-sequence packet. Returns 0 if the socket cannot return a next in-sequence packet conforming to the maxSize and flags.

See also: SetRecvCallback

Implements ns3::Socket.

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

References ns3::Packet::AddPacketTag(), ns3::CLOSE_WAIT, ns3::TcpRxBuffer::Extract(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), m_endPoint, m_endPoint6, m_rxBuffer, m_state, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::SocketAddressTag::SetAddress(), and ns3::TcpRxBuffer::Size().

Here is the call graph for this function:

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

virtual

Read a single packet from the socket and retrieve the sender address.

Calls Recv(maxSize, flags) with maxSize implicitly set to maximum sized integer, and flags set to zero.

This method has similar semantics to Recv () but subclasses may want to provide checks on socket state, so the implementation is pushed to subclasses.

Parameters

maxSize	reader will accept packet up to maxSize
flags	Socket control flags
fromAddress	output parameter that will return the address of the sender of the received packet, if any. Remains untouched if no packet is received.

Returns: Ptr<Packet> of the next in-sequence packet. Returns 0 if the socket cannot return a next in-sequence packet.

Implements ns3::Socket.

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

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

Here is the call graph for this function:

void ns3::TcpSocketBase::Retransmit ( void )

protectedvirtual

Halving cwnd and call DoRetransmit()

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

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

References DoRetransmit(), ns3::TcpTxBuffer::HeadSequence(), m_dupAckCount, m_nextTxSequence, m_rtt, and m_txBuffer.

Referenced by ReTxTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::ReTxTimeout ( void )

protectedvirtual

Call Retransmit() upon RTO event.

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

References ns3::CLOSED, ns3::ESTABLISHED, ns3::TcpTxBuffer::HeadSequence(), m_highTxMark, m_state, m_txBuffer, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, Retransmit(), and ns3::TIME_WAIT.

Referenced by NewAck(), and SendDataPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Send data (or dummy data) to the remote host.

This function matches closely in semantics to the send() function call in the standard C library (libc): ssize_t send (int s, const void *msg, size_t len, int flags); except that the send I/O is asynchronous. This is the primary Send method at this low-level API and must be implemented by subclasses.

In a typical blocking sockets model, this call would block upon lack of space to hold the message to be sent. In ns-3 at this API, the call returns immediately in such a case, but the callback registered with SetSendCallback() is invoked when the socket has space (when it conceptually unblocks); this is an asynchronous I/O model for send().

This variant of Send() uses class ns3::Packet to encapsulate data, rather than providing a raw pointer and length field. This allows an ns-3 application to attach tags if desired (such as a flow ID) and may allow the simulator to avoid some data copies. Despite the appearance of sending Packets on a stream socket, just think of it as a fancy byte buffer with streaming semantics.

If either the message buffer within the Packet is too long to pass atomically through the underlying protocol (for datagram sockets), or the message buffer cannot entirely fit in the transmit buffer (for stream sockets), -1 is returned and SocketErrno is set to ERROR_MSGSIZE. If the packet does not fit, the caller can split the Packet (based on information obtained from GetTxAvailable) and reattempt to send the data.

The flags argument is formed by or'ing one or more of the values: MSG_OOB process out-of-band data MSG_DONTROUTE bypass routing, use direct interface These flags are unsupported as of ns-3.1.

Parameters

p	ns3::Packet to send
flags	Socket control flags

Returns: the number of bytes accepted for transmission if no error occurs, and -1 otherwise.

See also: SetSendCallback

Implements ns3::Socket.

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

References ns3::TcpTxBuffer::Add(), ns3::CLOSE_WAIT, ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_NOTCONN, ns3::Socket::ERROR_SHUTDOWN, ns3::ESTABLISHED, ns3::Packet::GetSize(), m_connected, m_errno, m_shutdownSend, m_state, m_txBuffer, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, NS_LOG_LOGIC, SendPendingData(), ns3::TcpTxBuffer::Size(), ns3::SYN_SENT, and ns3::TcpSocket::TcpStateName.

Referenced by SendTo().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

seq	the sequence number
maxSize	the maximum data block to be transmitted (in bytes)
withAck	forces an ACK to be sent

Returns: the number of bytes sent

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

References ns3::TcpHeader::ACK, AddOptions(), ns3::Packet::AddPacketTag(), AdvertisedWindowSize(), ns3::CLOSE_WAIT, ns3::TcpTxBuffer::CopyFromSequence(), ns3::ESTABLISHED, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::TracedValue< T >::Get(), ns3::Socket::GetIpTos(), ns3::Socket::GetIpTtl(), ns3::Socket::GetIpv6HopLimit(), ns3::Socket::GetIpv6Tclass(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Packet::GetSize(), ns3::EventId::IsExpired(), ns3::Socket::IsManualIpTos(), ns3::Socket::IsManualIpTtl(), ns3::Socket::IsManualIpv6HopLimit(), ns3::Socket::IsManualIpv6Tclass(), ns3::LAST_ACK, ns3::Socket::m_boundnetdevice, m_closeOnEmpty, m_endPoint, m_endPoint6, m_highTxMark, m_nextTxSequence, m_retxEvent, m_rto, m_rtt, m_rxBuffer, m_state, m_tcp, m_txBuffer, ns3::TcpRxBuffer::NextRxSequence(), ns3::Socket::NotifyDataSent(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ReTxTimeout(), ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::SocketIpv6HopLimitTag::SetHopLimit(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), ns3::SocketIpv6TclassTag::SetTclass(), ns3::SocketIpTosTag::SetTos(), ns3::SocketIpTtlTag::SetTtl(), ns3::TcpHeader::SetWindowSize(), and ns3::TcpTxBuffer::SizeFromSequence().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

Send a empty packet that carries a flag, e.g.

ACK

Parameters

flags the packet's flags

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

References ns3::TcpHeader::ACK, AddOptions(), ns3::Packet::AddPacketTag(), AdvertisedWindowSize(), ns3::EventId::Cancel(), CloseAndNotify(), ns3::CLOSING, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::Socket::GetIpTos(), ns3::Socket::GetIpTtl(), ns3::Socket::GetIpv6HopLimit(), ns3::Socket::GetIpv6Tclass(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::EventId::IsExpired(), ns3::Socket::IsManualIpTos(), ns3::Socket::IsManualIpTtl(), ns3::Socket::IsManualIpv6HopLimit(), ns3::Socket::IsManualIpv6Tclass(), ns3::LAST_ACK, ns3::Socket::m_boundnetdevice, m_cnCount, m_cnRetries, m_cnTimeout, m_delAckCount, m_delAckEvent, m_endPoint, m_endPoint6, m_nextTxSequence, m_retxEvent, m_rto, m_rtt, m_rxBuffer, m_state, m_tcp, ns3::TcpRxBuffer::NextRxSequence(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, s, ns3::Simulator::Schedule(), ns3::SocketIpv6HopLimitTag::SetHopLimit(), ns3::SocketIpv6TclassTag::SetTclass(), ns3::SocketIpTosTag::SetTos(), ns3::SocketIpTtlTag::SetTtl(), and ns3::TcpHeader::SYN.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Parameters

withAck forces an ACK to be sent

Returns: true if some data have been sent

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

References AvailableWindow(), ns3::TcpTxBuffer::HeadSequence(), m_endPoint, m_endPoint6, m_nextTxSequence, m_noDelay, m_rWnd, m_segmentSize, m_shutdownSend, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, s, SendDataPacket(), ns3::TcpTxBuffer::Size(), ns3::TcpTxBuffer::SizeFromSequence(), UnAckDataCount(), and visualizer.higcontainer::w.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::TcpSocketBase::SendRST ( void )

protected

Send reset and tear down this socket.

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

References DeallocateEndPoint(), ns3::Socket::NotifyErrorClose(), NS_LOG_FUNCTION, ns3::TcpHeader::RST, and SendEmptyPacket().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Send data to a specified peer.

This method has similar semantics to Send () but subclasses may want to provide checks on socket state, so the implementation is pushed to subclasses.

Parameters

p	packet to send
flags	Socket control flags
toAddress	IP Address of remote host

Returns: -1 in case of error or the number of bytes copied in the internal buffer and accepted for transmission.

Implements ns3::Socket.

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

References Send().

Here is the call graph for this function:

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 2410 of file tcp-socket-base.cc.

void ns3::TcpSocketBase::SetConnCount ( uint32_t count )

protectedvirtual

Set the number of connection retries before giving up.

Parameters

count the number of connection retries

Implements ns3::TcpSocket.

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

References m_cnRetries.

void ns3::TcpSocketBase::SetConnTimeout ( Time timeout )

protectedvirtual

Set the connection timeout.

Parameters

timeout the connection timeout

Implements ns3::TcpSocket.

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

References m_cnTimeout, and timeout.

void ns3::TcpSocketBase::SetDelAckMaxCount ( uint32_t count )

protectedvirtual

Set the number of packet to fire an ACK before delay timeout.

Parameters

count the umber of packet to fire an ACK before delay timeout

Implements ns3::TcpSocket.

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

References m_delAckMaxCount.

Referenced by ns3::TcpRfc793::TcpRfc793().

Here is the caller graph for this function:

void ns3::TcpSocketBase::SetDelAckTimeout ( Time timeout )

protectedvirtual

Set the time to delay an ACK.

Parameters

timeout the time to delay an ACK

Implements ns3::TcpSocket.

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

References m_delAckTimeout, and timeout.

virtual void ns3::TcpSocketBase::SetInitialCwnd ( uint32_t cwnd )

protectedpure virtual

Set the initial Congestion Window.

Parameters

cwnd	the initial congestion window (in bytes)

Implements ns3::TcpSocket.

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

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

virtual

Set the associated node.

Parameters

node the node

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

References m_node.

Referenced by ns3::TcpL4Protocol::CreateSocket().

Here is the caller graph for this function:

void ns3::TcpSocketBase::SetPersistTimeout ( Time timeout )

protectedvirtual

Set the timout for persistent connection.

When the timout expires, send 1-byte data to probe for the window size at the receiver when the local knowledge tells that the receiver has zero window size

Parameters

timeout the persistent timout

Implements ns3::TcpSocket.

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

References m_persistTimeout, and timeout.

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

protectedvirtual

Set the receive buffer size.

Parameters

size	the buffer size (in bytes)

Implements ns3::TcpSocket.

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

References m_rxBuffer, and ns3::TcpRxBuffer::SetMaxBufferSize().

Here is the call graph for this function:

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

virtual

Set the associated RTT estimator.

Parameters

rtt	the RTT estimator

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

References m_rtt.

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

protectedvirtual

Set the segment size.

Parameters

size	the segment size (in bytes)

Implements ns3::TcpSocket.

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

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

References ns3::CLOSED, m_segmentSize, m_state, and NS_ABORT_MSG_UNLESS.

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

protectedvirtual

Set the send buffer size.

Parameters

size	the buffer size (in bytes)

Implements ns3::TcpSocket.

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

References m_txBuffer, and ns3::TcpTxBuffer::SetMaxBufferSize().

Here is the call graph for this function:

virtual void ns3::TcpSocketBase::SetSSThresh ( uint32_t threshold )

protectedpure virtual

Set the Slow Start Threshold.

Parameters

threshold the Slow Start Threshold (in bytes)

Implements ns3::TcpSocket.

Implemented in ns3::TcpWestwood, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::TcpRfc793.

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

virtual

Set the associated TCP L4 protocol.

Parameters

tcp	the TCP L4 protocol

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

References m_tcp.

void ns3::TcpSocketBase::SetTcpNoDelay ( bool noDelay )

protectedvirtual

Enable/Disable Nagle's algorithm.

Parameters

noDelay true to DISABLE Nagle's algorithm

Implements ns3::TcpSocket.

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

References m_noDelay.

int ns3::TcpSocketBase::SetupCallback ( void )

protected

Common part of the two Bind(), i.e.

set callback and remembering local addr:port

Returns: 0 on success, -1 on failure

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

References Destroy(), Destroy6(), ForwardIcmp(), ForwardIcmp6(), ForwardUp(), ForwardUp6(), m_endPoint, m_endPoint6, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::Ipv4EndPoint::SetDestroyCallback(), ns3::Ipv6EndPoint::SetDestroyCallback(), ns3::Ipv4EndPoint::SetIcmpCallback(), ns3::Ipv6EndPoint::SetIcmpCallback(), ns3::Ipv4EndPoint::SetRxCallback(), and ns3::Ipv6EndPoint::SetRxCallback().

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

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::SetupEndpoint ( void )

protected

Configure the endpoint to a local address.

Called by Connect() if Bind() didn't specify one.

Returns: 0 on success

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

References ns3::Object::GetObject(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv4Route::GetSource(), ns3::Socket::m_boundnetdevice, m_endPoint, m_errno, m_node, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Ipv4Header::SetDestination(), and ns3::Ipv4EndPoint::SetLocalAddress().

Referenced by Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::SetupEndpoint6 ( void )

protected

Configure the endpoint v6 to a local address.

Called by Connect() if Bind() didn't specify one.

Returns: 0 on success

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

References ns3::Object::GetObject(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Socket::m_boundnetdevice, m_endPoint6, m_errno, m_node, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Ipv6Header::SetDestinationAddress(), and ns3::Ipv6EndPoint::SetLocalAddress().

Referenced by Connect().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::TcpSocketBase::ShutdownRecv ( void )

virtual

Returns: zero on success, -1 on failure.

Do not allow any further Recv calls. This method is typically implemented for Tcp sockets by a half close.

Implements ns3::Socket.

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

References m_shutdownRecv, and NS_LOG_FUNCTION.

int ns3::TcpSocketBase::ShutdownSend ( void )

virtual

Returns: zero on success, -1 on failure.

Do not allow any further Send calls. This method is typically implemented for Tcp sockets by a half close.

Implements ns3::Socket.

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

References ns3::CLOSE_WAIT, ns3::ESTABLISHED, ns3::TcpHeader::FIN, ns3::FIN_WAIT_1, ns3::LAST_ACK, m_closeOnEmpty, m_shutdownSend, m_state, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, SendEmptyPacket(), and ns3::TcpTxBuffer::Size().

Here is the call graph for this function:

void ns3::TcpSocketBase::TimeWait ( void )

protected

Move from CLOSING or FIN_WAIT_2 to TIME_WAIT state.

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

References CancelAllTimers(), CloseAndNotify(), m_msl, m_state, m_timewaitEvent, NS_LOG_INFO, ns3::Simulator::Schedule(), ns3::TcpSocket::TcpStateName, and ns3::TIME_WAIT.

Referenced by ProcessClosing(), and ProcessWait().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TcpSocketBase::UnAckDataCount ( void )

protectedvirtual

Return count of number of unacked bytes.

Returns: count of number of unacked bytes

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

References ns3::TracedValue< T >::Get(), ns3::TcpTxBuffer::HeadSequence(), m_nextTxSequence, m_txBuffer, and NS_LOG_FUNCTION.

Referenced by AvailableWindow(), and SendPendingData().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::TcpSocketBase::Window ( void )

protectedvirtual

Return the max possible number of unacked bytes.

Returns: the max possible number of unacked bytes

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

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

References m_rWnd, and NS_LOG_FUNCTION.

Referenced by AvailableWindow().

Here is the caller graph for this function:

Member Data Documentation

bool ns3::TcpSocketBase::m_closeNotified

protected

Told app to close socket.

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

Referenced by CloseAndNotify(), DoPeerClose(), LastAckTimeout(), and ReceivedData().

bool ns3::TcpSocketBase::m_closeOnEmpty

protected

Close socket upon tx buffer emptied.

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

Referenced by Close(), SendDataPacket(), and ShutdownSend().

uint32_t ns3::TcpSocketBase::m_cnCount

protected

Count of remaining connection retries.

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

Referenced by CompleteFork(), Connect(), DoRetransmit(), ProcessSynSent(), and SendEmptyPacket().

uint32_t ns3::TcpSocketBase::m_cnRetries

protected

Number of connection retries before giving up.

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

Referenced by CompleteFork(), Connect(), GetConnCount(), ProcessSynSent(), SendEmptyPacket(), and SetConnCount().

Time ns3::TcpSocketBase::m_cnTimeout

protected

Timeout for connection retry.

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

Referenced by GetConnTimeout(), SendEmptyPacket(), and SetConnTimeout().

bool ns3::TcpSocketBase::m_connected

protected

Connection established.

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

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

uint32_t ns3::TcpSocketBase::m_delAckCount

protected

Delayed ACK counter.

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

Referenced by DelAckTimeout(), ProcessSynRcvd(), ProcessSynSent(), ReceivedData(), and SendEmptyPacket().

EventId ns3::TcpSocketBase::m_delAckEvent

protected

Delayed ACK timeout event.

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

Referenced by CancelAllTimers(), ReceivedData(), and SendEmptyPacket().

uint32_t ns3::TcpSocketBase::m_delAckMaxCount

protected

Number of packet to fire an ACK before delay timeout.

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

Referenced by GetDelAckMaxCount(), ProcessSynRcvd(), ProcessSynSent(), ReceivedData(), and SetDelAckMaxCount().

Time ns3::TcpSocketBase::m_delAckTimeout

protected

Time to delay an ACK.

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

Referenced by GetDelAckTimeout(), ReceivedData(), and SetDelAckTimeout().

uint32_t ns3::TcpSocketBase::m_dupAckCount

protected

Dupack counter.

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

Referenced by ReceivedAck(), and Retransmit().

Ipv4EndPoint* ns3::TcpSocketBase::m_endPoint

protected

the IPv4 endpoint

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

Referenced by Bind(), BindToNetDevice(), CompleteFork(), Connect(), DeallocateEndPoint(), Destroy(), DoForwardUp(), GetSockName(), PersistTimeout(), ProcessSynRcvd(), Recv(), RecvFrom(), SendDataPacket(), SendEmptyPacket(), SendPendingData(), SetupCallback(), SetupEndpoint(), and ~TcpSocketBase().

Ipv6EndPoint* ns3::TcpSocketBase::m_endPoint6

protected

the IPv6 endpoint

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

Referenced by Bind(), Bind6(), BindToNetDevice(), CompleteFork(), Connect(), DeallocateEndPoint(), Destroy6(), DoForwardUp(), GetSockName(), PersistTimeout(), ProcessSynRcvd(), Recv(), RecvFrom(), SendDataPacket(), SendEmptyPacket(), SendPendingData(), SetupCallback(), SetupEndpoint6(), and ~TcpSocketBase().

enum SocketErrno ns3::TcpSocketBase::m_errno

protected

Socket error code.

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

Referenced by Bind(), Bind6(), Connect(), GetErrno(), Listen(), Send(), SetupEndpoint(), and SetupEndpoint6().

TracedValue<SequenceNumber32> ns3::TcpSocketBase::m_highTxMark

protected

Highest seqno ever sent, regardless of ReTx.

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

Referenced by BytesInFlight(), ns3::TcpNewReno::DupAck(), GetTypeId(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ns3::TcpNewReno::Retransmit(), ns3::TcpReno::Retransmit(), ns3::TcpTahoe::Retransmit(), ReTxTimeout(), and SendDataPacket().

Callback<void, Ipv4Address,uint8_t,uint8_t,uint8_t,uint32_t> ns3::TcpSocketBase::m_icmpCallback

protected

ICMP callback.

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

Referenced by ForwardIcmp(), and GetTypeId().

Callback<void, Ipv6Address,uint8_t,uint8_t,uint8_t,uint32_t> ns3::TcpSocketBase::m_icmpCallback6

protected

ICMPv6 callback.

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

Referenced by ForwardIcmp6(), and GetTypeId().

EventId ns3::TcpSocketBase::m_lastAckEvent

protected

Last ACK timeout event.

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

Referenced by CancelAllTimers(), DoPeerClose(), and LastAckTimeout().

TracedValue<Time> ns3::TcpSocketBase::m_lastRtt

protected

Last RTT sample collected.

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

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

uint16_t ns3::TcpSocketBase::m_maxWinSize

protected

Maximum window size to advertise.

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

Referenced by AdvertisedWindowSize(), and GetTypeId().

double ns3::TcpSocketBase::m_msl

protected

Max segment lifetime.

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

Referenced by GetTypeId(), and TimeWait().

TracedValue<SequenceNumber32> ns3::TcpSocketBase::m_nextTxSequence

protected

Next seqnum to be sent (SND.NXT), ReTx pushes it back.

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

Referenced by Close(), DoForwardUp(), DoRetransmit(), ns3::TcpNewReno::DupAck(), ns3::TcpTahoe::DupAck(), GetTypeId(), NewAck(), PersistTimeout(), ProcessSynRcvd(), ProcessSynSent(), ReceivedAck(), ns3::TcpNewReno::Retransmit(), ns3::TcpReno::Retransmit(), ns3::TcpTahoe::Retransmit(), ns3::TcpWestwood::Retransmit(), Retransmit(), SendDataPacket(), SendEmptyPacket(), SendPendingData(), and UnAckDataCount().

Ptr<Node> ns3::TcpSocketBase::m_node

protected

the associated node

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

Referenced by GetNode(), SetNode(), SetupEndpoint(), SetupEndpoint6(), and ~TcpSocketBase().

bool ns3::TcpSocketBase::m_noDelay

protected

Set to true to disable Nagle's algorithm.

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

Referenced by GetTcpNoDelay(), SendPendingData(), and SetTcpNoDelay().

EventId ns3::TcpSocketBase::m_persistEvent

protected

Persist event: Send 1 byte to probe for a non-zero Rx window.

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

Referenced by CancelAllTimers(), DoForwardUp(), NewAck(), and PersistTimeout().

Time ns3::TcpSocketBase::m_persistTimeout

protected

Time between sending 1-byte probes.

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

Referenced by GetPersistTimeout(), NewAck(), PersistTimeout(), and SetPersistTimeout().

EventId ns3::TcpSocketBase::m_retxEvent

protected

Retransmission event.

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

Referenced by CancelAllTimers(), Destroy(), Destroy6(), NewAck(), ProcessSynRcvd(), ProcessSynSent(), SendDataPacket(), and SendEmptyPacket().

TracedValue<Time> ns3::TcpSocketBase::m_rto

protected

Retransmit timeout.

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

Referenced by GetTypeId(), NewAck(), SendDataPacket(), and SendEmptyPacket().

Ptr<RttEstimator> ns3::TcpSocketBase::m_rtt

protected

Round trip time estimator.

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

Referenced by Connect(), DoPeerClose(), EstimateRtt(), NewAck(), ns3::TcpNewReno::Retransmit(), ns3::TcpReno::Retransmit(), ns3::TcpTahoe::Retransmit(), ns3::TcpWestwood::Retransmit(), Retransmit(), SendDataPacket(), SendEmptyPacket(), SetRtt(), and TcpSocketBase().

TracedValue<uint32_t> ns3::TcpSocketBase::m_rWnd

protected

Flow control window at remote side.

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

Referenced by DoForwardUp(), GetTypeId(), NewAck(), SendPendingData(), ns3::TcpNewReno::Window(), ns3::TcpReno::Window(), ns3::TcpTahoe::Window(), ns3::TcpWestwood::Window(), and Window().

TcpRxBuffer ns3::TcpSocketBase::m_rxBuffer

protected

Rx buffer (reordering buffer)

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

Referenced by AdvertisedWindowSize(), Close(), CompleteFork(), DoForwardUp(), GetRcvBufSize(), GetRxAvailable(), OutOfRange(), PeerClose(), PersistTimeout(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReceivedData(), Recv(), SendDataPacket(), SendEmptyPacket(), and SetRcvBufSize().

uint32_t ns3::TcpSocketBase::m_segmentSize

protected

bool ns3::TcpSocketBase::m_shutdownRecv

protected

Receive no longer allowed.

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

Referenced by ProcessWait(), ReceivedData(), and ShutdownRecv().

bool ns3::TcpSocketBase::m_shutdownSend

protected

Send no longer allowed.

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

Referenced by DoPeerClose(), Send(), SendPendingData(), and ShutdownSend().

TracedValue<TcpStates_t> ns3::TcpSocketBase::m_state

protected

TCP state.

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

Referenced by Close(), CloseAndNotify(), CompleteFork(), DoClose(), DoConnect(), DoForwardUp(), DoPeerClose(), DoRetransmit(), ns3::TcpWestwood::EstimateRtt(), GetTypeId(), LastAckTimeout(), Listen(), NewAck(), OutOfRange(), PeerClose(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), Recv(), ns3::TcpNewReno::Retransmit(), ns3::TcpReno::Retransmit(), ns3::TcpTahoe::Retransmit(), ns3::TcpWestwood::Retransmit(), ReTxTimeout(), Send(), SendDataPacket(), SendEmptyPacket(), ns3::TcpNewReno::SetInitialCwnd(), ns3::TcpReno::SetInitialCwnd(), ns3::TcpTahoe::SetInitialCwnd(), ns3::TcpWestwood::SetInitialCwnd(), ns3::TcpNewReno::SetSegSize(), ns3::TcpReno::SetSegSize(), ns3::TcpTahoe::SetSegSize(), ns3::TcpWestwood::SetSegSize(), SetSegSize(), ShutdownSend(), and TimeWait().

Ptr<TcpL4Protocol> ns3::TcpSocketBase::m_tcp

protected

the associated TCP L4 protocol

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

Referenced by Bind(), Bind6(), CompleteFork(), DeallocateEndPoint(), Destroy(), Destroy6(), DoForwardUp(), PersistTimeout(), SendDataPacket(), SendEmptyPacket(), SetTcp(), and ~TcpSocketBase().

EventId ns3::TcpSocketBase::m_timewaitEvent

protected

TIME_WAIT expiration event: Move this socket to CLOSED state.

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

Referenced by CancelAllTimers(), and TimeWait().

TcpTxBuffer ns3::TcpSocketBase::m_txBuffer

protected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::TcpSocket

TraceSources

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation