ns3::TcpSocketImpl Class Reference
[SocketTcp]

An implementation of a stream socket using TCP. More...

#include <tcp-socket-impl.h>

Inheritance diagram for ns3::TcpSocketImpl:
Inheritance graph
[legend]
Collaboration diagram for ns3::TcpSocketImpl:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TcpSocketImpl ()
 TcpSocketImpl (const TcpSocketImpl &sock)
virtual ~TcpSocketImpl ()
void SetNode (Ptr< Node > node)
void SetTcp (Ptr< TcpL4Protocol > tcp)
void SetRtt (Ptr< RttEstimator > rtt)
virtual enum SocketErrno GetErrno (void) const
virtual Ptr< NodeGetNode (void) const
virtual int Bind (void)
virtual int Bind (const Address &address)
virtual int Close (void)
 Close a socket.
virtual int ShutdownSend (void)
virtual int ShutdownRecv (void)
virtual int Connect (const Address &address)
 Initiate a connection to a remote host.
virtual int Listen (void)
 Listen for incoming connections.
virtual uint32_t GetTxAvailable (void) const
 Returns the number of bytes which can be sent in a single call to Send.
virtual int Send (Ptr< Packet > p, uint32_t flags)
 Send data (or dummy data) to the remote host.
virtual int SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)
 Send data to a specified peer.
virtual uint32_t GetRxAvailable (void) const
virtual Ptr< PacketRecv (uint32_t maxSize, uint32_t flags)
 Read data from the socket.
virtual Ptr< PacketRecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)
 Read a single packet from the socket and retrieve the sender address.
virtual int GetSockName (Address &address) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::TcpSocketImpl.

Private Member Functions

int FinishBind (void)
void ForwardUp (Ptr< Packet > p, Ipv4Address ipv4, uint16_t port)
void Destroy (void)
int DoSendTo (Ptr< Packet > p, const Address &daddr)
int DoSendTo (Ptr< Packet > p, Ipv4Address daddr, uint16_t dport)
void SendEmptyPacket (uint8_t flags)
bool ProcessAction (Actions_t a)
bool ProcessAction (Actions_t a, const TcpHeader &tcpHeader, Ipv4Address saddr, Ipv4Address daddr)
bool ProcessPacketAction (Actions_t a, Ptr< Packet > p, const TcpHeader &tcpHeader, const Address &fromAddress)
Actions_t ProcessEvent (Events_t e)
bool SendPendingData (bool withAck=false)
void CompleteFork (Ptr< Packet >, const TcpHeader &, const Address &fromAddress)
void ConnectionSucceeded ()
virtual uint32_t UnAckDataCount ()
virtual uint32_t BytesInFlight ()
virtual uint32_t Window ()
virtual uint32_t AvailableWindow ()
uint32_t RxBufferFreeSpace ()
uint16_t AdvertisedWindowSize ()
void NewRx (Ptr< Packet >, const TcpHeader &, const Address &)
void RxBufFinishInsert (SequenceNumber)
Ptr< TcpSocketImplCopy ()
void NewAck (SequenceNumber seq)
void DupAck (const TcpHeader &t, uint32_t count)
void ReTxTimeout ()
void DelAckTimeout ()
void LastAckTimeout ()
void PersistTimeout ()
void Retransmit ()
void CommonNewAck (SequenceNumber seq, bool skipTimer=false)
virtual void SetSndBufSize (uint32_t size)
virtual uint32_t GetSndBufSize (void) const
virtual void SetRcvBufSize (uint32_t size)
virtual uint32_t GetRcvBufSize (void) const
virtual void SetSegSize (uint32_t size)
virtual uint32_t GetSegSize (void) const
virtual void SetSSThresh (uint32_t threshold)
virtual uint32_t GetSSThresh (void) const
virtual void SetInitialCwnd (uint32_t cwnd)
virtual uint32_t GetInitialCwnd (void) const
virtual void SetConnTimeout (Time timeout)
virtual Time GetConnTimeout (void) const
virtual void SetConnCount (uint32_t count)
virtual uint32_t GetConnCount (void) const
virtual void SetDelAckTimeout (Time timeout)
virtual Time GetDelAckTimeout (void) const
virtual void SetDelAckMaxCount (uint32_t count)
virtual uint32_t GetDelAckMaxCount (void) const

