Socket logic for the NSC TCP sockets. More...
#include <nsc-tcp-socket-impl.h>
Public Member Functions | |
NscTcpSocketImpl () | |
NscTcpSocketImpl (const NscTcpSocketImpl &sock) | |
virtual | ~NscTcpSocketImpl () |
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 int | Close (void) |
Close a socket. More... | |
virtual int | Connect (const Address &address) |
Initiate a connection to a remote host. More... | |
virtual bool | GetAllowBroadcast () const |
Query whether broadcast datagram transmissions are allowed. More... | |
virtual enum SocketErrno | GetErrno (void) const |
virtual Ptr< Node > | GetNode (void) const |
virtual uint32_t | GetRxAvailable (void) const |
virtual enum SocketType | GetSocketType (void) const |
virtual int | GetSockName (Address &address) const |
virtual uint32_t | GetTxAvailable (void) const |
Returns the number of bytes which can be sent in a single call to Send. More... | |
virtual int | Listen (void) |
Listen for incoming connections. More... | |
virtual Ptr< Packet > | Recv (uint32_t maxSize, uint32_t flags) |
Read data from the socket. More... | |
virtual Ptr< Packet > | RecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress) |
Read a single packet from the socket and retrieve the sender address. More... | |
virtual int | Send (Ptr< Packet > p, uint32_t flags) |
Send data (or dummy data) to the remote host. More... | |
virtual int | SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress) |
Send data to a specified peer. More... | |
virtual bool | SetAllowBroadcast (bool allowBroadcast) |
Configure whether broadcast datagram transmissions are allowed. More... | |
void | SetNode (Ptr< Node > node) |
void | SetTcp (Ptr< NscTcpL4Protocol > tcp) |
virtual int | ShutdownRecv (void) |
virtual int | ShutdownSend (void) |
Public Member Functions inherited from ns3::Socket | |
virtual void | BindToNetDevice (Ptr< NetDevice > netdevice) |
Bind a socket to specific device. More... | |
Ptr< NetDevice > | GetBoundNetDevice () |
Returns socket's bound netdevice, if any. More... | |
uint8_t | GetIpTos (void) const |
virtual uint8_t | GetIpTtl (void) const |
virtual uint8_t | GetIpv6HopLimit (void) const |
uint8_t | GetIpv6Tclass (void) const |
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) |
virtual void | SetIpTtl (uint8_t ipTtl) |
virtual void | SetIpv6HopLimit (uint8_t ipHopLimit) |
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) |
void | SetRecvCallback (Callback< void, Ptr< Socket > >) |
Notify application when new data is available to be read. More... | |
void | SetRecvPktInfo (bool flag) |
Enable/Disable receive packet information to socket. More... | |
void | SetSendCallback (Callback< void, Ptr< Socket >, uint32_t > sendCb) |
Notify application when space in transmit buffer is added. More... | |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
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) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
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) |
Static Public Member Functions inherited from ns3::TcpSocket | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Socket | |
static Ptr< Socket > | CreateSocket (Ptr< Node > node, TypeId tid) |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Private Member Functions | |
bool | Accept (void) |
void | CompleteFork (void) |
void | ConnectionSucceeded () |
Ptr< NscTcpSocketImpl > | Copy () |
void | Destroy (void) |
int | FinishBind (void) |
void | ForwardUp (Ptr< Packet > p, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface) |
virtual uint32_t | GetAdvWin (void) const |
virtual uint32_t | GetConnCount (void) const |
virtual Time | GetConnTimeout (void) const |
virtual uint32_t | GetDelAckMaxCount (void) const |
virtual Time | GetDelAckTimeout (void) const |
virtual uint32_t | GetInitialCwnd (void) const |
enum Socket::SocketErrno | GetNativeNs3Errno (int err) const |
virtual Time | GetPersistTimeout (void) const |
virtual uint32_t | GetRcvBufSize (void) const |
virtual uint32_t | GetSegSize (void) const |
virtual uint32_t | GetSndBufSize (void) const |
virtual uint32_t | GetSSThresh (void) const |
virtual bool | GetTcpNoDelay (void) const |
void | NSCWakeup (void) |
bool | ReadPendingData (void) |
bool | SendPendingData (void) |
virtual void | SetAdvWin (uint32_t window) |
virtual void | SetConnCount (uint32_t count) |
virtual void | SetConnTimeout (Time timeout) |
virtual void | SetDelAckMaxCount (uint32_t count) |
virtual void | SetDelAckTimeout (Time timeout) |
virtual void | SetInitialCwnd (uint32_t cwnd) |
virtual void | SetPersistTimeout (Time timeout) |
virtual void | SetRcvBufSize (uint32_t size) |
virtual void | SetSegSize (uint32_t size) |
virtual void | SetSndBufSize (uint32_t size) |
virtual void | SetSSThresh (uint32_t threshold) |
virtual void | SetTcpNoDelay (bool noDelay) |
Private Attributes | |
uint32_t | m_advertisedWindowSize |
bool | m_closeOnEmpty |
uint32_t | m_cnCount |
Time | m_cnTimeout |
bool | m_connected |
TracedValue< uint32_t > | m_cWnd |
uint32_t | m_delAckMaxCount |
Time | m_delAckTimeout |
std::queue< Ptr< Packet > > | m_deliveryQueue |
Ipv4EndPoint * | m_endPoint |
enum SocketErrno | m_errno |
uint32_t | m_initialCWnd |
Time | m_lastMeasuredRtt |
Ipv4Address | m_localAddress |
uint16_t | m_localPort |
Ptr< Node > | m_node |
bool | m_noDelay |
INetStreamSocket * | m_nscTcpSocket |
InetSocketAddress | m_peerAddress |
Time | m_persistTimeout |
uint32_t | m_rcvBufSize |
Ipv4Address | m_remoteAddress |
uint16_t | m_remotePort |
uint32_t | m_rxAvailable |
uint32_t | m_rxWindowSize |
uint32_t | m_segmentSize |
bool | m_shutdownRecv |
bool | m_shutdownSend |
uint32_t | m_sndBufSize |
uint32_t | m_ssThresh |
TracedValue< TcpStates_t > | m_state |
Ptr< NscTcpL4Protocol > | m_tcp |
std::queue< Ptr< Packet > > | m_txBuffer |
uint32_t | m_txBufferSize |
Friends | |
class | Tcp |
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 } |
enum | SocketType { NS3_SOCK_STREAM, NS3_SOCK_SEQPACKET, NS3_SOCK_DGRAM, NS3_SOCK_RAW } |
Static Public Attributes inherited from ns3::TcpSocket | |
static const char *const | TcpStateName [LAST_STATE] = { "CLOSED", "LISTEN", "SYN_SENT", "SYN_RCVD", "ESTABLISHED", "CLOSE_WAIT", "LAST_ACK", "FIN_WAIT_1", "FIN_WAIT_2", "CLOSING", "TIME_WAIT" } |
Protected Member Functions inherited from ns3::Socket | |
virtual void | DoDispose (void) |
bool | IsManualIpTos (void) const |
bool | IsManualIpTtl (void) const |
bool | IsManualIpv6HopLimit (void) const |
bool | IsManualIpv6Tclass (void) const |
void | NotifyConnectionFailed (void) |
bool | NotifyConnectionRequest (const Address &from) |
void | NotifyConnectionSucceeded (void) |
void | NotifyDataRecv (void) |
void | NotifyDataSent (uint32_t size) |
void | NotifyErrorClose (void) |
void | NotifyNewConnectionCreated (Ptr< Socket > socket, const Address &from) |
void | NotifyNormalClose (void) |
void | NotifySend (uint32_t spaceAvailable) |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
Protected Attributes inherited from ns3::Socket | |
Ptr< NetDevice > | m_boundnetdevice |
bool | m_recvPktInfo |
Socket logic for the NSC TCP sockets.
Most of the TCP internal logic is handled by the NSC tcp library itself; this class maps ns3::Socket calls to the NSC TCP library.
Definition at line 53 of file nsc-tcp-socket-impl.h.
ns3::NscTcpSocketImpl::NscTcpSocketImpl | ( | ) |
Create an unbound tcp socket.
Definition at line 64 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION.
|
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 NscTcpSocketImpl::Destroy below will will zero the m_endPoint field.
Definition at line 127 of file nsc-tcp-socket-impl.cc.
References NS_ASSERT, and NS_LOG_FUNCTION.
|
virtual |
Allocate a local IPv4 endpoint for this socket.
Implements ns3::Socket.
Definition at line 210 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
Referenced by Connect().
|
virtual |
Allocate a local endpoint for this socket.
address | the address to try to allocate |
Implements ns3::Socket.
Definition at line 224 of file nsc-tcp-socket-impl.cc.
References ns3::InetSocketAddress::ConvertFrom(), ns3::Ipv4Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
virtual |
Allocate a local IPv6 endpoint for this socket.
Implements ns3::Socket.
Definition at line 217 of file nsc-tcp-socket-impl.cc.
References NS_LOG_LOGIC.
|
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 275 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION, NS_LOG_LOGIC, and ShutdownSend().
|
virtual |
Initiate a connection to a remote host.
address | Address of remote. |
Implements ns3::Socket.
Definition at line 299 of file nsc-tcp-socket-impl.cc.
References Bind(), ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::GetPort(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::Ipv4Address::Print().
|
virtual |
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 874 of file nsc-tcp-socket-impl.cc.
|
virtual |
Implements ns3::Socket.
Definition at line 167 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
Implements ns3::Socket.
Definition at line 180 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
|
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 472 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
|
virtual |
Implements ns3::Socket.
Definition at line 174 of file nsc-tcp-socket-impl.cc.
|
virtual |
address | the address name this socket is associated with. |
Implements ns3::Socket.
Definition at line 464 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
|
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 375 of file nsc-tcp-socket-impl.cc.
References NS_ASSERT, and NS_LOG_FUNCTION_NOARGS.
Referenced by Send().
|
virtual |
Listen for incoming connections.
Implements ns3::Socket.
Definition at line 390 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION.
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 424 of file nsc-tcp-socket-impl.cc.
References ns3::Packet::GetSize(), and NS_LOG_FUNCTION_NOARGS.
|
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 447 of file nsc-tcp-socket-impl.cc.
References NS_ASSERT, NS_LOG_FUNCTION, ns3::Packet::PeekPacketTag(), and ns3::Socket::Recv().
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 325 of file nsc-tcp-socket-impl.cc.
References ns3::Packet::GetSize(), GetTxAvailable(), NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by SendTo().
|
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 360 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION, and Send().
|
virtual |
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 864 of file nsc-tcp-socket-impl.cc.
|
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 267 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
|
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 260 of file nsc-tcp-socket-impl.cc.
References NS_LOG_FUNCTION_NOARGS.
Referenced by Close().