A Discrete-Event Network Simulator
API
ns3::TcpSocket Class Referenceabstract

(abstract) base class of all TcpSockets More...

#include "tcp-socket.h"

+ Inheritance diagram for ns3::TcpSocket:
+ Collaboration diagram for ns3::TcpSocket:

Public Types

enum  TcpStates_t {
  CLOSED = 0 , LISTEN , SYN_SENT , SYN_RCVD ,
  ESTABLISHED , CLOSE_WAIT , LAST_ACK , FIN_WAIT_1 ,
  FIN_WAIT_2 , CLOSING , TIME_WAIT , LAST_STATE
}
 Names of the 11 TCP states. More...
 
- Public Types inherited from ns3::Socket
enum  Ipv6MulticastFilterMode { INCLUDE =1 , EXCLUDE }
 Enumeration of the possible filter of a socket. More...
 
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  SocketPriority {
  NS3_PRIO_BESTEFFORT = 0 , NS3_PRIO_FILLER = 1 , NS3_PRIO_BULK = 2 , NS3_PRIO_INTERACTIVE_BULK = 4 ,
  NS3_PRIO_INTERACTIVE = 6 , NS3_PRIO_CONTROL = 7
}
 Enumeration of the possible socket priorities. More...
 
enum  SocketType { NS3_SOCK_STREAM , NS3_SOCK_SEQPACKET , NS3_SOCK_DGRAM , NS3_SOCK_RAW }
 Enumeration of the possible socket types. More...
 

Public Member Functions

 TcpSocket (void)
 
virtual ~TcpSocket (void)
 
- Public Member Functions inherited from ns3::Socket
 Socket (void)
 
virtual ~Socket (void)
 
virtual int Bind ()=0
 Allocate a local IPv4 endpoint for this socket. More...
 
virtual int Bind (const Address &address)=0
 Allocate a local endpoint for this socket. More...
 
virtual int Bind6 ()=0
 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)=0
 Close a socket. More...
 
virtual int Connect (const Address &address)=0
 Initiate a connection to a remote host. More...
 
virtual bool GetAllowBroadcast () const =0
 Query whether broadcast datagram transmissions are allowed. More...
 
Ptr< NetDeviceGetBoundNetDevice ()
 Returns socket's bound NetDevice, if any. More...
 
virtual enum Socket::SocketErrno GetErrno (void) const =0
 Get last error number. 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...
 
virtual Ptr< NodeGetNode (void) const =0
 Return the node this socket is associated with. More...
 
virtual int GetPeerName (Address &address) const =0
 Get the peer address of a connected socket. More...
 
uint8_t GetPriority (void) const
 Query the priority value of this socket. More...
 
virtual uint32_t GetRxAvailable (void) const =0
 Return number of bytes which can be returned from one or multiple calls to Recv. More...
 
virtual enum Socket::SocketType GetSocketType (void) const =0
 
virtual int GetSockName (Address &address) const =0
 Get socket address. More...
 
virtual uint32_t GetTxAvailable (void) const =0
 Returns the number of bytes which can be sent in a single call to Send. More...
 
virtual void Ipv6JoinGroup (Ipv6Address address)
 Joins a IPv6 multicast group without filters. More...
 
virtual void Ipv6JoinGroup (Ipv6Address address, Ipv6MulticastFilterMode filterMode, std::vector< Ipv6Address > sourceAddresses)
 Joins a IPv6 multicast group. More...
 
virtual void Ipv6LeaveGroup (void)
 Leaves IPv6 multicast group this socket is joined to. 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...
 
virtual int Listen (void)=0
 Listen for incoming connections. More...
 
virtual Ptr< PacketRecv (uint32_t maxSize, uint32_t flags)=0
 Read data 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< PacketRecv (void)
 Read a single packet from the socket. More...
 
Ptr< PacketRecvFrom (Address &fromAddress)
 Read a single packet from the socket and retrieve the sender address. More...
 
virtual Ptr< PacketRecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
 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 (const uint8_t *buf, uint32_t size, uint32_t flags)
 Send data (or dummy data) to the remote host. More...
 
int Send (Ptr< Packet > p)
 Send data (or dummy data) to the remote host. More...
 
virtual int Send (Ptr< Packet > p, uint32_t flags)=0
 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...
 
virtual int SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
 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...
 
virtual bool SetAllowBroadcast (bool allowBroadcast)=0
 Configure whether broadcast datagram transmissions are allowed. 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 SetPriority (uint8_t priority)
 Manually set the socket priority. More...
 
void SetRecvCallback (Callback< void, Ptr< Socket > > receivedData)
 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...
 
virtual int ShutdownRecv (void)=0
 
virtual int ShutdownSend (void)=0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Socket
static Ptr< SocketCreateSocket (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 uint8_t IpTos2Priority (uint8_t ipTos)
 Return the priority corresponding to a given TOS value. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Static Public Attributes

static const char *const TcpStateName [TcpSocket::LAST_STATE]
 Literal names of TCP states for use in log messages. More...
 

Private Member Functions

virtual Time GetConnTimeout (void) const =0
 Get the connection timeout. More...
 
virtual uint32_t GetDataRetries (void) const =0
 Get the number of data transmission retries before giving up. More...
 
virtual uint32_t GetDelAckMaxCount (void) const =0
 Get the number of packet to fire an ACK before delay timeout. More...
 
virtual Time GetDelAckTimeout (void) const =0
 Get the time to delay an ACK. More...
 
virtual uint32_t GetInitialCwnd (void) const =0
 Get the initial Congestion Window. More...
 
virtual uint32_t GetInitialSSThresh (void) const =0
 Get the initial Slow Start Threshold. More...
 
virtual Time GetPersistTimeout (void) const =0
 Get the timeout for persistent connection. More...
 
virtual uint32_t GetRcvBufSize (void) const =0
 Get the receive buffer size. More...
 
virtual uint32_t GetSegSize (void) const =0
 Get the segment size. More...
 
virtual uint32_t GetSndBufSize (void) const =0
 Get the send buffer size. More...
 
virtual uint32_t GetSynRetries (void) const =0
 Get the number of connection retries before giving up. More...
 
virtual bool GetTcpNoDelay (void) const =0
 Check if Nagle's algorithm is enabled or not. More...
 
virtual void SetConnTimeout (Time timeout)=0
 Set the connection timeout. More...
 
virtual void SetDataRetries (uint32_t retries)=0
 Set the number of data transmission retries before giving up. More...
 
virtual void SetDelAckMaxCount (uint32_t count)=0
 Set the number of packet to fire an ACK before delay timeout. More...
 
virtual void SetDelAckTimeout (Time timeout)=0
 Set the time to delay an ACK. More...
 
virtual void SetInitialCwnd (uint32_t cwnd)=0
 Set the initial Congestion Window. More...
 
virtual void SetInitialSSThresh (uint32_t threshold)=0
 Set the initial Slow Start Threshold. More...
 
virtual void SetPersistTimeout (Time timeout)=0
 Set the timeout for persistent connection. More...
 
virtual void SetRcvBufSize (uint32_t size)=0
 Set the receive buffer size. More...
 
virtual void SetSegSize (uint32_t size)=0
 Set the segment size. More...
 
virtual void SetSndBufSize (uint32_t size)=0
 Set the send buffer size. More...
 
virtual void SetSynRetries (uint32_t count)=0
 Set the number of connection retries before giving up. More...
 
virtual void SetTcpNoDelay (bool noDelay)=0
 Enable/Disable Nagle's algorithm. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Socket
virtual void DoDispose (void)
 Destructor implementation. 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)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Protected Attributes inherited from ns3::Socket
Ptr< NetDevicem_boundnetdevice
 the device this socket is bound to (might be null). More...
 
Ipv6Address m_ipv6MulticastGroupAddress
 IPv6 multicast group address. More...
 
bool m_recvPktInfo
 if the socket should add packet info tags to the packet forwarded to L4. More...
 

Detailed Description

(abstract) base class of all TcpSockets

Introspection did not find any typical Config paths.

This class exists solely for hosting TcpSocket attributes that can be reused across different implementations.


Attributes

  • SndBufSize: TcpSocket maximum transmit buffer size (bytes)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 131072
    • Flags: constructwriteread
  • RcvBufSize: TcpSocket maximum receive buffer size (bytes)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 131072
    • Flags: constructwriteread
  • 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: constructwriteread
  • InitialSlowStartThreshold: TCP initial slow start threshold (bytes)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 4294967295
    • Flags: constructwriteread
  • InitialCwnd: TCP initial congestion window size (segments)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 10
    • Flags: constructwriteread
  • ConnTimeout: TCP retransmission timeout when opening connection (seconds)
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +3e+09ns
    • Flags: constructwriteread
  • 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: constructwriteread
  • DataRetries: Number of data retransmission attempts
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 6
    • Flags: constructwriteread
  • DelAckTimeout: Timeout value for TCP delayed acks, in seconds
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +2e+08ns
    • Flags: constructwriteread
  • 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: constructwriteread
  • TcpNoDelay: Set to true to disable Nagle's algorithm
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
  • PersistTimeout: Persist timeout to probe for rx window
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +6e+09ns
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 152 bytes (on a 64-bit architecture).

Definition at line 47 of file tcp-socket.h.

Constructor & Destructor Documentation

◆ TcpSocket()

ns3::TcpSocket::TcpSocket ( void  )

Definition at line 126 of file tcp-socket.cc.

References NS_LOG_FUNCTION.

◆ ~TcpSocket()

ns3::TcpSocket::~TcpSocket ( void  )
virtual

Definition at line 131 of file tcp-socket.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetConnTimeout()

virtual Time ns3::TcpSocket::GetConnTimeout ( void  ) const
privatepure virtual

Get the connection timeout.

Returns
the connection timeout

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetDataRetries()

virtual uint32_t ns3::TcpSocket::GetDataRetries ( void  ) const
privatepure virtual

Get the number of data transmission retries before giving up.

Returns
the number of data transmission retries

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetDelAckMaxCount()

virtual uint32_t ns3::TcpSocket::GetDelAckMaxCount ( void  ) const
privatepure virtual

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

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

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetDelAckTimeout()

virtual Time ns3::TcpSocket::GetDelAckTimeout ( void  ) const
privatepure virtual

Get the time to delay an ACK.

Returns
the time to delay an ACK

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetInitialCwnd()

virtual uint32_t ns3::TcpSocket::GetInitialCwnd ( void  ) const
privatepure virtual

Get the initial Congestion Window.

Returns
the initial congestion window (in segments)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetInitialSSThresh()

virtual uint32_t ns3::TcpSocket::GetInitialSSThresh ( void  ) const
privatepure virtual

Get the initial Slow Start Threshold.

Returns
the Slow Start Threshold (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetPersistTimeout()

virtual Time ns3::TcpSocket::GetPersistTimeout ( void  ) const
privatepure virtual

Get the timeout for persistent connection.

When the timeout 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 timeout

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetRcvBufSize()

virtual uint32_t ns3::TcpSocket::GetRcvBufSize ( void  ) const
privatepure virtual

Get the receive buffer size.

Returns
the buffer size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSegSize()

virtual uint32_t ns3::TcpSocket::GetSegSize ( void  ) const
privatepure virtual

Get the segment size.

Returns
the segment size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSndBufSize()

virtual uint32_t ns3::TcpSocket::GetSndBufSize ( void  ) const
privatepure virtual

Get the send buffer size.

Returns
the buffer size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSynRetries()

virtual uint32_t ns3::TcpSocket::GetSynRetries ( void  ) const
privatepure virtual

Get the number of connection retries before giving up.

Returns
the number of connection retries

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTcpNoDelay()

virtual bool ns3::TcpSocket::GetTcpNoDelay ( void  ) const
privatepure virtual

Check if Nagle's algorithm is enabled or not.

Returns
true if Nagle's algorithm is DISABLED

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ SetConnTimeout()

virtual void ns3::TcpSocket::SetConnTimeout ( Time  timeout)
privatepure virtual

Set the connection timeout.

Parameters
timeoutthe connection timeout

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetDataRetries()

virtual void ns3::TcpSocket::SetDataRetries ( uint32_t  retries)
privatepure virtual

Set the number of data transmission retries before giving up.

Parameters
retriesthe number of data transmission retries

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetDelAckMaxCount()

virtual void ns3::TcpSocket::SetDelAckMaxCount ( uint32_t  count)
privatepure virtual

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

Parameters
countthe umber of packet to fire an ACK before delay timeout

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetDelAckTimeout()

virtual void ns3::TcpSocket::SetDelAckTimeout ( Time  timeout)
privatepure virtual

Set the time to delay an ACK.

Parameters
timeoutthe time to delay an ACK

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetInitialCwnd()

virtual void ns3::TcpSocket::SetInitialCwnd ( uint32_t  cwnd)
privatepure virtual

Set the initial Congestion Window.

Parameters
cwndthe initial congestion window (in segments)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetInitialSSThresh()

virtual void ns3::TcpSocket::SetInitialSSThresh ( uint32_t  threshold)
privatepure virtual

Set the initial Slow Start Threshold.

Parameters
thresholdthe Slow Start Threshold (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetPersistTimeout()

virtual void ns3::TcpSocket::SetPersistTimeout ( Time  timeout)
privatepure virtual

Set the timeout for persistent connection.

When the timeout 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
timeoutthe persistent timeout

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetRcvBufSize()

virtual void ns3::TcpSocket::SetRcvBufSize ( uint32_t  size)
privatepure virtual

Set the receive buffer size.

Parameters
sizethe buffer size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSegSize()

virtual void ns3::TcpSocket::SetSegSize ( uint32_t  size)
privatepure virtual

Set the segment size.

Parameters
sizethe segment size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSndBufSize()

virtual void ns3::TcpSocket::SetSndBufSize ( uint32_t  size)
privatepure virtual

Set the send buffer size.

Parameters
sizethe buffer size (in bytes)

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSynRetries()

virtual void ns3::TcpSocket::SetSynRetries ( uint32_t  count)
privatepure virtual

Set the number of connection retries before giving up.

Parameters
countthe number of connection retries

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTcpNoDelay()

virtual void ns3::TcpSocket::SetTcpNoDelay ( bool  noDelay)
privatepure virtual

Enable/Disable Nagle's algorithm.

Parameters
noDelaytrue to DISABLE Nagle's algorithm

Implemented in ns3::TcpSocketBase.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ TcpStateName

const char *const ns3::TcpSocket::TcpStateName
static
Initial value:
= { "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.

Definition at line 94 of file tcp-socket.h.

Referenced by ns3::TcpSocketBase::Close(), ns3::TcpSocketBase::CloseAndNotify(), ns3::TcpSocketBase::DoConnect(), ns3::TcpSocketBase::DoForwardUp(), ns3::TcpSocketBase::DoPeerClose(), ns3::TcpSocketBase::IsValidTcpSegment(), ns3::TcpSocketBase::Send(), and ns3::TcpSocketBase::TimeWait().


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