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 enum SocketErrno GetErrno (void) const
virtual Ptr< Node > GetNode (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< Packet > Recv (uint32_t maxSize, uint32_t flags)
 Read data from the socket.
virtual Ptr< Packet > RecvFrom (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
virtual int MulticastJoinGroup (uint32_t interfaceIndex, const Address &groupAddress)
 Corresponds to socket option MCAST_JOIN_GROUP.
virtual int MulticastLeaveGroup (uint32_t interfaceIndex, const Address &groupAddress)
 Corresponds to socket option MCAST_LEAVE_GROUP.

Static Public Member Functions

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

Detailed Description

A sockets interface to UDP.

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

Constructor & Destructor Documentation

ns3::UdpSocketImpl::UdpSocketImpl (  ) 

Create an unbound udp socket.

Member Function Documentation

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

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

Allocate a local endpoint for this socket.

Returns:
0 on success, -1 on failure.

Implements ns3::Socket.

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

virtual int ns3::UdpSocketImpl::Connect ( const Address &  address  )  [virtual]

Initiate a connection to a remote host.

Parameters:
address Address of remote.

Implements ns3::Socket.

virtual enum 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.

virtual Ptr<Node> ns3::UdpSocketImpl::GetNode ( void   )  const [virtual]

Returns:
the node this socket is associated with.

Implements ns3::Socket.

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

virtual int ns3::UdpSocketImpl::GetSockName ( Address &  address  )  const [virtual]

Returns:
the address name this socket is associated with.

Implements ns3::Socket.

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

static 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)
  • IpMulticastIf: interface index for outgoing multicast on this socket; -1 indicates to use default interface
    • Set with class: ns3::IntegerValue
    • Underlying type: int32_t -2147483648:2147483647
    • Initial value: -1
    • Flags: construct write read
  • IpMulticastLoop: whether outgoing multicast sent also to loopback interface
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • 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.

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

virtual int ns3::UdpSocketImpl::MulticastJoinGroup ( uint32_t  interface,
const Address &  groupAddress 
) [virtual]

Corresponds to socket option MCAST_JOIN_GROUP.

Parameters:
interface interface number, or 0
groupAddress multicast group address
Returns:
on success, zero is returned. On error, -1 is returned, and errno is set appropriately
Enable reception of multicast datagrams for this socket on the interface number specified. If zero is specified as the interface, then a single local interface is chosen by system. In the future, this function will generate trigger IGMP joins as necessary when IGMP is implemented, but for now, this just enables multicast datagram reception in the system if not already enabled for this interface/groupAddress combination.

Attention:
IGMP is not yet implemented in ns-3
This function may be called repeatedly on a given socket but each join must be for a different multicast address, or for the same multicast address but on a different interface from previous joins. This enables host multihoming, and the ability to join the same group on different interfaces.

Implements ns3::UdpSocket.

virtual int ns3::UdpSocketImpl::MulticastLeaveGroup ( uint32_t  interface,
const Address &  groupAddress 
) [virtual]

Corresponds to socket option MCAST_LEAVE_GROUP.

Parameters:
interface interface number, or 0
groupAddress multicast group address
Returns:
on success, zero is returned. On error, -1 is returned, and errno is set appropriately
Disable reception of multicast datagrams for this socket on the interface number specified. If zero is specified as the interfaceIndex, then a single local interface is chosen by system. In the future, this function will generate trigger IGMP leaves as necessary when IGMP is implemented, but for now, this just disables multicast datagram reception in the system if this socket is the last for this interface/groupAddress combination.

Attention:
IGMP is not yet implemented in ns-3

Implements ns3::UdpSocket.

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

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

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

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

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

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

The documentation for this class was generated from the following file:
Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8