A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
ns3::UdpSocket Class Reference
Socket

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

#include <udp-socket.h>

+ Inheritance diagram for ns3::UdpSocket:
+ Collaboration diagram for ns3::UdpSocket:

Public Member Functions

 UdpSocket (void)
virtual ~UdpSocket (void)
virtual int MulticastJoinGroup (uint32_t interface, const Address &groupAddress)=0
 Corresponds to socket option MCAST_JOIN_GROUP.
virtual int MulticastLeaveGroup (uint32_t interface, const Address &groupAddress)=0
 Corresponds to socket option MCAST_LEAVE_GROUP.
- 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.
virtual int Bind ()=0
 Allocate a local IPv4 endpoint for this socket.
virtual int Bind6 ()=0
 Allocate a local IPv6 endpoint for this socket.
virtual void BindToNetDevice (Ptr< NetDevice > netdevice)
 Bind a socket to specific device.
virtual int Close (void)=0
 Close a socket.
virtual int Connect (const Address &address)=0
 Initiate a connection to a remote host.
virtual bool GetAllowBroadcast () const =0
 Query whether broadcast datagram transmissions are allowed.
Ptr< NetDevice > GetBoundNetDevice ()
 Returns socket's bound netdevice, if any.
virtual enum Socket::SocketErrno GetErrno (void) const =0
virtual Ptr< Node > GetNode (void) const =0
virtual uint32_t GetRxAvailable (void) const =0
virtual enum Socket::SocketType GetSocketType (void) const =0
virtual int GetSockName (Address &address) const =0
virtual uint32_t GetTxAvailable (void) const =0
 Returns the number of bytes which can be sent in a single call to Send.
bool IsRecvPktInfo () const
 Get status indicating whether enable/disable packet information to socket.
virtual int Listen (void)=0
 Listen for incoming connections.
virtual Ptr< Packet > Recv (uint32_t maxSize, uint32_t flags)=0
 Read data from the socket.
Ptr< Packet > Recv (void)
 Read a single packet from the socket.
int Recv (uint8_t *buf, uint32_t size, uint32_t flags)
 Recv data (or dummy data) from the remote host.
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.
Ptr< Packet > RecvFrom (Address &fromAddress)
 Read a single packet from the socket and retrieve the sender address.
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.
virtual int Send (Ptr< Packet > p, uint32_t flags)=0
 Send data (or dummy data) to the remote host.
int Send (Ptr< Packet > p)
 Send data (or dummy data) to the remote host.
int Send (const uint8_t *buf, uint32_t size, uint32_t flags)
 Send data (or dummy data) to the remote host.
virtual int SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
 Send data to a specified peer.
int SendTo (const uint8_t *buf, uint32_t size, uint32_t flags, const Address &address)
 Send data to a specified peer.
void SetAcceptCallback (Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
 Accept connection requests from remote hosts.
virtual bool SetAllowBroadcast (bool allowBroadcast)=0
 Configure whether broadcast datagram transmissions are allowed.
void SetCloseCallbacks (Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
 Detect socket recv() events such as graceful shutdown or error.
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.
void SetDataSentCallback (Callback< void, Ptr< Socket >, uint32_t > dataSent)
 Notify application when a packet has been sent from transport protocol (non-standard socket call)
void SetRecvCallback (Callback< void, Ptr< Socket > >)
 Notify application when new data is available to be read.
void SetRecvPktInfo (bool flag)
 Enable/Disable receive packet information to socket.
void SetSendCallback (Callback< void, Ptr< Socket >, uint32_t > sendCb)
 Notify application when space in transmit buffer is added.
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)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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
virtual ~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)
 This method returns the TypeId associated to ns3::UdpSocket.
- Static Public Member Functions inherited from ns3::Socket
static Ptr< Socket > CreateSocket (Ptr< Node > node, TypeId tid)

Private Member Functions