Private Attributes

bool m_skipRetxResched
uint32_t m_dupAckCount
EventId m_retxEvent
EventId m_lastAckEvent
EventId m_delAckEvent
uint32_t m_delAckCount
uint32_t m_delAckMaxCount
Time m_delAckTimeout
Ipv4EndPointm_endPoint
Ptr< Nodem_node
Ptr< TcpL4Protocolm_tcp
Ipv4Address m_remoteAddress
uint16_t m_remotePort
Ipv4Address m_localAddress
uint16_t m_localPort
enum SocketErrno m_errno
bool m_shutdownSend
bool m_shutdownRecv
bool m_connected
States_t m_state
bool m_closeNotified
bool m_closeRequestNotified
bool m_closeOnEmpty
bool m_pendingClose
SequenceNumber m_nextTxSequence
SequenceNumber m_highTxMark
SequenceNumber m_highestRxAck
SequenceNumber m_lastRxAck
SequenceNumber m_nextRxSequence
UnAckData_t m_bufferedData
uint32_t m_rxAvailable
uint32_t m_rxBufSize
PendingDatam_pendingData
SequenceNumber m_firstPendingSequence
uint32_t m_segmentSize
uint32_t m_rxWindowSize
TracedValue< uint32_t > m_cWnd
uint32_t m_ssThresh
uint32_t m_initialCWnd
Time m_persistTime
EventId m_persistEvent
Ptr< RttEstimatorm_rtt
Time m_lastMeasuredRtt
Time m_cnTimeout
uint32_t m_cnCount
uint32_t m_sndBufSize
uint32_t m_rxBufMaxSize

Friends

class Tcp

Detailed Description

An implementation of a stream socket using TCP.

This class contains an implementation of TCP Tahoe, as well as a sockets interface for talking to TCP. Features include connection orientation, reliability through cumulative acknowledgements, congestion and flow control. Finite send buffer semantics are modeled, but as of yet, finite receive buffer modelling is unimplemented.

The closedown of these sockets is as of yet not compliant with the relevent RFCs, i.e. the FIN handshaking isn't correct. While this is visible at the PCAP tracing level, it has no effect on the statistics users are interested in, i.e. throughput, delay, etc. of actual payload data.

Asynchronous callbacks to provide notifications to higher layers that a protocol event has occured, such as space freeing up in the send buffer or new data arriving in the receive buffer.

Definition at line 66 of file tcp-socket-impl.h.


Constructor & Destructor Documentation

ns3::TcpSocketImpl::TcpSocketImpl (  ) 

Create an unbound tcp socket.

Definition at line 58 of file tcp-socket-impl.cc.

References NS_LOG_FUNCTION.

ns3::TcpSocketImpl::TcpSocketImpl ( const TcpSocketImpl sock  ) 
ns3::TcpSocketImpl::~TcpSocketImpl (  )  [virtual]

Note that this piece of code is a bit tricky: when DeAllocate is called, it will call into Ipv4EndPointDemux::Deallocate which triggers a delete of the associated endPoint which triggers in turn a call to the method Destroy below will will zero the m_endPoint field.

Definition at line 165 of file tcp-socket-impl.cc.

References m_endPoint, m_node, m_pendingData, m_tcp, NS_ASSERT, and NS_LOG_FUNCTION.


Member Function Documentation

uint16_t ns3::TcpSocketImpl::AdvertisedWindowSize (  )  [private]

Definition at line 1093 of file tcp-socket-impl.cc.

References RxBufferFreeSpace().

Referenced by PersistTimeout(), Retransmit(), SendEmptyPacket(), and SendPendingData().

uint32_t ns3::TcpSocketImpl::AvailableWindow (  )  [private, virtual]

Definition at line 1076 of file tcp-socket-impl.cc.

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

Referenced by SendPendingData().

int ns3::TcpSocketImpl::Bind ( const Address address  )  [virtual]
Parameters:
address the address to try to allocate
Returns:
0 on success, -1 on failure.

Allocate a local endpoint for this socket.

Implements ns3::Socket.

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, FinishBind(), ns3::Ipv4Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), m_endPoint, m_errno, m_tcp, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

int ns3::TcpSocketImpl::Bind ( void   )  [virtual]

Allocate a local endpoint for this socket.

Returns:
0 on success, -1 on failure.

Implements ns3::Socket.

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

References FinishBind(), m_endPoint, m_tcp, and NS_LOG_FUNCTION_NOARGS.

Referenced by Connect(), and DoSendTo().

uint32_t ns3::TcpSocketImpl::BytesInFlight (  )  [private, virtual]

Definition at line 1063 of file tcp-socket-impl.cc.

References m_highestRxAck, m_highTxMark, and NS_LOG_FUNCTION_NOARGS.

Referenced by DupAck().

int ns3::TcpSocketImpl::Close ( void   )  [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 309 of file tcp-socket-impl.cc.

References ns3::APP_CLOSE, m_closeOnEmpty, m_pendingData, m_state, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, ProcessAction(), ProcessEvent(), ShutdownSend(), and ns3::PendingData::Size().

void ns3::TcpSocketImpl::CommonNewAck ( SequenceNumber  seq,
bool  skipTimer = false 
) [private]
void ns3::TcpSocketImpl::CompleteFork ( Ptr< Packet p,
const TcpHeader h,
const Address fromAddress 
) [private]
int ns3::TcpSocketImpl::Connect ( const Address address  )  [virtual]
void ns3::TcpSocketImpl::ConnectionSucceeded (  )  [private]

Definition at line 963 of file tcp-socket-impl.cc.

References ns3::Socket::NotifyConnectionSucceeded().

Referenced by ProcessEvent().

Ptr< TcpSocketImpl > ns3::TcpSocketImpl::Copy ( void   )  [private]

Definition at line 1392 of file tcp-socket-impl.cc.

Referenced by ProcessPacketAction().

void ns3::TcpSocketImpl::DelAckTimeout (  )  [private]

Definition at line 1322 of file tcp-socket-impl.cc.

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

Referenced by NewRx().

void ns3::TcpSocketImpl::Destroy ( void   )  [private]
int ns3::TcpSocketImpl::DoSendTo ( Ptr< Packet p,
Ipv4Address  daddr,
uint16_t  dport 
) [private]
int ns3::TcpSocketImpl::DoSendTo ( Ptr< Packet p,
const Address daddr 
) [private]
void ns3::TcpSocketImpl::DupAck ( const TcpHeader t,
uint32_t  count 
) [private]
int ns3::TcpSocketImpl::FinishBind ( void   )  [private]
void ns3::TcpSocketImpl::ForwardUp ( Ptr< Packet p,
Ipv4Address  ipv4,
uint16_t  port 
) [private]
uint32_t ns3::TcpSocketImpl::GetConnCount ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1640 of file tcp-socket-impl.cc.

References m_cnCount.

Time ns3::TcpSocketImpl::GetConnTimeout ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1628 of file tcp-socket-impl.cc.

References m_cnTimeout.

uint32_t ns3::TcpSocketImpl::GetDelAckMaxCount ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1664 of file tcp-socket-impl.cc.

References m_delAckMaxCount.

Time ns3::TcpSocketImpl::GetDelAckTimeout ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1652 of file tcp-socket-impl.cc.

References m_delAckTimeout.

enum Socket::SocketErrno ns3::TcpSocketImpl::GetErrno ( void   )  const [virtual]
Returns:
the errno associated to the last call which failed in this socket. Each socket's errno is initialized to zero when the socket is created.

Implements ns3::Socket.

Definition at line 210 of file tcp-socket-impl.cc.

References m_errno, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::TcpSocketImpl::GetInitialCwnd ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1616 of file tcp-socket-impl.cc.

References m_initialCWnd.

Ptr< Node > ns3::TcpSocketImpl::GetNode ( void   )  const [virtual]
Returns:
the node this socket is associated with.

Implements ns3::Socket.

Definition at line 217 of file tcp-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::TcpSocketImpl::GetRcvBufSize ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1580 of file tcp-socket-impl.cc.

References m_rxBufMaxSize.

uint32_t ns3::TcpSocketImpl::GetRxAvailable ( void   )  const [virtual]

Return number of bytes which can be returned from one or multiple calls to Recv. Must be possible to call this method from the Recv callback.

Implements ns3::Socket.

Definition at line 551 of file tcp-socket-impl.cc.

References m_rxAvailable, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::TcpSocketImpl::GetSegSize ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1592 of file tcp-socket-impl.cc.

References m_segmentSize.

uint32_t ns3::TcpSocketImpl::GetSndBufSize ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1568 of file tcp-socket-impl.cc.

References m_sndBufSize.

int ns3::TcpSocketImpl::GetSockName ( Address address  )  const [virtual]
Returns:
the address name this socket is associated with.

Implements ns3::Socket.

Definition at line 578 of file tcp-socket-impl.cc.

References m_localAddress, m_localPort, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::TcpSocketImpl::GetSSThresh ( void   )  const [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1604 of file tcp-socket-impl.cc.

References m_ssThresh.

uint32_t ns3::TcpSocketImpl::GetTxAvailable ( void   )  const [virtual]

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

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

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

Implements ns3::Socket.

Definition at line 449 of file tcp-socket-impl.cc.

References m_firstPendingSequence, m_highestRxAck, m_pendingData, m_sndBufSize, NS_ASSERT, NS_LOG_FUNCTION_NOARGS, and ns3::PendingData::SizeFromSeq().

Referenced by CommonNewAck(), ProcessPacketAction(), and Send().

TypeId ns3::TcpSocketImpl::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::TcpSocketImpl.

No Attributes defined for this type.
Attributes defined in parent class ns3::TcpSocket:

  • SndBufSize: TcpSocket maximum transmit buffer size (bytes)
  • RcvBufSize: TcpSocket maximum receive buffer size (bytes)
  • SegmentSize: TCP maximum segment size in bytes (may be adjusted based on MTU discovery)
  • SlowStartThreshold: TCP slow start threshold (bytes)
  • InitialCwnd: TCP initial congestion window size (segments)
  • ConnTimeout: TCP retransmission timeout when opening connection (seconds)
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 3000000000ns
    • Flags: construct write read
  • ConnCount: Number of connection attempts (SYN retransmissions) before returning failure
  • DelAckTimeout: Timeout value for TCP delayed acks, in seconds
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 200000000ns
    • Flags: construct write read
  • DelAckCount: Number of packets to wait before sending a TCP ack

TraceSources defined for this type:

  • CongestionWindow: The TCP connection's congestion window

Reimplemented from ns3::TcpSocket.

Definition at line 47 of file tcp-socket-impl.cc.

References m_cWnd, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

void ns3::TcpSocketImpl::LastAckTimeout (  )  [private]
int ns3::TcpSocketImpl::Listen ( void   )  [virtual]

Listen for incoming connections.

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

Implements ns3::Socket.

Definition at line 466 of file tcp-socket-impl.cc.

References ns3::APP_LISTEN, ns3::CLOSED, ns3::Socket::ERROR_INVAL, m_errno, m_state, NS_LOG_FUNCTION, ProcessAction(), and ProcessEvent().

void ns3::TcpSocketImpl::NewAck ( SequenceNumber  seq  )  [private]
void ns3::TcpSocketImpl::NewRx ( Ptr< Packet p,
const TcpHeader tcpHeader,
const Address fromAddress 
) [private]
void ns3::TcpSocketImpl::PersistTimeout (  )  [private]
bool ns3::TcpSocketImpl::ProcessAction ( Actions_t  a,
const TcpHeader tcpHeader,
Ipv4Address  saddr,
Ipv4Address  daddr 
) [private]
bool ns3::TcpSocketImpl::ProcessAction ( Actions_t  a  )  [private]
Actions_t ns3::TcpSocketImpl::ProcessEvent ( Events_t  e  )  [private]
bool ns3::TcpSocketImpl::ProcessPacketAction ( Actions_t  a,
Ptr< Packet p,
const TcpHeader tcpHeader,
const Address fromAddress 
) [private]
Ptr< Packet > ns3::TcpSocketImpl::Recv ( uint32_t  maxSize,
uint32_t  flags 
) [virtual]

Read data from the socket.

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

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

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

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

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

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

Parameters:
maxSize reader will accept packet up to maxSize
flags Socket control flags
Returns:
Ptr<Packet> of the next in-sequence packet. Returns 0 if the socket cannot return a next in-sequence packet conforming to the maxSize and flags.
See also:
SetRecvCallback

Implements ns3::Socket.

Definition at line 481 of file tcp-socket-impl.cc.

References ns3::CLOSE_WAIT, m_bufferedData, m_nextRxSequence, m_rxAvailable, m_rxBufSize, m_state, ns3::Now(), NS_LOG_FUNCTION_NOARGS, and NS_LOG_LOGIC.

Ptr< Packet > ns3::TcpSocketImpl::RecvFrom ( uint32_t  maxSize,
uint32_t  flags,
Address fromAddress 
) [virtual]

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

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

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

Parameters:
maxSize reader will accept packet up to maxSize
flags Socket control flags
fromAddress output parameter that will return the address of the sender of the received packet, if any. Remains untouched if no packet is received.
Returns:
Ptr<Packet> of the next in-sequence packet. Returns 0 if the socket cannot return a next in-sequence packet.

Implements ns3::Socket.

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

References ns3::SocketAddressTag::GetAddress(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::Socket::Recv().

void ns3::TcpSocketImpl::Retransmit (  )  [private]
void ns3::TcpSocketImpl::ReTxTimeout (  )  [private]
uint32_t ns3::TcpSocketImpl::RxBufferFreeSpace (  )  [private]

Definition at line 1088 of file tcp-socket-impl.cc.

References m_rxBufMaxSize, and m_rxBufSize.

Referenced by AdvertisedWindowSize(), and NewRx().

void ns3::TcpSocketImpl::RxBufFinishInsert ( SequenceNumber  seq  )  [private]

Definition at line 1292 of file tcp-socket-impl.cc.

References m_bufferedData, m_nextRxSequence, m_rxAvailable, and NS_ASSERT.

Referenced by NewRx().

int ns3::TcpSocketImpl::Send ( Ptr< Packet p,
uint32_t  flags 
) [virtual]

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

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

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

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

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

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

Parameters:
p ns3::Packet to send
flags Socket control flags
Returns:
the number of bytes accepted for transmission if no error occurs, and -1 otherwise.
See also:
SetSendCallback

Implements ns3::Socket.

Definition at line 367 of file tcp-socket-impl.cc.

References ns3::PendingData::Add(), ns3::APP_SEND, ns3::CLOSE_WAIT, ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_NOTCONN, ns3::ESTABLISHED, GetTxAvailable(), m_errno, m_firstPendingSequence, m_nextTxSequence, m_pendingData, m_state, NS_LOG_DEBUG, NS_LOG_FUNCTION, ProcessAction(), ProcessEvent(), ns3::PendingData::Size(), and ns3::SYN_SENT.

Referenced by SendTo().

void ns3::TcpSocketImpl::SendEmptyPacket ( uint8_t  flags  )  [private]
bool ns3::TcpSocketImpl::SendPendingData ( bool  withAck = false  )  [private]
int ns3::TcpSocketImpl::SendTo ( Ptr< Packet p,
uint32_t  flags,
const Address toAddress 
) [virtual]

Send data to a specified peer.

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

Parameters:
p packet to send
flags Socket control flags
toAddress IP Address of remote host
Returns:
-1 in case of error or the number of bytes copied in the internal buffer and accepted for transmission.

Implements ns3::Socket.

Definition at line 434 of file tcp-socket-impl.cc.

References ns3::Socket::ERROR_NOTCONN, m_connected, m_errno, NS_LOG_FUNCTION, and Send().

void ns3::TcpSocketImpl::SetConnCount ( uint32_t  count  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1634 of file tcp-socket-impl.cc.

References m_cnCount.

void ns3::TcpSocketImpl::SetConnTimeout ( Time  timeout  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1622 of file tcp-socket-impl.cc.

References m_cnTimeout.

void ns3::TcpSocketImpl::SetDelAckMaxCount ( uint32_t  count  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1658 of file tcp-socket-impl.cc.

References m_delAckMaxCount.

void ns3::TcpSocketImpl::SetDelAckTimeout ( Time  timeout  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1646 of file tcp-socket-impl.cc.

References m_delAckTimeout.

void ns3::TcpSocketImpl::SetInitialCwnd ( uint32_t  cwnd  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1610 of file tcp-socket-impl.cc.

References m_initialCWnd.

void ns3::TcpSocketImpl::SetNode ( Ptr< Node node  ) 

Definition at line 190 of file tcp-socket-impl.cc.

References m_cWnd, m_initialCWnd, m_node, and m_segmentSize.

void ns3::TcpSocketImpl::SetRcvBufSize ( uint32_t  size  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1574 of file tcp-socket-impl.cc.

References m_rxBufMaxSize.

void ns3::TcpSocketImpl::SetRtt ( Ptr< RttEstimator rtt  ) 

Definition at line 203 of file tcp-socket-impl.cc.

References m_rtt.

void ns3::TcpSocketImpl::SetSegSize ( uint32_t  size  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1586 of file tcp-socket-impl.cc.

References m_segmentSize.

void ns3::TcpSocketImpl::SetSndBufSize ( uint32_t  size  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1562 of file tcp-socket-impl.cc.

References m_sndBufSize.

void ns3::TcpSocketImpl::SetSSThresh ( uint32_t  threshold  )  [private, virtual]

Implements ns3::TcpSocket.

Definition at line 1598 of file tcp-socket-impl.cc.

References m_ssThresh.

void ns3::TcpSocketImpl::SetTcp ( Ptr< TcpL4Protocol tcp  ) 

Definition at line 198 of file tcp-socket-impl.cc.

References m_tcp.

int ns3::TcpSocketImpl::ShutdownRecv ( void   )  [virtual]
Returns:
zero on success, -1 on failure.

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

Implements ns3::Socket.

Definition at line 301 of file tcp-socket-impl.cc.

References m_shutdownRecv, and NS_LOG_FUNCTION_NOARGS.

int ns3::TcpSocketImpl::ShutdownSend ( void   )  [virtual]
Returns:
zero on success, -1 on failure.

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

Implements ns3::Socket.

Definition at line 294 of file tcp-socket-impl.cc.

References m_shutdownSend, and NS_LOG_FUNCTION_NOARGS.

Referenced by Close().

uint32_t ns3::TcpSocketImpl::UnAckDataCount (  )  [private, virtual]

Definition at line 1057 of file tcp-socket-impl.cc.

References m_highestRxAck, m_nextTxSequence, and NS_LOG_FUNCTION_NOARGS.

Referenced by AvailableWindow().

uint32_t ns3::TcpSocketImpl::Window (  )  [private, virtual]

Friends And Related Function Documentation

friend class Tcp [friend]

Definition at line 100 of file tcp-socket-impl.h.


Member Data Documentation

Definition at line 206 of file tcp-socket-impl.h.

Referenced by NewRx(), Recv(), and RxBufFinishInsert().

Definition at line 190 of file tcp-socket-impl.h.

Referenced by LastAckTimeout(), NewRx(), and ProcessEvent().

Definition at line 192 of file tcp-socket-impl.h.

Referenced by Close(), Retransmit(), and SendPendingData().

Definition at line 191 of file tcp-socket-impl.h.

Referenced by ProcessPacketAction().

uint32_t ns3::TcpSocketImpl::m_cnCount [private]

Definition at line 236 of file tcp-socket-impl.h.

Referenced by GetConnCount(), Retransmit(), SendEmptyPacket(), and SetConnCount().

Definition at line 235 of file tcp-socket-impl.h.

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

Definition at line 186 of file tcp-socket-impl.h.

Referenced by ProcessEvent(), ProcessPacketAction(), and SendTo().

Definition at line 221 of file tcp-socket-impl.h.

Referenced by DupAck(), GetTypeId(), NewAck(), ReTxTimeout(), SendPendingData(), SetNode(), and Window().

Definition at line 171 of file tcp-socket-impl.h.

Referenced by DelAckTimeout(), and NewRx().

Definition at line 170 of file tcp-socket-impl.h.

Referenced by NewRx().

Definition at line 172 of file tcp-socket-impl.h.

Referenced by GetDelAckMaxCount(), NewRx(), and SetDelAckMaxCount().

Definition at line 173 of file tcp-socket-impl.h.

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

Definition at line 166 of file tcp-socket-impl.h.

Referenced by ProcessPacketAction().

Definition at line 183 of file tcp-socket-impl.h.

Referenced by Bind(), Connect(), DoSendTo(), GetErrno(), Listen(), Send(), SendPendingData(), and SendTo().

Definition at line 198 of file tcp-socket-impl.h.

Referenced by BytesInFlight(), and SendPendingData().

Definition at line 223 of file tcp-socket-impl.h.

Referenced by GetInitialCwnd(), SetInitialCwnd(), and SetNode().

Definition at line 168 of file tcp-socket-impl.h.

Referenced by LastAckTimeout(), and ProcessPacketAction().

Definition at line 232 of file tcp-socket-impl.h.

Referenced by ForwardUp().

Definition at line 200 of file tcp-socket-impl.h.

Definition at line 181 of file tcp-socket-impl.h.

Referenced by CompleteFork(), FinishBind(), GetSockName(), and ProcessPacketAction().

uint16_t ns3::TcpSocketImpl::m_localPort [private]

Definition at line 182 of file tcp-socket-impl.h.

Referenced by CompleteFork(), FinishBind(), and GetSockName().

Definition at line 193 of file tcp-socket-impl.h.

Referenced by NewRx(), and ProcessPacketAction().

Definition at line 227 of file tcp-socket-impl.h.

Referenced by CommonNewAck(), ForwardUp(), and PersistTimeout().

Definition at line 226 of file tcp-socket-impl.h.

Referenced by CommonNewAck(), and PersistTimeout().

Definition at line 208 of file tcp-socket-impl.h.

Referenced by GetRxAvailable(), NewRx(), Recv(), and RxBufFinishInsert().

Definition at line 240 of file tcp-socket-impl.h.

Referenced by GetRcvBufSize(), RxBufferFreeSpace(), and SetRcvBufSize().

uint32_t ns3::TcpSocketImpl::m_rxBufSize [private]

Definition at line 209 of file tcp-socket-impl.h.

Referenced by NewRx(), Recv(), and RxBufferFreeSpace().

Definition at line 220 of file tcp-socket-impl.h.

Referenced by CommonNewAck(), ForwardUp(), SendPendingData(), and Window().

Definition at line 185 of file tcp-socket-impl.h.

Referenced by ForwardUp(), and ShutdownRecv().

Definition at line 184 of file tcp-socket-impl.h.

Referenced by DoSendTo(), SendPendingData(), and ShutdownSend().

Definition at line 165 of file tcp-socket-impl.h.

Definition at line 239 of file tcp-socket-impl.h.

Referenced by GetSndBufSize(), GetTxAvailable(), and SetSndBufSize().

uint32_t ns3::TcpSocketImpl::m_ssThresh [private]

Definition at line 222 of file tcp-socket-impl.h.

Referenced by DupAck(), GetSSThresh(), NewAck(), ReTxTimeout(), and SetSSThresh().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:51 2009 for NS-3 by  doxygen 1.6.3