(abstract) base class of all UdpSockets More...
#include "udp-socket.h"
Public Member Functions | |
UdpSocket () | |
~UdpSocket () override | |
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 () | |
~Socket () override | |
virtual int | Bind ()=0 |
Allocate a local IPv4 endpoint for this socket. | |
virtual int | Bind (const Address &address)=0 |
Allocate a local 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 ()=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 Socket::SocketErrno | GetErrno () const =0 |
Get last error number. | |
uint8_t | GetIpTos () const |
Query the value of IP Type of Service of this socket. | |
virtual uint8_t | GetIpTtl () const |
Query the value of IP Time to Live field of this socket. | |
virtual uint8_t | GetIpv6HopLimit () const |
Query the value of IP Hop Limit field of this socket. | |
uint8_t | GetIpv6Tclass () const |
Query the value of IPv6 Traffic Class field of this socket. | |
virtual Ptr< Node > | GetNode () const =0 |
Return the node this socket is associated with. | |
virtual int | GetPeerName (Address &address) const =0 |
Get the peer address of a connected socket. | |
uint8_t | GetPriority () const |
Query the priority value of this socket. | |
virtual uint32_t | GetRxAvailable () const =0 |
Return number of bytes which can be returned from one or multiple calls to Recv. | |
virtual Socket::SocketType | GetSocketType () const =0 |
virtual int | GetSockName (Address &address) const =0 |
Get socket address. | |
virtual uint32_t | GetTxAvailable () const =0 |
Returns the number of bytes which can be sent in a single call to Send. | |
virtual void | Ipv6JoinGroup (Ipv6Address address) |
Joins a IPv6 multicast group without filters. | |
virtual void | Ipv6JoinGroup (Ipv6Address address, Ipv6MulticastFilterMode filterMode, std::vector< Ipv6Address > sourceAddresses) |
Joins a IPv6 multicast group. | |
virtual void | Ipv6LeaveGroup () |
Leaves IPv6 multicast group this socket is joined to. | |
bool | IsIpRecvTos () const |
Ask if the socket is currently passing information about IP Type of Service up the stack. | |
bool | IsIpRecvTtl () const |
Ask if the socket is currently passing information about IP_TTL up the stack. | |
bool | IsIpv6RecvHopLimit () const |
Ask if the socket is currently passing information about IPv6 Hop Limit up the stack. | |
bool | IsIpv6RecvTclass () const |
Ask if the socket is currently passing information about IPv6 Traffic Class up the stack. | |
bool | IsRecvPktInfo () const |
Get status indicating whether enable/disable packet information to socket. | |
virtual int | Listen ()=0 |
Listen for incoming connections. | |
Ptr< Packet > | Recv () |
Read a single packet from the socket. | |
virtual Ptr< Packet > | Recv (uint32_t maxSize, uint32_t flags)=0 |
Read data from the socket. | |
int | Recv (uint8_t *buf, uint32_t size, uint32_t flags) |
Recv data (or dummy data) from the remote host. | |
Ptr< Packet > | RecvFrom (Address &fromAddress) |
Read a single packet from the socket and retrieve the sender address. | |
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. | |
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. | |
int | Send (const uint8_t *buf, uint32_t size, uint32_t flags) |
Send data (or dummy data) to the remote host. | |
int | Send (Ptr< Packet > p) |
Send data (or dummy data) to the remote host. | |
virtual int | Send (Ptr< Packet > p, uint32_t flags)=0 |
Send data (or dummy data) to the remote host. | |
int | SendTo (const uint8_t *buf, uint32_t size, uint32_t flags, const Address &address) |
Send data to a specified peer. | |
virtual int | SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0 |
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 | SetIpRecvTos (bool ipv4RecvTos) |
Tells a socket to pass information about IP Type of Service up the stack. | |
void | SetIpRecvTtl (bool ipv4RecvTtl) |
Tells a socket to pass information about IP_TTL up the stack. | |
void | SetIpTos (uint8_t ipTos) |
Manually set IP Type of Service field. | |
virtual void | SetIpTtl (uint8_t ipTtl) |
Manually set IP Time to Live field. | |
virtual void | SetIpv6HopLimit (uint8_t ipHopLimit) |
Manually set IPv6 Hop Limit. | |
void | SetIpv6RecvHopLimit (bool ipv6RecvHopLimit) |
Tells a socket to pass information about IPv6 Hop Limit up the stack. | |
void | SetIpv6RecvTclass (bool ipv6RecvTclass) |
Tells a socket to pass information about IPv6 Traffic Class up the stack. | |
void | SetIpv6Tclass (int ipTclass) |
Manually set IPv6 Traffic Class field. | |
void | SetPriority (uint8_t priority) |
Manually set the socket priority. | |
void | SetRecvCallback (Callback< void, Ptr< Socket > > receivedData) |
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 ()=0 |
virtual int | ShutdownSend ()=0 |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
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. | |
static TypeId | GetTypeId () |
Get the type ID. | |
static uint8_t | IpTos2Priority (uint8_t ipTos) |
Return the priority corresponding to a given TOS value. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Member Functions | |
virtual int32_t | GetIpMulticastIf () const =0 |
Get the IP multicast interface. | |
virtual bool | GetIpMulticastLoop () const =0 |
Get the IP multicast loop capability. | |
virtual uint8_t | GetIpMulticastTtl () const =0 |
Get the IP multicast TTL. | |
virtual bool | GetMtuDiscover () const =0 |
Get the MTU discover capability. | |
virtual uint32_t | GetRcvBufSize () const =0 |
Get the receiving buffer size. | |
virtual void | SetIpMulticastIf (int32_t ipIf)=0 |
Set the IP multicast interface. | |
virtual void | SetIpMulticastLoop (bool loop)=0 |
Set the IP multicast loop capability. | |
virtual void | SetIpMulticastTtl (uint8_t ipTtl)=0 |
Set the IP multicast TTL. | |
virtual void | SetMtuDiscover (bool discover)=0 |
Set the MTU discover capability. | |
virtual void | SetRcvBufSize (uint32_t size)=0 |
Set the receiving buffer size. | |
Additional Inherited Members | |
Public Types inherited from ns3::Socket | |
enum | Ipv6MulticastFilterMode { INCLUDE = 1 , EXCLUDE } |
Enumeration of the possible filter of a socket. More... | |
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 | SocketPriority { NS3_PRIO_BESTEFFORT = 0 , NS3_PRIO_FILLER = 1 , NS3_PRIO_BULK = 2 , NS3_PRIO_INTERACTIVE_BULK = 4 , NS3_PRIO_INTERACTIVE = 6 , NS3_PRIO_CONTROL = 7 } |
Enumeration of the possible socket priorities. 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 | |
void | DoDispose () override |
Destructor implementation. | |
bool | IsManualIpTtl () const |
Checks if the socket has a specific IPv4 TTL set. | |
bool | IsManualIpv6HopLimit () const |
Checks if the socket has a specific IPv6 Hop Limit set. | |
bool | IsManualIpv6Tclass () const |
Checks if the socket has a specific IPv6 Tclass set. | |
void | NotifyConnectionFailed () |
Notify through the callback (if set) that the connection has not been established due to an error. | |
bool | NotifyConnectionRequest (const Address &from) |
Notify through the callback (if set) that an incoming connection is being requested by a remote host. | |
void | NotifyConnectionSucceeded () |
Notify through the callback (if set) that the connection has been established. | |
void | NotifyDataRecv () |
Notify through the callback (if set) that some data have been received. | |
void | NotifyDataSent (uint32_t size) |
Notify through the callback (if set) that some data have been sent. | |
void | NotifyErrorClose () |
Notify through the callback (if set) that the connection has been closed due to an error. | |
void | NotifyNewConnectionCreated (Ptr< Socket > socket, const Address &from) |
Notify through the callback (if set) that a new connection has been created. | |
void | NotifyNormalClose () |
Notify through the callback (if set) that the connection has been closed. | |
void | NotifySend (uint32_t spaceAvailable) |
Notify through the callback (if set) that some data have been sent. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Protected Attributes inherited from ns3::Socket | |
Ptr< NetDevice > | m_boundnetdevice |
the device this socket is bound to (might be null). | |
Ipv6Address | m_ipv6MulticastGroupAddress |
IPv6 multicast group address. | |
bool | m_recvPktInfo |
if the socket should add packet info tags to the packet forwarded to L4. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
(abstract) base class of all UdpSockets
Introspection did not find any typical Config paths.
This class exists solely for hosting UdpSocket attributes that can be reused across different implementations, and for declaring UDP-specific multicast API.
No TraceSources are defined for this type.
Group: Internet
Size of this type is 176 bytes (on a 64-bit architecture).
Definition at line 36 of file udp-socket.h.
ns3::UdpSocket::UdpSocket | ( | ) |
Definition at line 71 of file udp-socket.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 76 of file udp-socket.cc.
References NS_LOG_FUNCTION.
|
privatepure virtual |
Get the IP multicast interface.
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Get the IP multicast loop capability.
This means that the socket will receive the packets sent by itself on a multicast address. Equivalent to setsockopt IP_MULTICAST_LOOP
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Get the IP multicast TTL.
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Get the MTU discover capability.
Implemented in ns3::UdpSocketImpl.
Referenced by ns3::Ipv4::GetTypeId(), and GetTypeId().
|
privatepure virtual |
Get the receiving buffer size.
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
static |
Get the type ID.
Get the type ID.
Definition at line 26 of file udp-socket.cc.
References GetIpMulticastIf(), GetIpMulticastLoop(), GetIpMulticastTtl(), ns3::Socket::GetIpTtl(), GetMtuDiscover(), GetRcvBufSize(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeIntegerAccessor(), ns3::MakeIntegerChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetIpMulticastIf(), SetIpMulticastLoop(), SetIpMulticastTtl(), ns3::Socket::SetIpTtl(), SetMtuDiscover(), ns3::TypeId::SetParent(), and SetRcvBufSize().
|
pure virtual |
Corresponds to socket option MCAST_JOIN_GROUP.
interface | interface number, or 0 |
groupAddress | multicast group address |
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.
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.
Referenced by Ipv4DeduplicationTest::DoRun().
|
pure virtual |
Corresponds to socket option MCAST_LEAVE_GROUP.
interface | interface number, or 0 |
groupAddress | multicast group address |
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.
Implemented in ns3::UdpSocketImpl.
|
privatepure virtual |
Set the IP multicast interface.
ipIf | the IP multicast interface |
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Set the IP multicast loop capability.
This means that the socket will receive the packets sent by itself on a multicast address. Equivalent to setsockopt IP_MULTICAST_LOOP
loop | the IP multicast loop capability |
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Set the IP multicast TTL.
ipTtl | the IP multicast TTL |
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().
|
privatepure virtual |
Set the MTU discover capability.
discover | the MTU discover capability |
Implemented in ns3::UdpSocketImpl.
Referenced by ns3::Ipv4::GetTypeId(), and GetTypeId().
|
privatepure virtual |
Set the receiving buffer size.
size | the buffer size |
Implemented in ns3::UdpSocketImpl.
Referenced by GetTypeId().