virtual int32_t GetIpMulticastIf (void) const =0
virtual bool GetIpMulticastLoop (void) const =0
virtual uint8_t GetIpMulticastTtl (void) const =0
virtual uint8_t GetIpTtl (void) const =0
virtual bool GetMtuDiscover (void) const =0
virtual uint32_t GetRcvBufSize (void) const =0
virtual void SetIpMulticastIf (int32_t ipIf)=0
virtual void SetIpMulticastLoop (bool loop)=0
virtual void SetIpMulticastTtl (uint8_t ipTtl)=0
virtual void SetIpTtl (uint8_t ipTtl)=0
virtual void SetMtuDiscover (bool discover)=0
virtual void SetRcvBufSize (uint32_t size)=0

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 }
- Protected Member Functions inherited from ns3::Socket
virtual void DoDispose (void)
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 Attributes inherited from ns3::Socket
Ptr< NetDevice > m_boundnetdevice
bool m_recvPktInfo

Detailed Description

(abstract) base class of all UdpSockets

This class exists solely for hosting UdpSocket attributes that can be reused across different implementations, and for declaring UDP-specific multicast API.

Definition at line 46 of file udp-socket.h.

Constructor & Destructor Documentation

ns3::UdpSocket::UdpSocket ( void  )

Definition at line 79 of file udp-socket.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::UdpSocket::~UdpSocket ( void  )
virtual

Definition at line 84 of file udp-socket.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

virtual int32_t ns3::UdpSocket::GetIpMulticastIf ( void  ) const
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual bool ns3::UdpSocket::GetIpMulticastLoop ( void  ) const
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual uint8_t ns3::UdpSocket::GetIpMulticastTtl ( void  ) const
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual uint8_t ns3::UdpSocket::GetIpTtl ( void  ) const
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual bool ns3::UdpSocket::GetMtuDiscover ( void  ) const
privatepure virtual

Referenced by GetTypeId(), ns3::Ipv4::GetTypeId(), and ns3::Ipv6::GetTypeId().

+ Here is the caller graph for this function:

virtual uint32_t ns3::UdpSocket::GetRcvBufSize ( void  ) const
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

TypeId ns3::UdpSocket::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::Socket.

Reimplemented in ns3::UdpSocketImpl.

Definition at line 36 of file udp-socket.cc.

References GetIpMulticastIf(), GetIpMulticastLoop(), GetIpMulticastTtl(), GetIpTtl(), GetMtuDiscover(), GetRcvBufSize(), SetIpMulticastIf(), SetIpMulticastLoop(), SetIpMulticastTtl(), SetIpTtl(), SetMtuDiscover(), ns3::TypeId::SetParent(), and SetRcvBufSize().

+ Here is the call graph for this function:

virtual int ns3::UdpSocket::MulticastJoinGroup ( uint32_t  interface,
const Address &  groupAddress 
)
pure virtual

Corresponds to socket option MCAST_JOIN_GROUP.

Parameters
interfaceinterface number, or 0
groupAddressmulticast 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.

Implemented in ns3::UdpSocketImpl.

virtual int ns3::UdpSocket::MulticastLeaveGroup ( uint32_t  interface,
const Address &  groupAddress 
)
pure virtual

Corresponds to socket option MCAST_LEAVE_GROUP.

Parameters
interfaceinterface number, or 0
groupAddressmulticast 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

Implemented in ns3::UdpSocketImpl.

virtual void ns3::UdpSocket::SetIpMulticastIf ( int32_t  ipIf)
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual void ns3::UdpSocket::SetIpMulticastLoop ( bool  loop)
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual void ns3::UdpSocket::SetIpMulticastTtl ( uint8_t  ipTtl)
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual void ns3::UdpSocket::SetIpTtl ( uint8_t  ipTtl)
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

virtual void ns3::UdpSocket::SetMtuDiscover ( bool  discover)
privatepure virtual

Referenced by GetTypeId(), ns3::Ipv4::GetTypeId(), and ns3::Ipv6::GetTypeId().

+ Here is the caller graph for this function:

virtual void ns3::UdpSocket::SetRcvBufSize ( uint32_t  size)
privatepure virtual

Referenced by GetTypeId().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: