ns3::UdpSocketImpl Class Reference
[Udp]

A sockets interface to UDP. More...

#include <udp-socket-impl.h>

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

List of all members.

Public Member Functions

 UdpSocketImpl ()
virtual ~UdpSocketImpl ()
void SetNode (Ptr< Node > node)
void SetUdp (Ptr< UdpL4Protocol > udp)
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 &address)
 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::UdpSocket.

Private Member Functions

virtual void SetRcvBufSize (uint32_t size)
virtual uint32_t GetRcvBufSize (void) const
virtual void SetIpTtl (uint32_t ipTtl)
virtual uint32_t GetIpTtl (void) const
virtual void SetIpMulticastTtl (uint32_t ipTtl)
virtual uint32_t GetIpMulticastTtl (void) const
virtual void SetMtuDiscover (bool discover)
virtual bool GetMtuDiscover (void) const
int FinishBind (void)
void ForwardUp (Ptr< Packet > p, Ipv4Address ipv4, uint16_t port)
void Destroy (void)
int DoSend (Ptr< Packet > p)
int DoSendTo (Ptr< Packet > p, const Address &daddr)
int DoSendTo (Ptr< Packet > p, Ipv4Address daddr, uint16_t dport)
void ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)

Private Attributes

Ipv4EndPointm_endPoint
Ptr< Nodem_node
Ptr< UdpL4Protocolm_udp
Ipv4Address m_defaultAddress
uint16_t m_defaultPort
Callback< void, Ptr< Socket >
, uint32_t, const Address & > 
m_dummyRxCallback
Callback< void, Ptr< Socket >
, uint8_t const *, uint32_t,
const Address & > 
m_rxCallback
TracedCallback< Ptr< const
Packet > > 
m_dropTrace
enum SocketErrno m_errno
bool m_shutdownSend
bool m_shutdownRecv
bool m_connected
std::queue< Ptr< Packet > > m_deliveryQueue
uint32_t m_rxAvailable
uint32_t m_rcvBufSize
uint32_t m_ipTtl
uint32_t m_ipMulticastTtl
bool m_mtuDiscover
Callback< void, Ipv4Address,
uint8_t, uint8_t, uint8_t,
uint32_t > 
m_icmpCallback

Friends

class UdpSocketFactory

Detailed Description

A sockets interface to UDP.

This class subclasses ns3::UdpSocket, and provides a socket interface to ns3's implementation of UDP.

Definition at line 48 of file udp-socket-impl.h.


Constructor & Destructor Documentation

ns3::UdpSocketImpl::UdpSocketImpl (  ) 

Create an unbound udp socket.

Definition at line 56 of file udp-socket-impl.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::UdpSocketImpl::~UdpSocketImpl (  )  [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 69 of file udp-socket-impl.cc.

References m_endPoint, m_node, m_udp, NS_ASSERT, and NS_LOG_FUNCTION_NOARGS.


Member Function Documentation

int ns3::UdpSocketImpl::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 153 of file udp-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_udp, NS_LOG_ERROR, and NS_LOG_FUNCTION.

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

Allocate a local endpoint for this socket.

Returns:
0 on success, -1 on failure.

Implements ns3::Socket.

Definition at line 145 of file udp-socket-impl.cc.

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

Referenced by DoSend(), and DoSendTo().

int ns3::UdpSocketImpl::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 203 of file udp-socket-impl.cc.

References NS_LOG_FUNCTION_NOARGS.

int ns3::UdpSocketImpl::Connect ( const Address address  )  [virtual]
void ns3::UdpSocketImpl::Destroy ( void   )  [private]

Definition at line 122 of file udp-socket-impl.cc.

References m_endPoint, m_node, m_udp, and NS_LOG_FUNCTION_NOARGS.

Referenced by FinishBind().

int ns3::UdpSocketImpl::DoSend ( Ptr< Packet p  )  [private]
int ns3::UdpSocketImpl::DoSendTo ( Ptr< Packet p,
Ipv4Address  daddr,
uint16_t  dport 
) [private]
int ns3::UdpSocketImpl::DoSendTo ( Ptr< Packet p,
const Address daddr 
) [private]
int ns3::UdpSocketImpl::FinishBind ( void   )  [private]
void ns3::UdpSocketImpl::ForwardIcmp ( Ipv4Address  icmpSource,
uint8_t  icmpTtl,
uint8_t  icmpType,
uint8_t  icmpCode,
uint32_t  icmpInfo 
) [private]
void ns3::UdpSocketImpl::ForwardUp ( Ptr< Packet p,
Ipv4Address  ipv4,
uint16_t  port 
) [private]
enum Socket::SocketErrno ns3::UdpSocketImpl::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 108 of file udp-socket-impl.cc.

References m_errno, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::UdpSocketImpl::GetIpMulticastTtl ( void   )  const [private, virtual]

Implements ns3::UdpSocket.

Definition at line 571 of file udp-socket-impl.cc.

References m_ipMulticastTtl.

uint32_t ns3::UdpSocketImpl::GetIpTtl ( void   )  const [private, virtual]

Implements ns3::UdpSocket.

Definition at line 559 of file udp-socket-impl.cc.

References m_ipTtl.

bool ns3::UdpSocketImpl::GetMtuDiscover ( void   )  const [private, virtual]

Implements ns3::UdpSocket.

Definition at line 582 of file udp-socket-impl.cc.

References m_mtuDiscover.

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

Implements ns3::Socket.

Definition at line 115 of file udp-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

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

Implements ns3::UdpSocket.

Definition at line 547 of file udp-socket-impl.cc.

References m_rcvBufSize.

uint32_t ns3::UdpSocketImpl::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 433 of file udp-socket-impl.cc.

References m_rxAvailable, and NS_LOG_FUNCTION_NOARGS.

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

Implements ns3::Socket.

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

References ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv4Address::GetZero(), m_endPoint, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::UdpSocketImpl::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 414 of file udp-socket-impl.cc.

References ns3::MAX_IPV4_UDP_DATAGRAM_SIZE, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoSendTo().

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

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

Attributes defined for this type:

  • RcvBufSize: UdpSocket maximum receive buffer size (bytes)
  • IpTtl: socket-specific TTL for unicast IP packets (if non-zero)
  • IpMulticastTtl: socket-specific TTL for multicast IP packets (if non-zero)
  • MtuDiscover: If enabled, every outgoing ip packet will have the DF flag set.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::UdpSocket.

Definition at line 41 of file udp-socket-impl.cc.

References ns3::TypeId::AddAttribute(), ns3::TypeId::AddTraceSource(), m_dropTrace, m_icmpCallback, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

int ns3::UdpSocketImpl::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 223 of file udp-socket-impl.cc.

References ns3::Socket::ERROR_OPNOTSUPP, and m_errno.

Ptr< Packet > ns3::UdpSocketImpl::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 442 of file udp-socket-impl.cc.

References ns3::Socket::ERROR_AGAIN, m_deliveryQueue, m_errno, m_rxAvailable, and NS_LOG_FUNCTION.

Ptr< Packet > ns3::UdpSocketImpl::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 464 of file udp-socket-impl.cc.

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

int ns3::UdpSocketImpl::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 230 of file udp-socket-impl.cc.

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

int ns3::UdpSocketImpl::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 423 of file udp-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), DoSendTo(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::GetPort(), and NS_LOG_FUNCTION.

void ns3::UdpSocketImpl::SetIpMulticastTtl ( uint32_t  ipTtl  )  [private, virtual]

Implements ns3::UdpSocket.

Definition at line 565 of file udp-socket-impl.cc.

References m_ipMulticastTtl.

void ns3::UdpSocketImpl::SetIpTtl ( uint32_t  ipTtl  )  [private, virtual]

Implements ns3::UdpSocket.

Definition at line 553 of file udp-socket-impl.cc.

References m_ipTtl.

void ns3::UdpSocketImpl::SetMtuDiscover ( bool  discover  )  [private, virtual]

Implements ns3::UdpSocket.

Definition at line 577 of file udp-socket-impl.cc.

References m_mtuDiscover.

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

Definition at line 93 of file udp-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

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

Implements ns3::UdpSocket.

Definition at line 541 of file udp-socket-impl.cc.

References m_rcvBufSize.

void ns3::UdpSocketImpl::SetUdp ( Ptr< UdpL4Protocol udp  ) 

Definition at line 100 of file udp-socket-impl.cc.

References m_udp, and NS_LOG_FUNCTION_NOARGS.

int ns3::UdpSocketImpl::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 195 of file udp-socket-impl.cc.

References m_shutdownRecv, and NS_LOG_FUNCTION_NOARGS.

int ns3::UdpSocketImpl::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 187 of file udp-socket-impl.cc.

References m_shutdownSend, and NS_LOG_FUNCTION_NOARGS.


Friends And Related Function Documentation

friend class UdpSocketFactory [friend]

Definition at line 91 of file udp-socket-impl.h.


Member Data Documentation

Definition at line 115 of file udp-socket-impl.h.

Referenced by Connect(), DoSendTo(), and Send().

Definition at line 106 of file udp-socket-impl.h.

Referenced by Connect(), DoSend(), and DoSendTo().

Definition at line 107 of file udp-socket-impl.h.

Referenced by Connect(), DoSend(), and DoSendTo().

Definition at line 117 of file udp-socket-impl.h.

Referenced by ForwardUp(), and Recv().

Definition at line 110 of file udp-socket-impl.h.

Referenced by ForwardUp(), and GetTypeId().

Definition at line 108 of file udp-socket-impl.h.

Definition at line 103 of file udp-socket-impl.h.

Referenced by Bind(), Destroy(), DoSend(), DoSendTo(), FinishBind(), GetSockName(), and ~UdpSocketImpl().

Definition at line 112 of file udp-socket-impl.h.

Referenced by Bind(), DoSend(), DoSendTo(), GetErrno(), Listen(), Recv(), and Send().

Callback<void, Ipv4Address,uint8_t,uint8_t,uint8_t,uint32_t> ns3::UdpSocketImpl::m_icmpCallback [private]

Definition at line 125 of file udp-socket-impl.h.

Referenced by ForwardIcmp(), and GetTypeId().

Definition at line 123 of file udp-socket-impl.h.

Referenced by DoSendTo(), GetIpMulticastTtl(), and SetIpMulticastTtl().

uint32_t ns3::UdpSocketImpl::m_ipTtl [private]

Definition at line 122 of file udp-socket-impl.h.

Referenced by DoSendTo(), GetIpTtl(), and SetIpTtl().

Definition at line 124 of file udp-socket-impl.h.

Referenced by DoSendTo(), GetMtuDiscover(), and SetMtuDiscover().

Definition at line 104 of file udp-socket-impl.h.

Referenced by Destroy(), DoSendTo(), GetNode(), SetNode(), and ~UdpSocketImpl().

Definition at line 121 of file udp-socket-impl.h.

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

Definition at line 118 of file udp-socket-impl.h.

Referenced by ForwardUp(), GetRxAvailable(), and Recv().

Callback<void,Ptr<Socket>,uint8_t const*,uint32_t,const Address &> ns3::UdpSocketImpl::m_rxCallback [private]

Definition at line 109 of file udp-socket-impl.h.

Definition at line 114 of file udp-socket-impl.h.

Referenced by ForwardUp(), and ShutdownRecv().

Definition at line 113 of file udp-socket-impl.h.

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

Definition at line 105 of file udp-socket-impl.h.

Referenced by Bind(), Destroy(), DoSendTo(), SetUdp(), and ~UdpSocketImpl().


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