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

#include <tcp-socket.h>

Inheritance diagram for ns3::TcpSocket:

Collaboration diagram for ns3::TcpSocket:

Public Member Functions
	TcpSocket (void)

virtual	~TcpSocket (void)

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

virtual	~Socket (void)

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

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

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

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

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

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

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

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

virtual enum Socket::SocketErrno	GetErrno (void) const =0
	Get last error number. More...

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

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

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

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

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

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

virtual enum Socket::SocketType	GetSocketType (void) const =0

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

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

bool	IsIpRecvTos (void) const
	Ask if the socket is currently passing information about IP Type of Service up the stack. More...

bool	IsIpRecvTtl (void) const
	Ask if the socket is currently passing information about IP_TTL up the stack. More...

bool	IsIpv6RecvHopLimit (void) const
	Ask if the socket is currently passing information about IPv6 Hop Limit up the stack. More...

bool	IsIpv6RecvTclass (void) const
	Ask if the socket is currently passing information about IPv6 Traffic Class up the stack. More...

bool	IsRecvPktInfo () const
	Get status indicating whether enable/disable packet information to socket. More...

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

virtual Ptr< Packet >	Recv (uint32_t maxSize, uint32_t flags)=0
	Read data from the 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...

virtual Ptr< Packet >	RecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
	Read a single packet from the socket and retrieve the sender address. 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...

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

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

int	Send (const uint8_t *buf, uint32_t size, 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)=0
	Send data to a specified peer. 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...

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

void	SetCloseCallbacks (Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
	Detect socket recv() events such as graceful shutdown or error. More...

void	SetConnectCallback (Callback< void, Ptr< Socket > > connectionSucceeded, Callback< void, Ptr< Socket > > connectionFailed)
	Specify callbacks to allow the caller to determine if the connection succeeds of fails. More...

void	SetDataSentCallback (Callback< void, Ptr< Socket >, uint32_t > dataSent)
	Notify application when a packet has been sent from transport protocol (non-standard socket call) More...

void	SetIpRecvTos (bool ipv4RecvTos)
	Tells a socket to pass information about IP Type of Service up the stack. More...

void	SetIpRecvTtl (bool ipv4RecvTtl)
	Tells a socket to pass information about IP_TTL up the stack. More...

void	SetIpTos (uint8_t ipTos)
	Manually set IP Type of Service field. More...

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

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

void	SetIpv6RecvHopLimit (bool ipv6RecvHopLimit)
	Tells a socket to pass information about IPv6 Hop Limit up the stack. More...

void	SetIpv6RecvTclass (bool ipv6RecvTclass)
	Tells a socket to pass information about IPv6 Traffic Class up the stack. More...

void	SetIpv6Tclass (int ipTclass)
	Manually set IPv6 Traffic Class field. More...

void	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...

virtual int	ShutdownRecv (void)=0

virtual int	ShutdownSend (void)=0

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

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

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

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

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

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

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

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

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

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

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

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

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

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

Static Public Attributes
static const char *const	TcpStateName [LAST_STATE] = { "CLOSED", "LISTEN", "SYN_SENT", "SYN_RCVD", "ESTABLISHED", "CLOSE_WAIT", "LAST_ACK", "FIN_WAIT_1", "FIN_WAIT_2", "CLOSING", "TIME_WAIT" }
	Literal names of TCP states for use in log messages. More...

Private Member Functions
virtual uint32_t	GetConnCount (void) const =0
	Get the number of connection retries before giving up. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from ns3::Socket
enum	SocketErrno { ERROR_NOTERROR, ERROR_ISCONN, ERROR_NOTCONN, ERROR_MSGSIZE, ERROR_AGAIN, ERROR_SHUTDOWN, ERROR_OPNOTSUPP, ERROR_AFNOSUPPORT, ERROR_INVAL, ERROR_BADF, ERROR_NOROUTETOHOST, ERROR_NODEV, ERROR_ADDRNOTAVAIL, ERROR_ADDRINUSE, SOCKET_ERRNO_LAST }
	Enumeration of the possible errors returned by a socket. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

(abstract) base class of all TcpSockets

Doxygen introspection did not find any typical Config paths.

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

Attributes

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

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::TcpSocket::TcpSocket ( void )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::TcpSocket::~TcpSocket ( void )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

virtual uint32_t ns3::TcpSocket::GetConnCount ( void ) const

privatepure virtual

Get the number of connection retries before giving up.

Returns: the number of connection retries

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the connection timeout.

Returns: the connection timeout

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

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

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

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the time to delay an ACK.

Returns: the time to delay an ACK

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the initial Congestion Window.

Returns: the initial congestion window (in bytes)

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

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the timout for persistent connection.

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

Returns: the persistent timout

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the receive buffer size.

Returns: the buffer size (in bytes)

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the segment size.

Returns: the segment size (in bytes)

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the send buffer size.

Returns: the buffer size (in bytes)

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Get the Slow Start Threshold.

Returns: the Slow Start Threshold (in bytes)

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

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Check if Nagle's algorithm is enabled or not.

Returns: true if Nagle's algorithm is DISABLED

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::TcpSocket::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetConnCount(), GetConnTimeout(), GetDelAckMaxCount(), GetDelAckTimeout(), GetInitialCwnd(), GetPersistTimeout(), GetRcvBufSize(), GetSegSize(), GetSndBufSize(), GetSSThresh(), GetTcpNoDelay(), ns3::MakeTimeChecker(), SetConnCount(), SetConnTimeout(), SetDelAckMaxCount(), SetDelAckTimeout(), SetInitialCwnd(), ns3::TypeId::SetParent(), SetPersistTimeout(), SetRcvBufSize(), SetSegSize(), SetSndBufSize(), SetSSThresh(), and SetTcpNoDelay().

Here is the call graph for this function:

virtual void ns3::TcpSocket::SetConnCount ( uint32_t count )

privatepure virtual

Set the number of connection retries before giving up.

Parameters

count the number of connection retries

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Set the connection timeout.

Parameters

timeout the connection timeout

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

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

Parameters

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

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Set the time to delay an ACK.

Parameters

timeout the time to delay an ACK

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Set the initial Congestion Window.

Parameters

cwnd	the initial congestion window (in bytes)

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

Referenced by GetTypeId().

Here is the caller graph for this function:

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

privatepure virtual

Set the timout for persistent connection.

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

Parameters

timeout the persistent timout

Implemented in ns3::NscTcpSocketImpl, and ns3::TcpSocketBase.

Referenced by GetTypeId().

Here is the caller graph for this function: