A base class for implementation of a stream socket using TCP. More...
#include "tcp-socket-base.h"
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... | |
Time | GetClockGranularity (void) const |
Get the Clock Granularity (used in RTO calcs). More... | |
virtual enum SocketErrno | GetErrno (void) const |
Get last error number. More... | |
virtual TypeId | GetInstanceTypeId () const |
Get the instance TypeId. More... | |
Time | GetMinRto (void) const |
Get the Minimum RTO. More... | |
virtual Ptr< Node > | GetNode (void) const |
Return the node this socket is associated with. More... | |
virtual int | GetPeerName (Address &address) const |
Get the peer address of a connected socket. More... | |
virtual uint32_t | GetRxAvailable (void) const |
Return number of bytes which can be returned from one or multiple calls to Recv. More... | |
Ptr< TcpRxBuffer > | GetRxBuffer (void) const |
Get a pointer to the Rx buffer. 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... | |
Ptr< TcpTxBuffer > | GetTxBuffer (void) const |
Get a pointer to the Tx buffer. 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... | |
void | SetClockGranularity (Time clockGranularity) |
Sets the Clock Granularity (used in RTO calcs). More... | |
void | SetCongestionControlAlgorithm (Ptr< TcpCongestionOps > algo) |
Install a congestion control algorithm on this socket. More... | |
void | SetMinRto (Time minRto) |
Sets the Minimum RTO. 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) |
void | UpdateCongState (TcpSocketState::TcpCongState_t oldValue, TcpSocketState::TcpCongState_t newValue) |
Callback function to hook to TcpSocketState congestion state. More... | |
void | UpdateCwnd (uint32_t oldValue, uint32_t newValue) |
Callback function to hook to TcpSocketState congestion window. More... | |
void | UpdateSsThresh (uint32_t oldValue, uint32_t newValue) |
Callback function to hook to TcpSocketState slow start threshold. More... | |
![]() | |
TcpSocket (void) | |
virtual | ~TcpSocket (void) |
![]() | |
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... | |
virtual void | Ipv6JoinGroup (Ipv6Address address, Ipv6MulticastFilterMode filterMode, std::vector< Ipv6Address > sourceAddresses) |
Joins a IPv6 multicast group. More... | |
virtual void | Ipv6JoinGroup (Ipv6Address address) |
Joins a IPv6 multicast group without filters. 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... | |
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... | |
![]() | |
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... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
![]() | |
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... | |
![]() | |
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... | |
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 TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
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 TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Public Attributes | |
TracedCallback< TcpSocketState::TcpCongState_t, TcpSocketState::TcpCongState_t > | m_congStateTrace |
Callback pointer for congestion state trace chaining. More... | |
TracedCallback< uint32_t, uint32_t > | m_cWndTrace |
Callback pointer for cWnd trace chaining. More... | |
TracedCallback< uint32_t, uint32_t > | m_ssThTrace |
Callback pointer for ssTh trace chaining. More... | |
Protected Member Functions | |
virtual void | AddOptions (TcpHeader &tcpHeader) |
Add options to TcpHeader. More... | |
void | AddOptionTimestamp (TcpHeader &header) |
Add the timestamp option to the header. More... | |
void | AddOptionWScale (TcpHeader &header) |
Add the window scale option to the header. More... | |
virtual uint16_t | AdvertisedWindowSize (void) const |
The amount of Rx window announced to the peer. More... | |
virtual uint32_t | AvailableWindow (void) const |
Return unfilled portion of window. More... | |
virtual uint32_t | BytesInFlight (void) |
Return total bytes in flight. More... | |
uint8_t | CalculateWScale () const |
Calculate window scale value based on receive buffer space. 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... | |
virtual 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 and m_endPoint6. 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, const Address &fromAddress, const Address &toAddress) |
Called by TcpSocketBase::ForwardUp{,6}(). 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 | EstimateRtt (const TcpHeader &tcpHeader) |
Take into account the packet for RTT estimation. More... | |
virtual Ptr< TcpSocketBase > | Fork (void) |
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 Time | GetConnTimeout (void) const |
Get the connection timeout. More... | |
virtual uint32_t | GetDataRetries (void) const |
Get the number of data transmission retries before giving up. 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 |
Get the initial Congestion Window. More... | |
virtual uint32_t | GetInitialSSThresh (void) const |
Get the initial Slow Start Threshold. 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 | GetSynRetries (void) const |
Get the number of connection retries before giving up. 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, bool resetRTO) |
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 | ProcessOptionTimestamp (const Ptr< const TcpOption > option, const SequenceNumber32 &seq) |
Process the timestamp option from other side. More... | |
void | ProcessOptionWScale (const Ptr< const TcpOption > option) |
Read and parse the Window scale option. 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 | 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... | |
virtual 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 | SetConnTimeout (Time timeout) |
Set the connection timeout. More... | |
virtual void | SetDataRetries (uint32_t retries) |
Set the number of data transmission retries before giving up. 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) |
Set the initial Congestion Window. More... | |
virtual void | SetInitialSSThresh (uint32_t threshold) |
Set the initial Slow Start Threshold. 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 | SetSynRetries (uint32_t count) |
Set the number of connection retries before giving up. 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) const |
Return count of number of unacked bytes. More... | |
virtual void | UpdateRttHistory (const SequenceNumber32 &seq, uint32_t sz, bool isRetransmission) |
Update the RTT history, when we send TCP segments. More... | |
void | UpdateWindowSize (const TcpHeader &header) |
Update the receiver window (RWND) based on the value of the window field in the header. More... | |
virtual uint32_t | Window (void) const |
Return the max possible number of unacked bytes. More... | |
![]() | |
virtual void | DoDispose (void) |
Destructor implementation. 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... | |
![]() | |
Object (const Object &o) | |
Copy an Object. 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... | |
![]() | |
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... | |
Static Protected Member Functions | |
static uint32_t | SafeSubtraction (uint32_t a, uint32_t b) |
Performs a safe subtraction between a and b (a-b) More... | |
Protected Attributes | |
uint32_t | m_bytesAckedNotProcessed |
Bytes acked, but not processed. More... | |
TracedValue< uint32_t > | m_bytesInFlight |
Bytes in flight. More... | |
Time | m_clockGranularity |
Clock Granularity used in RTO calcs. More... | |
bool | m_closeNotified |
Told app to close socket. More... | |
bool | m_closeOnEmpty |
Close socket upon tx buffer emptied. More... | |
Time | m_cnTimeout |
Timeout for connection retry. More... | |
Ptr< TcpCongestionOps > | m_congestionControl |
Congestion control. More... | |
bool | m_connected |
Connection established. More... | |
uint32_t | m_dataRetrCount |
Count of remaining data retransmission attempts. More... | |
uint32_t | m_dataRetries |
Number of data retransmission attempts. 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_highRxAckMark |
Highest ack received. More... | |
TracedValue< SequenceNumber32 > | m_highRxMark |
Highest seqno received. More... | |
SequenceNumber32 | m_highTxAck |
Highest ack sent. More... | |
TracedValue< SequenceNumber32 > | m_highTxMark |
Highest seqno ever sent, regardless of ReTx. More... | |
RttHistory_t | m_history |
List of sent packet. 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... | |
bool | m_isFirstPartialAck |
First partial ACK during RECOVERY. More... | |
EventId | m_lastAckEvent |
Last ACK timeout event. More... | |
TracedValue< Time > | m_lastRtt |
Last RTT sample collected. More... | |
bool | m_limitedTx |
perform limited transmit More... | |
uint16_t | m_maxWinSize |
Maximum window size to advertise. More... | |
Time | m_minRto |
minimum value of the Retransmit timeout 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... | |
uint8_t | m_rcvWindShift |
Window shift to apply to outgoing segments. More... | |
SequenceNumber32 | m_recover |
Previous highest Tx seqnum for fast recovery. More... | |
uint32_t | m_retransOut |
Number of retransmission in this window. More... | |
EventId | m_retxEvent |
Retransmission event. More... | |
uint32_t | m_retxThresh |
Fast Retransmit threshold. More... | |
TracedValue< Time > | m_rto |
Retransmit timeout. More... | |
Ptr< RttEstimator > | m_rtt |
Round trip time estimator. More... | |
TracedValue< uint32_t > | m_rWnd |
Receiver window (RCV.WND in RFC793) More... | |
Ptr< TcpRxBuffer > | m_rxBuffer |
Rx buffer (reordering buffer) More... | |
TracedCallback< Ptr< const Packet >, const TcpHeader &, Ptr< const TcpSocketBase > > | m_rxTrace |
Trace of received packets. More... | |
EventId | m_sendPendingDataEvent |
micro-delay event to send pending data More... | |
bool | m_shutdownRecv |
Receive no longer allowed. More... | |
bool | m_shutdownSend |
Send no longer allowed. More... | |
uint8_t | m_sndWindShift |
Window shift to apply to incoming segments. More... | |
TracedValue< TcpStates_t > | m_state |
TCP state. More... | |
uint32_t | m_synCount |
Count of remaining connection retries. More... | |
uint32_t | m_synRetries |
Number of connection attempts. More... | |
Ptr< TcpSocketState > | m_tcb |
Congestion control informations. More... | |
Ptr< TcpL4Protocol > | m_tcp |
the associated TCP L4 protocol More... | |
bool | m_timestampEnabled |
Timestamp option enabled. More... | |
uint32_t | m_timestampToEcho |
Timestamp to echo. More... | |
EventId | m_timewaitEvent |
TIME_WAIT expiration event: Move this socket to CLOSED state. More... | |
Ptr< TcpTxBuffer > | m_txBuffer |
Tx buffer. More... | |
TracedCallback< Ptr< const Packet >, const TcpHeader &, Ptr< const TcpSocketBase > > | m_txTrace |
Trace of transmitted packets. More... | |
bool | m_winScalingEnabled |
Window Scale option enabled (RFC 7323) More... | |
![]() | |
Ptr< NetDevice > | m_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... | |
Friends | |
class | TcpGeneralTest |
Additional Inherited Members | |
![]() | |
static const char *const | TcpStateName [TcpSocket::LAST_STATE] |
Literal names of TCP states for use in log messages. More... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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 of Georgia Tech. @gat ech.e du
The socket maintains two state machines; the TCP one, and another called "Congestion state machine", which keeps track of the phase we are in. Currently, ns-3 manages the states:
Another one (CA_CWR) is present but not used. For more information, see the TcpCongState_t documentation.
Congestion control, unlike older releases of ns-3, has been splitted from TcpSocketBase. In particular, each congestion control is now a subclass of the main TcpCongestionOps class. Switching between congestion algorithm is now a matter of setting a pointer into the TcpSocketBase class.
The variables needed to congestion control classes to operate correctly have been moved inside the TcpSocketState class. It contains information on the congestion window, slow start threshold, segment size and the state of the Congestion state machine.
To track the trace inside the TcpSocketState class, a "forward" technique is used, which consists in chaining callbacks from TcpSocketState to TcpSocketBase (see for example cWnd trace source).
The fast retransmit enhancement is introduced in RFC 2581 and updated in RFC 5681. It basically reduces the time a sender waits before retransmitting a lost segment, through the assumption that if it receives a certain number of duplicate ACKs, a segment has been lost and it can be retransmitted. Usually it is coupled with the Limited Transmit algorithm, defined in RFC 3042.
In ns-3, these algorithms are included in this class, and it is implemented inside the ReceivedAck method. The attribute which manages the number of dup ACKs necessary to start the fast retransmit algorithm is named "ReTxThreshold", and its default value is 3, while the Limited Transmit one can be enabled by setting the attribute "LimitedTransmit" to true.
The fast recovery algorithm is introduced RFC 2001, and it basically avoids to reset cWnd to 1 segment after sensing a loss on the channel. Instead, the slow start threshold is halved, and the cWnd is set equal to such value, plus segments for the cWnd inflation.
The algorithm is implemented in the ReceivedAck method.
ns3::TcpSocketBase is accessible through the following paths with Config::Set and Config::Connect:
Size of this type is 912 bytes (on a 64-bit architecture).
Definition at line 242 of file tcp-socket-base.h.
typedef void(* ns3::TcpSocketBase::TcpTxRxTracedCallback) (const Ptr< const Packet > packet, const TcpHeader &header, const Ptr< const TcpSocketBase > socket) |
TracedCallback signature for tcp packet transmission or reception events.
[in] | packet | The packet. |
[in] | ipv4 | |
[in] | interface |
Definition at line 402 of file tcp-socket-base.h.
ns3::TcpSocketBase::TcpSocketBase | ( | void | ) |
Create an unbound TCP socket.
Definition at line 249 of file tcp-socket-base.cc.
References m_rxBuffer, m_tcb, m_txBuffer, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, UpdateCongState(), UpdateCwnd(), and UpdateSsThresh().
ns3::TcpSocketBase::TcpSocketBase | ( | const TcpSocketBase & | sock | ) |
Clone a TCP socket, for use upon receiving a connection request in LISTEN state.
sock | the original Tcp Socket |
Definition at line 326 of file tcp-socket-base.cc.
References ns3::Object::CopyObject, m_congestionControl, m_rtt, m_rxBuffer, m_tcb, m_txBuffer, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Socket::SetConnectCallback(), ns3::Socket::SetDataSentCallback(), ns3::Socket::SetRecvCallback(), ns3::Socket::SetSendCallback(), UpdateCongState(), UpdateCwnd(), and UpdateSsThresh().
|
virtual |
Definition at line 415 of file tcp-socket-base.cc.
References CancelAllTimers(), m_endPoint, m_endPoint6, m_node, m_tcp, NS_ASSERT, and NS_LOG_FUNCTION.
|
protectedvirtual |
Add options to TcpHeader.
Test each option, and if it is enabled on our side, add it to the header
tcpHeader | TcpHeader to add options to |
Definition at line 3217 of file tcp-socket-base.cc.
References AddOptionTimestamp(), AddOptionWScale(), ns3::TcpHeader::GetFlags(), m_timestampEnabled, m_winScalingEnabled, NS_LOG_FUNCTION, and ns3::TcpHeader::SYN.
Referenced by DoForwardUp(), PersistTimeout(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Add the timestamp option to the header.
Set the timestamp as the lower bits of the Simulator::Now time, and the echo value as the last seen timestamp from the other part.
header | TcpHeader to which add the option to |
Definition at line 3316 of file tcp-socket-base.cc.
References ns3::TcpHeader::AppendOption(), ns3::Node::GetId(), m_node, m_timestampToEcho, ns3::TcpOptionTS::NowToTsValue(), NS_LOG_FUNCTION, and NS_LOG_INFO.
Referenced by AddOptions().
|
protected |
Add the window scale option to the header.
Calculate our factor from the rxBuffer max size, and add it to the header.
header | TcpHeader where the method should add the window scale option |
Definition at line 3279 of file tcp-socket-base.cc.
References ns3::TcpHeader::AppendOption(), CalculateWScale(), ns3::TcpHeader::GetFlags(), ns3::Node::GetId(), m_node, m_rcvWindShift, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::TcpHeader::SYN.
Referenced by AddOptions().
|
protectedvirtual |
The amount of Rx window announced to the peer.
Definition at line 2666 of file tcp-socket-base.cc.
References m_maxWinSize, m_rcvWindShift, m_rxBuffer, NS_LOG_WARN, and visualizer.higcontainer::w.
Referenced by DoForwardUp(), PersistTimeout(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protectedvirtual |
Return unfilled portion of window.
Definition at line 2655 of file tcp-socket-base.cc.
References NS_LOG_DEBUG, NS_LOG_FUNCTION_NOARGS, UnAckDataCount(), and Window().
Referenced by SendPendingData().
|
virtual |
Allocate a local IPv4 endpoint for this socket.
Implements ns3::Socket.
Definition at line 489 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().
|
virtual |
Allocate a local endpoint for this socket.
address | the address to try to allocate |
Implements ns3::Socket.
Definition at line 522 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().
|
virtual |
Allocate a local IPv6 endpoint for this socket.
Implements ns3::Socket.
Definition at line 505 of file tcp-socket-base.cc.
References ns3::Socket::ERROR_ADDRNOTAVAIL, m_endPoint6, m_errno, m_tcp, NS_LOG_FUNCTION, and SetupCallback().
Referenced by BindToNetDevice(), and Connect().
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.
netdevice | Pointer to Netdevice of desired interface |
Reimplemented from ns3::Socket.
Definition at line 954 of file tcp-socket-base.cc.
References Bind(), Bind6(), ns3::Ipv4EndPoint::BindToNetDevice(), ns3::Ipv6EndPoint::BindToNetDevice(), ns3::Socket::BindToNetDevice(), m_endPoint, m_endPoint6, NS_ASSERT, and NS_LOG_FUNCTION.
|
protectedvirtual |
Return total bytes in flight.
Definition at line 2613 of file tcp-socket-base.cc.
References ns3::TracedValue< T >::Get(), m_bytesInFlight, m_dupAckCount, m_nextTxSequence, m_retransOut, m_tcb, m_txBuffer, and NS_LOG_FUNCTION.
Referenced by ReceivedAck(), and Retransmit().
|
protected |
Calculate window scale value based on receive buffer space.
Calculate our factor from the rxBuffer max size
Definition at line 3255 of file tcp-socket-base.cc.
References ns3::Node::GetId(), m_maxWinSize, m_node, m_rxBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_WARN.
Referenced by AddOptionWScale().
|
protected |
Cancel all timer when endpoint is deleted.
Definition at line 3035 of file tcp-socket-base.cc.
References ns3::EventId::Cancel(), m_delAckEvent, m_lastAckEvent, m_persistEvent, m_retxEvent, m_sendPendingDataEvent, and m_timewaitEvent.
Referenced by DeallocateEndPoint(), Destroy(), Destroy6(), TimeWait(), and ~TcpSocketBase().
|
virtual |
Close a socket.
After the Close call, the socket is no longer valid, and cannot safely be used for subsequent operations.
Implements ns3::Socket.
Definition at line 716 of file tcp-socket-base.cc.
References DoClose(), m_closeOnEmpty, m_nextTxSequence, m_rxBuffer, m_state, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, SendRST(), and ns3::TcpSocket::TcpStateName.
Referenced by DoPeerClose().
|
protected |
Peacefully close the socket by notifying the upper layer and deallocate end point.
Definition at line 1076 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, DeallocateEndPoint(), m_closeNotified, m_state, ns3::Socket::NotifyNormalClose(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::TcpSocket::TcpStateName.
Referenced by DoClose(), DoConnect(), LastAckTimeout(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), and TimeWait().
|
protectedvirtual |
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.
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 |
Reimplemented in ns3::TcpSocketMsgBase.
Definition at line 2336 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_dataRetrCount, m_dataRetries, m_endPoint, m_endPoint6, m_rxBuffer, m_state, m_synCount, m_synRetries, m_tcp, NS_LOG_DEBUG, SendEmptyPacket(), SetupCallback(), ns3::TcpHeader::SYN, and ns3::TcpSocket::SYN_RCVD.
Referenced by ns3::TcpSocketMsgBase::CompleteFork(), and ProcessListen().
|
virtual |
Initiate a connection to a remote host.
address | Address of remote. |
Implements ns3::Socket.
Definition at line 624 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_dataRetrCount, m_dataRetries, m_endPoint, m_endPoint6, m_errno, m_rtt, m_synCount, m_synRetries, NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Ipv4EndPoint::SetPeer(), ns3::Ipv6EndPoint::SetPeer(), SetupEndpoint(), and SetupEndpoint6().
|
protected |
Schedule-friendly wrapper for Socket::NotifyConnectionSucceeded()
Definition at line 2371 of file tcp-socket-base.cc.
References GetTxAvailable(), ns3::Socket::NotifyConnectionSucceeded(), and ns3::Socket::NotifySend().
Referenced by ProcessSynSent().
|
protected |
Deallocate m_endPoint and m_endPoint6.
Definition at line 2251 of file tcp-socket-base.cc.
References CancelAllTimers(), m_endPoint, m_endPoint6, m_tcp, ns3::Ipv4EndPoint::SetDestroyCallback(), and ns3::Ipv6EndPoint::SetDestroyCallback().
Referenced by CloseAndNotify(), DoRetransmit(), and SendRST().
|
protectedvirtual |
Action upon delay ACK timeout, i.e.
send an ACK
Definition at line 2858 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, m_delAckCount, and SendEmptyPacket().
Referenced by ReceivedData().
|
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 2074 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().
|
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 2090 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().
|
protected |
Close a socket by sending RST, FIN, or FIN+ACK, depend on the current state.
Definition at line 1034 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, ns3::TcpSocket::CLOSE_WAIT, CloseAndNotify(), ns3::TcpSocket::CLOSED, ns3::TcpSocket::CLOSING, ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::FIN, ns3::TcpSocket::FIN_WAIT_1, ns3::TcpSocket::FIN_WAIT_2, ns3::TcpSocket::LAST_ACK, ns3::TcpSocket::LISTEN, m_state, NS_LOG_DEBUG, NS_LOG_FUNCTION, SendEmptyPacket(), SendRST(), ns3::TcpSocket::SYN_RCVD, ns3::TcpSocket::SYN_SENT, and ns3::TcpSocket::TIME_WAIT.
Referenced by Close().
|
protected |
Perform the real connection tasks: Send SYN if allowed, RST if invalid.
Definition at line 1011 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSE_WAIT, CloseAndNotify(), ns3::TcpSocket::CLOSED, ns3::TcpSocket::LAST_ACK, ns3::TcpSocket::LISTEN, m_state, NS_LOG_DEBUG, NS_LOG_FUNCTION, SendEmptyPacket(), SendRST(), ns3::TcpHeader::SYN, ns3::TcpSocket::SYN_SENT, ns3::TcpSocket::TcpStateName, and ns3::TcpSocket::TIME_WAIT.
Referenced by Connect().
|
protectedvirtual |
Called by TcpSocketBase::ForwardUp{,6}().
Get a packet from L3. This is the real function to handle the incoming packet from lower layers. This is wrapped by ForwardUp() so that this function can be overloaded by daughter classes.
packet | the incoming packet |
fromAddress | the address of the sender of packet |
toAddress | the address of the receiver of packet (hopefully, us) |
Definition at line 1175 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, AddOptions(), AdvertisedWindowSize(), ns3::EventId::Cancel(), ns3::TcpSocket::CLOSE_WAIT, ns3::TcpSocket::CLOSED, ns3::TcpSocket::CLOSING, ns3::TcpSocket::ESTABLISHED, EstimateRtt(), ns3::TcpSocket::FIN_WAIT_1, ns3::TcpSocket::FIN_WAIT_2, ns3::TracedValue< T >::Get(), ns3::TcpHeader::GetAckNumber(), ns3::Simulator::GetDelayLeft(), ns3::TcpHeader::GetDestinationPort(), ns3::TcpHeader::GetFlags(), GetInitialCwnd(), GetInitialSSThresh(), ns3::TcpHeader::GetOption(), GetSegSize(), ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), ns3::TcpHeader::GetSourcePort(), ns3::TcpHeader::GetWindowSize(), ns3::TcpHeader::HasOption(), ns3::EventId::IsExpired(), ns3::EventId::IsRunning(), ns3::TcpSocket::LAST_ACK, ns3::TcpSocket::LISTEN, ns3::Socket::m_boundnetdevice, m_connected, m_highRxAckMark, m_nextTxSequence, m_persistEvent, m_persistTimeout, m_retxEvent, m_rWnd, m_rxBuffer, m_rxTrace, m_sendPendingDataEvent, m_state, m_tcb, m_tcp, m_timestampEnabled, m_txTrace, m_winScalingEnabled, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_ERROR, NS_LOG_LOGIC, OutOfRange(), PersistTimeout(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessListen(), ProcessOptionTimestamp(), ProcessOptionWScale(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ns3::TcpHeader::PSH, ns3::Packet::RemoveHeader(), ns3::TcpHeader::RST, ns3::Simulator::Schedule(), SendEmptyPacket(), SendPendingData(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetFlags(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), ns3::TcpHeader::SetWindowSize(), ns3::TcpHeader::SYN, ns3::TcpSocket::SYN_RCVD, ns3::TcpSocket::SYN_SENT, ns3::TcpSocket::TcpStateName, ns3::TcpSocket::TIME_WAIT, ns3::TimeStep(), ns3::TcpOption::TS, UpdateWindowSize(), ns3::TcpHeader::URG, and ns3::TcpOption::WINSCALE.
Referenced by ForwardUp(), and ForwardUp6().
|
protected |
FIN is in sequence, notify app and respond with a FIN.
Definition at line 2035 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, Close(), ns3::TcpSocket::CLOSE_WAIT, ns3::TcpSocket::ESTABLISHED, ns3::TcpSocket::LAST_ACK, LastAckTimeout(), m_clockGranularity, m_closeNotified, m_lastAckEvent, m_rtt, m_shutdownSend, m_state, ns3::Max(), ns3::Socket::NotifyNormalClose(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_LOGIC, ns3::Simulator::Schedule(), SendEmptyPacket(), ns3::TcpSocket::SYN_RCVD, and ns3::TcpSocket::TcpStateName.
Referenced by PeerClose(), and ReceivedData().
|
protectedvirtual |
Retransmit the oldest packet.
Definition at line 2985 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSING, DeallocateEndPoint(), ns3::TcpHeader::FIN, ns3::TcpSocket::FIN_WAIT_1, ns3::TracedValue< T >::Get(), m_dataRetrCount, m_nextTxSequence, m_retransOut, m_state, m_synCount, m_tcb, m_txBuffer, max, ns3::Socket::NotifyConnectionFailed(), ns3::Socket::NotifyErrorClose(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, SendDataPacket(), SendEmptyPacket(), ns3::TcpHeader::SYN, and ns3::TcpSocket::SYN_SENT.
Referenced by ReceivedAck(), and Retransmit().
|
protectedvirtual |
Take into account the packet for RTT estimation.
Estimate the RTT.
tcpHeader | the packet's TCP header |
Called by ForwardUp() to estimate RTT.
tcpHeader | TCP header for the incoming packet |
Definition at line 2746 of file tcp-socket-base.cc.
References ns3::RttHistory::count, ns3::TcpOptionTS::ElapsedTimeFromTsValue(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetOption(), ns3::TcpHeader::HasOption(), ns3::Time::IsZero(), m_clockGranularity, m_history, m_lastRtt, m_minRto, m_rto, m_rtt, m_timestampEnabled, ns3::Max(), ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::RttHistory::retx, ns3::RttHistory::seq, ns3::RttHistory::time, and ns3::TcpOption::TS.
Referenced by DoForwardUp().
|
protectedvirtual |
Call CopyObject<> to clone me.
Reimplemented in ns3::TcpSocketSmallAcks, ns3::TcpSocketMsgBase, and ns3::TcpSocketHalfAck.
Definition at line 3439 of file tcp-socket-base.cc.
Referenced by ProcessListen().
|
protected |
Called by the L3 protocol when it received an ICMP packet to pass on to TCP.
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 1149 of file tcp-socket-base.cc.
References m_icmpCallback, and NS_LOG_FUNCTION.
Referenced by SetupCallback().
|
protected |
Called by the L3 protocol when it received an ICMPv6 packet to pass on to TCP.
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 1162 of file tcp-socket-base.cc.
References m_icmpCallback6, and NS_LOG_FUNCTION.
Referenced by SetupCallback().
|
protected |
Called by the L3 protocol when it received a packet to pass on to TCP.
packet | the incoming packet |
header | the packet's IPv4 header |
port | the remote port |
incomingInterface | the incoming interface |
Definition at line 1115 of file tcp-socket-base.cc.
References DoForwardUp(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv4Header::GetSource(), m_endPoint, NS_LOG_LOGIC, and port.
Referenced by SetupCallback().
|
protected |
Called by the L3 protocol when it received a packet to pass on to TCP.
packet | the incoming packet |
header | the packet's IPv6 header |
port | the remote port |
incomingInterface | the incoming interface |
Definition at line 1132 of file tcp-socket-base.cc.
References DoForwardUp(), ns3::Ipv6Header::GetDestinationAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerPort(), ns3::Ipv6Header::GetSourceAddress(), m_endPoint6, NS_LOG_LOGIC, and port.
Referenced by SetupCallback().
|
protectedvirtual |
Query whether broadcast datagram transmissions are allowed.
This method corresponds to using getsockopt() SO_BROADCAST of real network or BSD sockets.
Implements ns3::Socket.
Definition at line 3211 of file tcp-socket-base.cc.
Time ns3::TcpSocketBase::GetClockGranularity | ( | void | ) | const |
Get the Clock Granularity (used in RTO calcs).
Definition at line 3395 of file tcp-socket-base.cc.
References m_clockGranularity.
Referenced by GetTypeId().
|
protectedvirtual |
Get the connection timeout.
Implements ns3::TcpSocket.
Definition at line 3119 of file tcp-socket-base.cc.
References m_cnTimeout.
|
protectedvirtual |
Get the number of data transmission retries before giving up.
Implements ns3::TcpSocket.
Definition at line 3145 of file tcp-socket-base.cc.
References m_dataRetries, and NS_LOG_FUNCTION.
|
protectedvirtual |
Get the number of packet to fire an ACK before delay timeout.
Implements ns3::TcpSocket.
Definition at line 3172 of file tcp-socket-base.cc.
References m_delAckMaxCount.
|
protectedvirtual |
Get the time to delay an ACK.
Implements ns3::TcpSocket.
Definition at line 3159 of file tcp-socket-base.cc.
References m_delAckTimeout.
|
virtual |
Get last error number.
Implements ns3::Socket.
Definition at line 467 of file tcp-socket-base.cc.
References m_errno.
|
protectedvirtual |
Get the initial Congestion Window.
Implements ns3::TcpSocket.
Definition at line 617 of file tcp-socket-base.cc.
References m_tcb.
Referenced by DoForwardUp().
|
protectedvirtual |
Get the initial Slow Start Threshold.
Implements ns3::TcpSocket.
Definition at line 602 of file tcp-socket-base.cc.
References m_tcb.
Referenced by DoForwardUp().
|
virtual |
Get the instance TypeId.
Reimplemented from ns3::Object.
Definition at line 192 of file tcp-socket-base.cc.
References GetTypeId().
Time ns3::TcpSocketBase::GetMinRto | ( | void | ) | const |
Get the Minimum RTO.
Definition at line 3382 of file tcp-socket-base.cc.
References m_minRto.
Referenced by GetTypeId().
Return the node this socket is associated with.
Implements ns3::Socket.
Definition at line 481 of file tcp-socket-base.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
|
virtual |
Get the peer address of a connected socket.
address | the address this socket is connected to. |
Implements ns3::Socket.
Definition at line 924 of file tcp-socket-base.cc.
References ns3::Socket::ERROR_NOTCONN, ns3::Ipv4EndPoint::GetPeerAddress(), ns3::Ipv6EndPoint::GetPeerAddress(), ns3::Ipv4EndPoint::GetPeerPort(), ns3::Ipv6EndPoint::GetPeerPort(), m_endPoint, m_endPoint6, m_errno, NS_ASSERT, and NS_LOG_FUNCTION.
|
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
Implements ns3::TcpSocket.
Definition at line 3198 of file tcp-socket-base.cc.
References m_persistTimeout.
|
protectedvirtual |
Get the receive buffer size.
Implements ns3::TcpSocket.
Definition at line 3091 of file tcp-socket-base.cc.
References m_rxBuffer.
Referenced by SetRcvBufSize().
|
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.
Implements ns3::Socket.
Definition at line 895 of file tcp-socket-base.cc.
References m_rxBuffer, and NS_LOG_FUNCTION.
Ptr< TcpRxBuffer > ns3::TcpSocketBase::GetRxBuffer | ( | void | ) | const |
Get a pointer to the Rx buffer.
Definition at line 3407 of file tcp-socket-base.cc.
References m_rxBuffer.
Referenced by GetTypeId().
|
protectedvirtual |
Get the segment size.
Implements ns3::TcpSocket.
Definition at line 3106 of file tcp-socket-base.cc.
References m_tcb.
Referenced by DoForwardUp().
|
protectedvirtual |
Get the send buffer size.
Implements ns3::TcpSocket.
Definition at line 3068 of file tcp-socket-base.cc.
References m_txBuffer.
|
virtual |
Implements ns3::Socket.
Definition at line 474 of file tcp-socket-base.cc.
References ns3::Socket::NS3_SOCK_STREAM.
|
virtual |
Get socket address.
address | the address name this socket is associated with. |
Implements ns3::Socket.
Definition at line 903 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.
|
protectedvirtual |
Get the number of connection retries before giving up.
Implements ns3::TcpSocket.
Definition at line 3132 of file tcp-socket-base.cc.
References m_synRetries.
|
protectedvirtual |
Check if Nagle's algorithm is enabled or not.
Implements ns3::TcpSocket.
Definition at line 3185 of file tcp-socket-base.cc.
References m_noDelay.
|
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.
Implements ns3::Socket.
Definition at line 887 of file tcp-socket-base.cc.
References m_txBuffer, and NS_LOG_FUNCTION.
Referenced by ConnectionSucceeded(), NewAck(), and ProcessSynRcvd().
Ptr< TcpTxBuffer > ns3::TcpSocketBase::GetTxBuffer | ( | void | ) | const |
Get a pointer to the Tx buffer.
Definition at line 3401 of file tcp-socket-base.cc.
References m_txBuffer.
Referenced by GetTypeId().
|
static |
Get the type ID.
Get the type ID.
Definition at line 64 of file tcp-socket-base.cc.
References GetClockGranularity(), GetMinRto(), GetRxBuffer(), GetTxBuffer(), m_bytesInFlight, m_congStateTrace, m_cWndTrace, m_highRxAckMark, m_highRxMark, m_highTxMark, m_icmpCallback, m_icmpCallback6, m_lastRtt, m_limitedTx, m_maxWinSize, m_msl, m_nextTxSequence, m_retxThresh, m_rto, m_rWnd, m_rxTrace, m_ssThTrace, m_state, m_timestampEnabled, m_txTrace, m_winScalingEnabled, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeCallbackAccessor(), ns3::MakeCallbackChecker(), ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MilliSeconds(), ns3::Seconds(), SetClockGranularity(), SetMinRto(), and ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
protectedvirtual |
Timeout at LAST_ACK, close the connection.
Definition at line 2865 of file tcp-socket-base.cc.
References ns3::EventId::Cancel(), CloseAndNotify(), ns3::TcpSocket::LAST_ACK, m_closeNotified, m_lastAckEvent, m_state, and NS_LOG_FUNCTION.
Referenced by DoPeerClose().
|
virtual |
Listen for incoming connections.
Implements ns3::Socket.
Definition at line 698 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, ns3::Socket::ERROR_INVAL, ns3::TcpSocket::LISTEN, m_errno, m_state, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
protectedvirtual |
Update buffers w.r.t.
ACK
seq | the sequence number |
resetRTO | indicates if RTO should be reset |
Definition at line 2797 of file tcp-socket-base.cc.
References ns3::EventId::Cancel(), ns3::TcpSocket::CLOSING, ns3::TcpSocket::FIN_WAIT_1, ns3::TracedValue< T >::Get(), ns3::Simulator::GetDelayLeft(), GetTxAvailable(), m_clockGranularity, m_minRto, m_nextTxSequence, m_retxEvent, m_rto, m_rtt, m_state, m_txBuffer, ns3::Max(), ns3::Socket::NotifySend(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ReTxTimeout(), ns3::Simulator::Schedule(), and ns3::TcpSocket::SYN_RCVD.
Referenced by ReceivedAck().
|
protected |
Check if a sequence number range is within the rx window.
head | start of the Sequence window |
tail | end of the Sequence window |
Definition at line 1095 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSE_WAIT, ns3::TcpSocket::CLOSING, ns3::TcpSocket::LAST_ACK, ns3::TcpSocket::LISTEN, m_rxBuffer, m_state, ns3::TcpSocket::SYN_RCVD, and ns3::TcpSocket::SYN_SENT.
Referenced by DoForwardUp().
Received a FIN from peer, notify rx buffer.
p | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1998 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSING, DoPeerClose(), ns3::TcpSocket::FIN_WAIT_1, ns3::TcpHeader::GetSequenceNumber(), ns3::Packet::GetSize(), m_rxBuffer, m_state, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ReceivedData().
Referenced by ProcessEstablished(), and ProcessSynRcvd().
|
protectedvirtual |
Send 1 byte probe to get an updated window size.
Definition at line 2884 of file tcp-socket-base.cc.
References AddOptions(), AdvertisedWindowSize(), 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, m_txTrace, min, ns3::Simulator::Now(), NS_LOG_LOGIC, ns3::Simulator::Schedule(), ns3::Seconds(), ns3::TcpHeader::SetAckNumber(), ns3::TcpHeader::SetDestinationPort(), ns3::TcpHeader::SetSequenceNumber(), ns3::TcpHeader::SetSourcePort(), and ns3::TcpHeader::SetWindowSize().
Referenced by DoForwardUp().
|
protected |
Received a packet upon CLOSING.
packet | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1930 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpHeader::FlagsToString(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_rxBuffer, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), TimeWait(), and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protected |
Received a packet upon ESTABLISHED state.
This function is mimicking the role of tcp_rcv_established() in tcp_input.c in Linux kernel.
packet | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1352 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpHeader::FlagsToString(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), m_highTxMark, m_rxBuffer, m_txBuffer, NS_LOG_FUNCTION, NS_LOG_LOGIC, PeerClose(), ns3::TcpHeader::PSH, ReceivedAck(), ReceivedData(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), ns3::TcpHeader::SYN, and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protected |
Received a packet upon LAST_ACK.
packet | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1962 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpHeader::FIN, ns3::TcpHeader::FlagsToString(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_rxBuffer, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedData(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protected |
Received a packet upon LISTEN state.
packet | the packet |
tcpHeader | the packet's TCP header |
fromAddress | the source address |
toAddress | the destination address |
Definition at line 1678 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().
|
protected |
Process the timestamp option from other side.
Get the timestamp and the echo, then save timestamp (which will be the echo value in our out-packets) and save the echoed timestamp, to utilize later to calculate RTT.
option | Option from the segment |
seq | Sequence number of the segment |
Definition at line 3299 of file tcp-socket-base.cc.
References ns3::Node::GetId(), m_highTxAck, m_node, m_rxBuffer, m_timestampToEcho, NS_LOG_FUNCTION, and NS_LOG_INFO.
Referenced by DoForwardUp().
Read and parse the Window scale option.
Read the window scale option (encoded logarithmically) and save it. Per RFC 1323, the value can't exceed 14.
option | Window scale option read from the header |
Definition at line 3234 of file tcp-socket-base.cc.
References ns3::Node::GetId(), m_node, m_sndWindShift, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_WARN.
Referenced by DoForwardUp().
|
protected |
Received a packet upon SYN_RCVD.
packet | the packet |
tcpHeader | the packet's TCP header |
fromAddress | the source address |
toAddress | the destination address |
Definition at line 1767 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, ns3::EventId::Cancel(), CloseAndNotify(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::FIN, ns3::TcpHeader::FlagsToString(), 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::Socket::NotifyNewConnectionCreated(), ns3::Socket::NotifySend(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, PeerClose(), ns3::TcpHeader::PSH, ReceivedAck(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), ns3::Ipv4EndPoint::SetPeer(), ns3::Ipv6EndPoint::SetPeer(), ns3::TcpHeader::SYN, and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protected |
Received a packet upon SYN_SENT.
packet | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1708 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, ns3::EventId::Cancel(), CloseAndNotify(), ConnectionSucceeded(), ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::FlagsToString(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::TcpHeader::GetSequenceNumber(), m_connected, m_delAckCount, m_delAckMaxCount, m_highTxMark, m_nextTxSequence, m_retxEvent, m_rxBuffer, m_state, m_synCount, m_synRetries, m_txBuffer, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedData(), ns3::TcpHeader::RST, ns3::Simulator::ScheduleNow(), SendEmptyPacket(), SendPendingData(), SendRST(), ns3::TcpHeader::SYN, ns3::TcpSocket::SYN_RCVD, and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protected |
Received a packet upon CLOSE_WAIT, FIN_WAIT_1, FIN_WAIT_2.
packet | the packet |
tcpHeader | the packet's TCP header |
Definition at line 1858 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, CloseAndNotify(), ns3::TcpSocket::CLOSING, ns3::TcpHeader::FIN, ns3::TcpSocket::FIN_WAIT_1, ns3::TcpSocket::FIN_WAIT_2, ns3::TcpHeader::FlagsToString(), 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_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::TcpHeader::PSH, ReceivedAck(), ReceivedData(), ns3::TcpHeader::RST, SendEmptyPacket(), SendRST(), ns3::TcpHeader::SYN, TimeWait(), and ns3::TcpHeader::URG.
Referenced by DoForwardUp().
|
protectedvirtual |
Received an ACK packet.
packet | the packet |
tcpHeader | the packet's TCP header |
Reimplemented in ns3::TcpSocketMsgBase.
Definition at line 1421 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, BytesInFlight(), ns3::TcpSocketState::CA_DISORDER, ns3::TcpSocketState::CA_LOSS, ns3::TcpSocketState::CA_OPEN, ns3::TcpSocketState::CA_RECOVERY, DoRetransmit(), ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetFlags(), ns3::Packet::GetSize(), ns3::EventId::IsRunning(), m_bytesAckedNotProcessed, m_congestionControl, m_connected, m_dataRetrCount, m_dataRetries, m_dupAckCount, m_highRxAckMark, m_highTxMark, m_isFirstPartialAck, m_lastRtt, m_limitedTx, m_nextTxSequence, m_recover, m_retransOut, m_retxThresh, m_sendPendingDataEvent, m_tcb, m_txBuffer, min, NewAck(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ReceivedData(), SafeSubtraction(), ns3::Simulator::Schedule(), SendDataPacket(), SendPendingData(), and ns3::TimeStep().
Referenced by ProcessEstablished(), ProcessSynRcvd(), ProcessWait(), and ns3::TcpSocketMsgBase::ReceivedAck().
|
protectedvirtual |
Recv of a data, put into buffer, call L7 to get it if necessary.
packet | the packet |
tcpHeader | the packet's TCP header |
Reimplemented in ns3::TcpSocketHalfAck.
Definition at line 2683 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, ns3::EventId::Cancel(), DelAckTimeout(), DoPeerClose(), ns3::TcpHeader::FIN, 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::Socket::NotifyDataRecv(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::Simulator::Schedule(), and SendEmptyPacket().
Referenced by PeerClose(), ProcessEstablished(), ProcessLastAck(), ProcessSynSent(), ProcessWait(), ReceivedAck(), and ns3::TcpSocketHalfAck::ReceivedData().
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.
maxSize | reader will accept packet up to maxSize |
flags | Socket control flags |
Implements ns3::Socket.
Definition at line 835 of file tcp-socket-base.cc.
References ns3::Packet::AddPacketTag(), ns3::TcpSocket::CLOSE_WAIT, 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, and ns3::SocketAddressTag::SetAddress().
|
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.
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. |
Implements ns3::Socket.
Definition at line 862 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().
|
protectedvirtual |
Halving cwnd and call DoRetransmit()
Reimplemented in ns3::TcpSocketMsgBase.
Definition at line 2925 of file tcp-socket-base.cc.
References BytesInFlight(), ns3::TcpSocketState::CA_LOSS, ns3::TcpSocket::CLOSED, DoRetransmit(), m_congestionControl, m_dupAckCount, m_highTxMark, m_nextTxSequence, m_state, m_tcb, m_txBuffer, NS_LOG_DEBUG, and ns3::TcpSocket::TIME_WAIT.
Referenced by ns3::TcpSocketMsgBase::Retransmit(), and ReTxTimeout().
|
protectedvirtual |
Call Retransmit() upon RTO event.
Definition at line 2838 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, m_highTxMark, m_recover, m_state, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, Retransmit(), and ns3::TcpSocket::TIME_WAIT.
Referenced by NewAck(), and SendDataPacket().
|
staticprotected |
Performs a safe subtraction between a and b (a-b)
Safe is used to indicate that, if b>a, the results returned is 0.
a | first number |
b | second number |
Definition at line 3445 of file tcp-socket-base.cc.
Referenced by ReceivedAck().
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.
p | ns3::Packet to send |
flags | Socket control flags |
Implements ns3::Socket.
Definition at line 788 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSE_WAIT, ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_NOTCONN, ns3::Socket::ERROR_SHUTDOWN, ns3::TcpSocket::ESTABLISHED, ns3::Packet::GetSize(), ns3::EventId::IsRunning(), m_connected, m_errno, m_sendPendingDataEvent, m_shutdownSend, m_state, m_txBuffer, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), SendPendingData(), ns3::TcpSocket::SYN_SENT, ns3::TcpSocket::TcpStateName, and ns3::TimeStep().
Referenced by SendTo().
|
protected |
Extract at most maxSize bytes from the TxBuffer at sequence seq, add the TCP header, and send to TcpL4Protocol.
seq | the sequence number |
maxSize | the maximum data block to be transmitted (in bytes) |
withAck | forces an ACK to be sent |
Definition at line 2387 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, AddOptions(), ns3::Packet::AddPacketTag(), AdvertisedWindowSize(), ns3::EventId::Cancel(), ns3::TcpSocket::CLOSE_WAIT, ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::FIN, ns3::TcpSocket::FIN_WAIT_1, ns3::Time::FromDouble(), 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::TcpSocket::LAST_ACK, ns3::Socket::m_boundnetdevice, m_closeOnEmpty, m_delAckCount, m_delAckEvent, m_endPoint, m_endPoint6, m_highTxMark, m_retxEvent, m_rto, m_rxBuffer, m_state, m_tcp, m_txBuffer, m_txTrace, max, ns3::Min(), ns3::Socket::NotifyDataSent(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ReTxTimeout(), ns3::Time::S, 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 UpdateRttHistory().
Referenced by DoRetransmit(), ReceivedAck(), and SendPendingData().
|
protectedvirtual |
Send a empty packet that carries a flag, e.g.
ACK
flags | the packet's flags |
Reimplemented in ns3::TcpSocketSmallAcks.
Definition at line 2105 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, AddOptions(), ns3::Packet::AddPacketTag(), AdvertisedWindowSize(), ns3::EventId::Cancel(), CloseAndNotify(), ns3::TcpSocket::CLOSING, ns3::TcpHeader::FIN, ns3::TcpSocket::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::EventId::IsExpired(), ns3::Socket::IsManualIpTos(), ns3::Socket::IsManualIpTtl(), ns3::Socket::IsManualIpv6HopLimit(), ns3::Socket::IsManualIpv6Tclass(), ns3::TcpSocket::LAST_ACK, ns3::Socket::m_boundnetdevice, m_clockGranularity, m_cnTimeout, m_delAckCount, m_delAckEvent, m_endPoint, m_endPoint6, m_highTxAck, m_minRto, m_nextTxSequence, m_retxEvent, m_rto, m_rtt, m_rxBuffer, m_state, m_synCount, m_synRetries, m_tcp, m_txTrace, ns3::Max(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::Simulator::Schedule(), ns3::SocketIpv6HopLimitTag::SetHopLimit(), ns3::SocketIpv6TclassTag::SetTclass(), ns3::SocketIpTosTag::SetTos(), ns3::SocketIpTtlTag::SetTtl(), ns3::TcpHeader::SYN, and UpdateRttHistory().
Referenced by CompleteFork(), DelAckTimeout(), DoClose(), DoConnect(), DoForwardUp(), DoPeerClose(), DoRetransmit(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReceivedData(), SendRST(), SetRcvBufSize(), and ShutdownSend().
|
protected |
Send as much pending data as possible according to the Tx window.
Note that this function did not implement the PSH flag.
withAck | forces an ACK to be sent |
Definition at line 2550 of file tcp-socket-base.cc.
References AvailableWindow(), m_endPoint, m_endPoint6, m_nextTxSequence, m_noDelay, m_rWnd, m_shutdownSend, m_tcb, m_txBuffer, min, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, SendDataPacket(), UnAckDataCount(), and visualizer.higcontainer::w.
Referenced by DoForwardUp(), ProcessSynSent(), ReceivedAck(), and Send().
|
protected |
Send reset and tear down this socket.
Definition at line 2241 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().
|
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.
Implements ns3::Socket.
Definition at line 827 of file tcp-socket-base.cc.
References Send().
|
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.
allowBroadcast | Whether broadcast is allowed |
Implements ns3::Socket.
Definition at line 3204 of file tcp-socket-base.cc.
void ns3::TcpSocketBase::SetClockGranularity | ( | Time | clockGranularity | ) |
Sets the Clock Granularity (used in RTO calcs).
clockGranularity | The Clock Granularity |
Definition at line 3388 of file tcp-socket-base.cc.
References m_clockGranularity, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::TcpSocketBase::SetCongestionControlAlgorithm | ( | Ptr< TcpCongestionOps > | algo | ) |
Install a congestion control algorithm on this socket.
algo | Algorithm to be installed |
Definition at line 3432 of file tcp-socket-base.cc.
References m_congestionControl, and NS_LOG_FUNCTION.
|
protectedvirtual |
Set the connection timeout.
timeout | the connection timeout |
Implements ns3::TcpSocket.
Definition at line 3112 of file tcp-socket-base.cc.
References m_cnTimeout, NS_LOG_FUNCTION, and timeout.
|
protectedvirtual |
Set the number of data transmission retries before giving up.
count | the number of data transmission retries |
Implements ns3::TcpSocket.
Definition at line 3138 of file tcp-socket-base.cc.
References m_dataRetries, and NS_LOG_FUNCTION.
|
protectedvirtual |
Set the number of packet to fire an ACK before delay timeout.
count | the umber of packet to fire an ACK before delay timeout |
Implements ns3::TcpSocket.
Definition at line 3165 of file tcp-socket-base.cc.
References m_delAckMaxCount, and NS_LOG_FUNCTION.
|
protectedvirtual |
Set the time to delay an ACK.
timeout | the time to delay an ACK |
Implements ns3::TcpSocket.
Definition at line 3152 of file tcp-socket-base.cc.
References m_delAckTimeout, NS_LOG_FUNCTION, and timeout.
|
protectedvirtual |
Set the initial Congestion Window.
cwnd | the initial congestion window (in bytes) |
Implements ns3::TcpSocket.
Definition at line 608 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, m_state, m_tcb, and NS_ABORT_MSG_UNLESS.
|
protectedvirtual |
Set the initial Slow Start Threshold.
threshold | the Slow Start Threshold (in bytes) |
Implements ns3::TcpSocket.
Definition at line 593 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, m_state, m_tcb, and NS_ABORT_MSG_UNLESS.
void ns3::TcpSocketBase::SetMinRto | ( | Time | minRto | ) |
Sets the Minimum RTO.
minRto | The minimum RTO. |
Definition at line 3375 of file tcp-socket-base.cc.
References m_minRto, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
Set the associated node.
node | the node |
Definition at line 446 of file tcp-socket-base.cc.
References m_node.
|
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
timeout | the persistent timout |
Implements ns3::TcpSocket.
Definition at line 3191 of file tcp-socket-base.cc.
References m_persistTimeout, NS_LOG_FUNCTION, and timeout.
|
protectedvirtual |
Set the receive buffer size.
size | the buffer size (in bytes) |
Implements ns3::TcpSocket.
Definition at line 3074 of file tcp-socket-base.cc.
References ns3::TcpHeader::ACK, GetRcvBufSize(), m_connected, m_rxBuffer, NS_LOG_FUNCTION, and SendEmptyPacket().
|
virtual |
Set the associated RTT estimator.
rtt | the RTT estimator |
Definition at line 460 of file tcp-socket-base.cc.
References m_rtt.
|
protectedvirtual |
Set the segment size.
size | the segment size (in bytes) |
Implements ns3::TcpSocket.
Definition at line 3097 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSED, m_state, m_tcb, NS_ABORT_MSG_UNLESS, and NS_LOG_FUNCTION.
|
protectedvirtual |
Set the send buffer size.
size | the buffer size (in bytes) |
Implements ns3::TcpSocket.
Definition at line 3061 of file tcp-socket-base.cc.
References m_txBuffer, and NS_LOG_FUNCTION.
|
protectedvirtual |
Set the number of connection retries before giving up.
count | the number of connection retries |
Implements ns3::TcpSocket.
Definition at line 3125 of file tcp-socket-base.cc.
References m_synRetries, and NS_LOG_FUNCTION.
|
virtual |
Set the associated TCP L4 protocol.
tcp | the TCP L4 protocol |
Definition at line 453 of file tcp-socket-base.cc.
References m_tcp.
|
protectedvirtual |
Enable/Disable Nagle's algorithm.
noDelay | true to DISABLE Nagle's algorithm |
Implements ns3::TcpSocket.
Definition at line 3178 of file tcp-socket-base.cc.
References m_noDelay, and NS_LOG_FUNCTION.
|
protected |
Common part of the two Bind(), i.e.
set callback and remembering local addr:port
Definition at line 985 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().
|
protected |
Configure the endpoint to a local address.
Called by Connect() if Bind() didn't specify one.
Definition at line 2273 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().
|
protected |
Configure the endpoint v6 to a local address.
Called by Connect() if Bind() didn't specify one.
Definition at line 2303 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().
|
virtual |
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 778 of file tcp-socket-base.cc.
References m_shutdownRecv, and NS_LOG_FUNCTION.
|
virtual |
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 744 of file tcp-socket-base.cc.
References ns3::TcpSocket::CLOSE_WAIT, ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::FIN, ns3::TcpSocket::FIN_WAIT_1, ns3::TcpSocket::LAST_ACK, m_closeOnEmpty, m_shutdownSend, m_state, m_txBuffer, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, and SendEmptyPacket().
|
protected |
Move from CLOSING or FIN_WAIT_2 to TIME_WAIT state.
Definition at line 3047 of file tcp-socket-base.cc.
References CancelAllTimers(), CloseAndNotify(), m_msl, m_state, m_timewaitEvent, NS_LOG_DEBUG, ns3::Simulator::Schedule(), ns3::Seconds(), ns3::TcpSocket::TcpStateName, and ns3::TcpSocket::TIME_WAIT.
Referenced by ProcessClosing(), and ProcessWait().
|
protectedvirtual |
Return count of number of unacked bytes.
Definition at line 2606 of file tcp-socket-base.cc.
References ns3::TracedValue< T >::Get(), m_nextTxSequence, m_txBuffer, and NS_LOG_FUNCTION.
Referenced by AvailableWindow(), and SendPendingData().
void ns3::TcpSocketBase::UpdateCongState | ( | TcpSocketState::TcpCongState_t | oldValue, |
TcpSocketState::TcpCongState_t | newValue | ||
) |
Callback function to hook to TcpSocketState congestion state.
oldValue | old congestion state value |
newValue | new congestion state value |
Definition at line 3425 of file tcp-socket-base.cc.
References m_congStateTrace.
Referenced by TcpSocketBase().
void ns3::TcpSocketBase::UpdateCwnd | ( | uint32_t | oldValue, |
uint32_t | newValue | ||
) |
Callback function to hook to TcpSocketState congestion window.
oldValue | old cWnd value |
newValue | new cWnd value |
Definition at line 3413 of file tcp-socket-base.cc.
References m_cWndTrace.
Referenced by TcpSocketBase().
|
protectedvirtual |
Update the RTT history, when we send TCP segments.
seq | The sequence number of the TCP segment |
sz | The segment's size |
isRetransmission | Whether or not the segment is a retransmission |
Reimplemented in ns3::TcpSocketMsgBase.
Definition at line 2522 of file tcp-socket-base.cc.
References m_history, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
Referenced by SendDataPacket(), SendEmptyPacket(), and ns3::TcpSocketMsgBase::UpdateRttHistory().
void ns3::TcpSocketBase::UpdateSsThresh | ( | uint32_t | oldValue, |
uint32_t | newValue | ||
) |
Callback function to hook to TcpSocketState slow start threshold.
oldValue | old ssTh value |
newValue | new ssTh value |
Definition at line 3419 of file tcp-socket-base.cc.
References m_ssThTrace.
Referenced by TcpSocketBase().
|
protected |
Update the receiver window (RWND) based on the value of the window field in the header.
This method suppresses updates unless one of the following three conditions holds: 1) segment contains new data (advancing the right edge of the receive buffer), 2) segment does not contain new data but the segment acks new data (highest sequence number acked advances), or 3) the advertised window is larger than the current send window
header | TcpHeader from which to extract the new window value |
Definition at line 3330 of file tcp-socket-base.cc.
References ns3::TcpSocket::ESTABLISHED, ns3::TcpHeader::GetAckNumber(), ns3::TcpHeader::GetSequenceNumber(), ns3::TcpHeader::GetWindowSize(), m_highRxAckMark, m_highRxMark, m_rWnd, m_sndWindShift, m_state, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_LOGIC.
Referenced by DoForwardUp().
|
protectedvirtual |
Return the max possible number of unacked bytes.
Definition at line 2648 of file tcp-socket-base.cc.
References ns3::TracedValue< T >::Get(), m_rWnd, m_tcb, min, and NS_LOG_FUNCTION.
Referenced by AvailableWindow().
|
friend |
Definition at line 258 of file tcp-socket-base.h.
|
protected |
Bytes acked, but not processed.
Definition at line 965 of file tcp-socket-base.h.
Referenced by ReceivedAck().
|
protected |
Bytes in flight.
Definition at line 966 of file tcp-socket-base.h.
Referenced by BytesInFlight(), and GetTypeId().
|
protected |
Clock Granularity used in RTO calcs.
Definition at line 926 of file tcp-socket-base.h.
Referenced by DoPeerClose(), EstimateRtt(), GetClockGranularity(), NewAck(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), and SetClockGranularity().
|
protected |
Told app to close socket.
Definition at line 952 of file tcp-socket-base.h.
Referenced by CloseAndNotify(), DoPeerClose(), LastAckTimeout(), and ReceivedData().
|
protected |
Close socket upon tx buffer emptied.
Definition at line 953 of file tcp-socket-base.h.
Referenced by Close(), SendDataPacket(), and ShutdownSend().
|
protected |
Timeout for connection retry.
Definition at line 930 of file tcp-socket-base.h.
Referenced by GetConnTimeout(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), and SetConnTimeout().
|
protected |
Congestion control.
Definition at line 986 of file tcp-socket-base.h.
Referenced by ReceivedAck(), Retransmit(), SetCongestionControlAlgorithm(), and TcpSocketBase().
TracedCallback<TcpSocketState::TcpCongState_t, TcpSocketState::TcpCongState_t> ns3::TcpSocketBase::m_congStateTrace |
Callback pointer for congestion state trace chaining.
Definition at line 342 of file tcp-socket-base.h.
Referenced by GetTypeId(), and UpdateCongState().
|
protected |
Connection established.
Definition at line 956 of file tcp-socket-base.h.
Referenced by DoForwardUp(), ProcessSynRcvd(), ProcessSynSent(), ReceivedAck(), Send(), and SetRcvBufSize().
TracedCallback<uint32_t, uint32_t> ns3::TcpSocketBase::m_cWndTrace |
Callback pointer for cWnd trace chaining.
Definition at line 332 of file tcp-socket-base.h.
Referenced by GetTypeId(), and UpdateCwnd().
|
protected |
Count of remaining data retransmission attempts.
Definition at line 922 of file tcp-socket-base.h.
Referenced by CompleteFork(), Connect(), DoRetransmit(), and ReceivedAck().
|
protected |
Number of data retransmission attempts.
Definition at line 923 of file tcp-socket-base.h.
Referenced by CompleteFork(), Connect(), GetDataRetries(), ReceivedAck(), and SetDataRetries().
|
protected |
Delayed ACK counter.
Definition at line 917 of file tcp-socket-base.h.
Referenced by DelAckTimeout(), ProcessSynRcvd(), ProcessSynSent(), ReceivedData(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Delayed ACK timeout event.
Definition at line 913 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), ReceivedData(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Number of packet to fire an ACK before delay timeout.
Definition at line 918 of file tcp-socket-base.h.
Referenced by GetDelAckMaxCount(), ProcessSynRcvd(), ProcessSynSent(), ReceivedData(), and SetDelAckMaxCount().
|
protected |
Time to delay an ACK.
Definition at line 928 of file tcp-socket-base.h.
Referenced by GetDelAckTimeout(), ReceivedData(), and SetDelAckTimeout().
|
protected |
Dupack counter.
Definition at line 916 of file tcp-socket-base.h.
Referenced by BytesInFlight(), ReceivedAck(), and Retransmit().
|
protected |
the IPv4 endpoint
Definition at line 934 of file tcp-socket-base.h.
Referenced by Bind(), BindToNetDevice(), CompleteFork(), Connect(), DeallocateEndPoint(), Destroy(), ForwardUp(), GetPeerName(), GetSockName(), PersistTimeout(), ProcessSynRcvd(), Recv(), RecvFrom(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SendPendingData(), SetupCallback(), SetupEndpoint(), and ~TcpSocketBase().
|
protected |
the IPv6 endpoint
Definition at line 935 of file tcp-socket-base.h.
Referenced by Bind(), Bind6(), BindToNetDevice(), CompleteFork(), Connect(), DeallocateEndPoint(), Destroy6(), ForwardUp6(), GetPeerName(), GetSockName(), PersistTimeout(), ProcessSynRcvd(), Recv(), RecvFrom(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SendPendingData(), SetupCallback(), SetupEndpoint6(), and ~TcpSocketBase().
|
mutableprotected |
Socket error code.
Definition at line 951 of file tcp-socket-base.h.
Referenced by Bind(), Bind6(), Connect(), GetErrno(), GetPeerName(), Listen(), Send(), SetupEndpoint(), and SetupEndpoint6().
|
protected |
Highest ack received.
Definition at line 964 of file tcp-socket-base.h.
Referenced by DoForwardUp(), GetTypeId(), ReceivedAck(), and UpdateWindowSize().
|
protected |
Highest seqno received.
Definition at line 962 of file tcp-socket-base.h.
Referenced by GetTypeId(), and UpdateWindowSize().
|
protected |
Highest ack sent.
Definition at line 963 of file tcp-socket-base.h.
Referenced by ProcessOptionTimestamp(), and SendEmptyPacket().
|
protected |
Highest seqno ever sent, regardless of ReTx.
Definition at line 945 of file tcp-socket-base.h.
Referenced by GetTypeId(), ProcessEstablished(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReceivedAck(), Retransmit(), ReTxTimeout(), and SendDataPacket().
|
protected |
List of sent packet.
Definition at line 931 of file tcp-socket-base.h.
Referenced by EstimateRtt(), and UpdateRttHistory().
|
protected |
ICMP callback.
Definition at line 938 of file tcp-socket-base.h.
Referenced by ForwardIcmp(), and GetTypeId().
|
protected |
ICMPv6 callback.
Definition at line 939 of file tcp-socket-base.h.
Referenced by ForwardIcmp6(), and GetTypeId().
|
protected |
First partial ACK during RECOVERY.
Definition at line 989 of file tcp-socket-base.h.
Referenced by ReceivedAck().
|
protected |
Last ACK timeout event.
Definition at line 912 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), DoPeerClose(), and LastAckTimeout().
|
protected |
Last RTT sample collected.
Definition at line 927 of file tcp-socket-base.h.
Referenced by EstimateRtt(), GetTypeId(), and ReceivedAck().
|
protected |
perform limited transmit
Definition at line 981 of file tcp-socket-base.h.
Referenced by GetTypeId(), and ReceivedAck().
|
protected |
Maximum window size to advertise.
Definition at line 960 of file tcp-socket-base.h.
Referenced by AdvertisedWindowSize(), CalculateWScale(), and GetTypeId().
|
protected |
minimum value of the Retransmit timeout
Definition at line 925 of file tcp-socket-base.h.
Referenced by EstimateRtt(), GetMinRto(), NewAck(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), and SetMinRto().
|
protected |
Max segment lifetime.
Definition at line 957 of file tcp-socket-base.h.
Referenced by GetTypeId(), and TimeWait().
|
protected |
Next seqnum to be sent (SND.NXT), ReTx pushes it back.
Definition at line 944 of file tcp-socket-base.h.
Referenced by BytesInFlight(), Close(), DoForwardUp(), DoRetransmit(), GetTypeId(), NewAck(), PersistTimeout(), ProcessSynRcvd(), ProcessSynSent(), ReceivedAck(), Retransmit(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SendPendingData(), and UnAckDataCount().
the associated node
Definition at line 936 of file tcp-socket-base.h.
Referenced by AddOptionTimestamp(), AddOptionWScale(), CalculateWScale(), GetNode(), ProcessOptionTimestamp(), ProcessOptionWScale(), SetNode(), SetupEndpoint(), SetupEndpoint6(), and ~TcpSocketBase().
|
protected |
Set to true to disable Nagle's algorithm.
Definition at line 919 of file tcp-socket-base.h.
Referenced by GetTcpNoDelay(), SendPendingData(), and SetTcpNoDelay().
|
protected |
Persist event: Send 1 byte to probe for a non-zero Rx window.
Definition at line 914 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), DoForwardUp(), and PersistTimeout().
|
protected |
Time between sending 1-byte probes.
Definition at line 929 of file tcp-socket-base.h.
Referenced by DoForwardUp(), GetPersistTimeout(), PersistTimeout(), and SetPersistTimeout().
|
protected |
Window shift to apply to outgoing segments.
Definition at line 970 of file tcp-socket-base.h.
Referenced by AddOptionWScale(), and AdvertisedWindowSize().
|
protected |
Previous highest Tx seqnum for fast recovery.
Definition at line 979 of file tcp-socket-base.h.
Referenced by ReceivedAck(), and ReTxTimeout().
|
protected |
Number of retransmission in this window.
Definition at line 982 of file tcp-socket-base.h.
Referenced by BytesInFlight(), DoRetransmit(), and ReceivedAck().
|
protected |
Retransmission event.
Definition at line 911 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), Destroy(), Destroy6(), DoForwardUp(), NewAck(), ProcessSynRcvd(), ProcessSynSent(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Fast Retransmit threshold.
Definition at line 980 of file tcp-socket-base.h.
Referenced by GetTypeId(), and ReceivedAck().
|
protected |
Retransmit timeout.
Definition at line 924 of file tcp-socket-base.h.
Referenced by EstimateRtt(), GetTypeId(), NewAck(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Round trip time estimator.
Definition at line 941 of file tcp-socket-base.h.
Referenced by Connect(), DoPeerClose(), EstimateRtt(), NewAck(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SetRtt(), and TcpSocketBase().
|
protected |
Receiver window (RCV.WND in RFC793)
Definition at line 961 of file tcp-socket-base.h.
Referenced by DoForwardUp(), GetTypeId(), SendPendingData(), UpdateWindowSize(), and Window().
|
protected |
Rx buffer (reordering buffer)
Definition at line 946 of file tcp-socket-base.h.
Referenced by AdvertisedWindowSize(), CalculateWScale(), Close(), CompleteFork(), DoForwardUp(), GetRcvBufSize(), GetRxAvailable(), GetRxBuffer(), OutOfRange(), PeerClose(), PersistTimeout(), ProcessClosing(), ProcessEstablished(), ProcessLastAck(), ProcessOptionTimestamp(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReceivedData(), Recv(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SetRcvBufSize(), and TcpSocketBase().
|
protected |
Trace of received packets.
Definition at line 996 of file tcp-socket-base.h.
Referenced by DoForwardUp(), and GetTypeId().
|
protected |
micro-delay event to send pending data
Definition at line 976 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), DoForwardUp(), ReceivedAck(), and Send().
|
protected |
Receive no longer allowed.
Definition at line 955 of file tcp-socket-base.h.
Referenced by ProcessWait(), ReceivedData(), and ShutdownRecv().
|
protected |
Send no longer allowed.
Definition at line 954 of file tcp-socket-base.h.
Referenced by DoPeerClose(), Send(), SendPendingData(), and ShutdownSend().
|
protected |
Window shift to apply to incoming segments.
Definition at line 971 of file tcp-socket-base.h.
Referenced by ProcessOptionWScale(), and UpdateWindowSize().
TracedCallback<uint32_t, uint32_t> ns3::TcpSocketBase::m_ssThTrace |
Callback pointer for ssTh trace chaining.
Definition at line 337 of file tcp-socket-base.h.
Referenced by GetTypeId(), and UpdateSsThresh().
|
protected |
TCP state.
Definition at line 950 of file tcp-socket-base.h.
Referenced by Close(), CloseAndNotify(), CompleteFork(), DoClose(), DoConnect(), DoForwardUp(), DoPeerClose(), DoRetransmit(), GetTypeId(), LastAckTimeout(), Listen(), NewAck(), OutOfRange(), PeerClose(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), Recv(), Retransmit(), ReTxTimeout(), Send(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SetInitialCwnd(), SetInitialSSThresh(), SetSegSize(), ShutdownSend(), TimeWait(), and UpdateWindowSize().
|
protected |
Count of remaining connection retries.
Definition at line 920 of file tcp-socket-base.h.
Referenced by CompleteFork(), Connect(), DoRetransmit(), ProcessSynSent(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Number of connection attempts.
Definition at line 921 of file tcp-socket-base.h.
Referenced by CompleteFork(), Connect(), GetSynRetries(), ProcessSynSent(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), and SetSynRetries().
|
protected |
Congestion control informations.
Definition at line 985 of file tcp-socket-base.h.
Referenced by BytesInFlight(), DoForwardUp(), DoRetransmit(), GetInitialCwnd(), GetInitialSSThresh(), GetSegSize(), ReceivedAck(), ns3::TcpSocketMsgBase::Retransmit(), Retransmit(), SendPendingData(), SetInitialCwnd(), SetInitialSSThresh(), SetSegSize(), TcpSocketBase(), and Window().
|
protected |
the associated TCP L4 protocol
Definition at line 937 of file tcp-socket-base.h.
Referenced by Bind(), Bind6(), CompleteFork(), DeallocateEndPoint(), Destroy(), Destroy6(), DoForwardUp(), PersistTimeout(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), SendEmptyPacket(), SetTcp(), and ~TcpSocketBase().
|
protected |
Timestamp option enabled.
Definition at line 973 of file tcp-socket-base.h.
Referenced by AddOptions(), DoForwardUp(), EstimateRtt(), and GetTypeId().
|
protected |
Timestamp to echo.
Definition at line 974 of file tcp-socket-base.h.
Referenced by AddOptionTimestamp(), and ProcessOptionTimestamp().
|
protected |
TIME_WAIT expiration event: Move this socket to CLOSED state.
Definition at line 915 of file tcp-socket-base.h.
Referenced by CancelAllTimers(), and TimeWait().
|
protected |
Tx buffer.
Definition at line 947 of file tcp-socket-base.h.
Referenced by BytesInFlight(), Close(), DoRetransmit(), GetSndBufSize(), GetTxAvailable(), GetTxBuffer(), NewAck(), PersistTimeout(), ProcessEstablished(), ProcessSynRcvd(), ProcessSynSent(), ProcessWait(), ReceivedAck(), Retransmit(), Send(), SendDataPacket(), SendPendingData(), SetSndBufSize(), ShutdownSend(), TcpSocketBase(), and UnAckDataCount().
|
protected |
Trace of transmitted packets.
Definition at line 993 of file tcp-socket-base.h.
Referenced by DoForwardUp(), GetTypeId(), PersistTimeout(), SendDataPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and SendEmptyPacket().
|
protected |
Window Scale option enabled (RFC 7323)
Definition at line 969 of file tcp-socket-base.h.
Referenced by AddOptions(), DoForwardUp(), and GetTypeId().