A sockets interface to UDP. More...

#include <udp-socket-impl.h>

Inheritance diagram for ns3::UdpSocketImpl:

Collaboration diagram for ns3::UdpSocketImpl:

Public Member Functions
	UdpSocketImpl ()
virtual	~UdpSocketImpl ()
virtual int	Bind (void)
	Allocate a local IPv4 endpoint for this socket.
virtual int	Bind (const Address &address)
	Allocate a local endpoint for this socket.
virtual int	Bind6 (void)
	Allocate a local IPv6 endpoint for this socket.
virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device.
virtual int	Close (void)
	Close a socket.
virtual int	Connect (const Address &address)
	Initiate a connection to a remote host.
virtual bool	GetAllowBroadcast () const
	Query whether broadcast datagram transmissions are allowed.
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.
virtual int	Listen (void)
	Listen for incoming connections.
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.
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	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 bool	SetAllowBroadcast (bool allowBroadcast)
	Configure whether broadcast datagram transmissions are allowed.
void	SetNode (Ptr< Node > node)
void	SetUdp (Ptr< UdpL4Protocol > udp)
virtual int	ShutdownRecv (void)
virtual int	ShutdownSend (void)
Public Member Functions inherited from ns3::UdpSocket
	UdpSocket (void)
virtual	~UdpSocket (void)
Public Member Functions inherited from ns3::Socket
	Socket (void)
virtual	~Socket (void)
Ptr< NetDevice >	GetBoundNetDevice ()
	Returns socket's bound netdevice, if any.
bool	IsRecvPktInfo () const
	Get status indicating whether enable/disable packet information to 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.
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.
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.
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.
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.
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::UdpSocketImpl.

Private Member Functions
void	Destroy (void)
void	Destroy6 (void)
int	DoSend (Ptr< Packet > p)
int	DoSendTo (Ptr< Packet > p, const Address &daddr)
int	DoSendTo (Ptr< Packet > p, Ipv4Address daddr, uint16_t dport)
int	DoSendTo (Ptr< Packet > p, Ipv6Address daddr, uint16_t dport)
int	FinishBind (void)
void	ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
void	ForwardIcmp6 (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
void	ForwardUp (Ptr< Packet > p, Ipv4Header header, uint16_t port, Ptr< Ipv4Interface > incomingInterface)
void	ForwardUp6 (Ptr< Packet > p, Ipv6Address saddr, Ipv6Address daddr, uint16_t port)
virtual int32_t	GetIpMulticastIf (void) const
virtual bool	GetIpMulticastLoop (void) const
virtual uint8_t	GetIpMulticastTtl (void) const
virtual uint8_t	GetIpTtl (void) const
virtual bool	GetMtuDiscover (void) const
virtual uint32_t	GetRcvBufSize (void) const
virtual void	SetIpMulticastIf (int32_t ipIf)
virtual void	SetIpMulticastLoop (bool loop)
virtual void	SetIpMulticastTtl (uint8_t ipTtl)
virtual void	SetIpTtl (uint8_t ipTtl)
virtual void	SetMtuDiscover (bool discover)
virtual void	SetRcvBufSize (uint32_t size)

Private Attributes
bool	m_allowBroadcast
bool	m_connected
Address	m_defaultAddress
uint16_t	m_defaultPort
std::queue< Ptr< Packet > >	m_deliveryQueue
TracedCallback< Ptr< const Packet > >	m_dropTrace
Ipv4EndPoint *	m_endPoint
Ipv6EndPoint *	m_endPoint6
enum SocketErrno	m_errno
Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback
Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback6
int32_t	m_ipMulticastIf
bool	m_ipMulticastLoop
uint8_t	m_ipMulticastTtl
uint8_t	m_ipTtl
bool	m_mtuDiscover
Ptr< Node >	m_node
uint32_t	m_rcvBufSize
uint32_t	m_rxAvailable
bool	m_shutdownRecv
bool	m_shutdownSend
Ptr< UdpL4Protocol >	m_udp

Friends
class	UdpSocketFactory

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

A sockets interface to UDP.

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

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

Constructor & Destructor Documentation

ns3::UdpSocketImpl::UdpSocketImpl ( )

Create an unbound udp socket.

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

References m_allowBroadcast, and NS_LOG_FUNCTION_NOARGS.

ns3::UdpSocketImpl::~UdpSocketImpl ( )

virtual

Note: actually this function is called AFTER UdpSocketImpl::Destroy or UdpSocketImpl::Destroy6 so the code below is unnecessary in normal operations

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 UdpSocketImpl::Destroy below will will zero the m_endPoint field.

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

References ns3::UdpL4Protocol::DeAllocate(), m_endPoint, m_endPoint6, m_node, m_udp, NS_ASSERT, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

Member Function Documentation

int ns3::UdpSocketImpl::Bind ( void )

virtual

Allocate a local IPv4 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

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

References ns3::UdpL4Protocol::Allocate(), FinishBind(), m_endPoint, m_udp, and NS_LOG_FUNCTION_NOARGS.

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

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::UdpSocketImpl::Bind ( const Address & address )

virtual

Allocate a local endpoint for this socket.

Parameters

address the address to try to allocate

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

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

References ns3::UdpL4Protocol::Allocate(), ns3::UdpL4Protocol::Allocate6(), ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, FinishBind(), ns3::Ipv4Address::GetAny(), ns3::Ipv6Address::GetAny(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_endPoint, m_endPoint6, m_errno, m_udp, NS_LOG_ERROR, NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

int ns3::UdpSocketImpl::Bind6 ( void )

virtual

Allocate a local IPv6 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

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

References ns3::UdpL4Protocol::Allocate6(), FinishBind(), m_endPoint6, m_udp, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoSend(), and DoSendTo().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpSocketImpl::BindToNetDevice ( Ptr< NetDevice > netdevice )

virtual

Bind a socket to specific device.

This method corresponds to using setsockopt() SO_BINDTODEVICE of real network or BSD sockets. If set on a socket, this option will force packets to leave the bound device regardless of the device that IP routing would naturally choose. In the receive direction, only packets received from the bound interface will be delivered.

This option has no particular relationship to binding sockets to an address via Socket::Bind (). It is possible to bind sockets to a specific IP address on the bound interface by calling both Socket::Bind (address) and Socket::BindToNetDevice (device), but it is also possible to bind to mismatching device and address, even if the socket can not receive any packets as a result.

Parameters

netdevice Pointer to Netdevice of desired interface

Returns: nothing

Reimplemented from ns3::Socket.

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

References Bind(), ns3::Ipv4EndPoint::BindToNetDevice(), m_endPoint, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

int ns3::UdpSocketImpl::Close ( void )

virtual

Close a socket.

Returns: zero on success, -1 on failure.

After the Close call, the socket is no longer valid, and cannot safely be used for subsequent operations.

Implements ns3::Socket.

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

References ns3::Socket::ERROR_BADF, m_errno, m_shutdownRecv, m_shutdownSend, and NS_LOG_FUNCTION_NOARGS.

int ns3::UdpSocketImpl::Connect ( const Address & address )

virtual

Initiate a connection to a remote host.

Parameters

address Address of remote.

Implements ns3::Socket.

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_connected, m_defaultAddress, m_defaultPort, ns3::Socket::NotifyConnectionSucceeded(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::UdpSocketImpl::Destroy ( void )

private

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

References m_endPoint, and NS_LOG_FUNCTION_NOARGS.

Referenced by FinishBind().

Here is the caller graph for this function:

void ns3::UdpSocketImpl::Destroy6 ( void )

private

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

References m_endPoint6, and NS_LOG_FUNCTION_NOARGS.

Referenced by FinishBind().

Here is the caller graph for this function:

int ns3::UdpSocketImpl::DoSend ( Ptr< Packet > p )

private

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

References Bind(), Bind6(), DoSendTo(), ns3::Socket::ERROR_SHUTDOWN, ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), m_defaultAddress, m_endPoint, m_endPoint6, m_errno, m_shutdownSend, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::UdpSocketImpl::DoSendTo	(	Ptr< Packet >	p,
		const Address &	daddr
	)

private

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

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::ERROR_AFNOSUPPORT, ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_connected, m_defaultAddress, m_defaultPort, m_errno, NS_LOG_FUNCTION, NS_LOG_LOGIC, and port.

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

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::UdpSocketImpl::DoSendTo	(	Ptr< Packet >	p,
		Ipv4Address	daddr,
		uint16_t	dport
	)

private

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

References ns3::Packet::AddPacketTag(), Bind(), ns3::Packet::Copy(), ns3::SocketSetDontFragmentTag::Disable(), ns3::SocketSetDontFragmentTag::Enable(), ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_OPNOTSUPP, ns3::Socket::ERROR_SHUTDOWN, ns3::Ipv4::GetAddress(), ns3::Ipv4Address::GetAny(), ns3::Ipv4InterfaceAddress::GetBroadcast(), ns3::Ipv4Header::GetDestination(), ns3::NetDevice::GetIfIndex(), ns3::Ipv4::GetInterfaceForDevice(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4EndPoint::GetLocalAddress(), ns3::Ipv4EndPoint::GetLocalPort(), ns3::Ipv4InterfaceAddress::GetMask(), ns3::Ipv4::GetNAddresses(), ns3::Ipv4::GetNetDevice(), ns3::Ipv4::GetNInterfaces(), ns3::Object::GetObject(), ns3::Ipv4Mask::GetOnes(), ns3::Ipv4Route::GetOutputDevice(), ns3::Ipv4::GetRoutingProtocol(), ns3::Packet::GetSize(), ns3::Ipv4Route::GetSource(), ns3::Ipv4Header::GetSource(), ns3::Ipv4Address::GetSubnetDirectedBroadcast(), GetTxAvailable(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsMulticast(), m_allowBroadcast, ns3::Socket::m_boundnetdevice, m_endPoint, m_errno, m_ipMulticastTtl, m_ipTtl, m_mtuDiscover, m_node, m_shutdownSend, m_udp, ns3::Socket::NotifyDataSent(), ns3::Socket::NotifySend(), NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, port, ns3::UdpL4Protocol::PROT_NUMBER, ns3::Packet::RemovePacketTag(), ns3::Ipv4RoutingProtocol::RouteOutput(), ns3::UdpL4Protocol::Send(), ns3::Ipv4Header::SetDestination(), ns3::Ipv4Header::SetProtocol(), ns3::Ipv4Header::SetSource(), and ns3::SocketIpTtlTag::SetTtl().

Here is the call graph for this function:

int ns3::UdpSocketImpl::DoSendTo	(	Ptr< Packet >	p,
		Ipv6Address	daddr,
		uint16_t	dport
	)

private

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

References ns3::Packet::AddPacketTag(), Bind6(), ns3::Packet::Copy(), DoSendTo(), ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_SHUTDOWN, ns3::Ipv6Address::GetAny(), ns3::Ipv6Header::GetDestinationAddress(), ns3::NetDevice::GetIfIndex(), ns3::Ipv6Address::GetIpv4MappedAddress(), ns3::Ipv6EndPoint::GetLocalAddress(), ns3::Ipv6EndPoint::GetLocalPort(), ns3::Object::GetObject(), ns3::Ipv6::GetRoutingProtocol(), ns3::Packet::GetSize(), ns3::Ipv6Header::GetSourceAddress(), GetTxAvailable(), ns3::Ipv6Address::IsIpv4MappedAddress(), ns3::Ipv6Address::IsMulticast(), ns3::Socket::m_boundnetdevice, m_endPoint6, m_errno, m_ipMulticastTtl, m_ipTtl, m_node, m_shutdownSend, m_udp, ns3::Socket::NotifyDataSent(), ns3::Socket::NotifySend(), NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, port, ns3::UdpL4Protocol::PROT_NUMBER, ns3::Ipv6RoutingProtocol::RouteOutput(), ns3::UdpL4Protocol::Send(), ns3::Ipv6Header::SetDestinationAddress(), ns3::Ipv6Header::SetNextHeader(), ns3::Ipv6Header::SetSourceAddress(), and ns3::SocketIpTtlTag::SetTtl().

Here is the call graph for this function:

int ns3::UdpSocketImpl::FinishBind ( void )

private

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

References Destroy(), Destroy6(), ForwardIcmp(), ForwardIcmp6(), ForwardUp(), ForwardUp6(), m_endPoint, m_endPoint6, ns3::MakeCallback(), NS_LOG_FUNCTION_NOARGS, ns3::Ipv4EndPoint::SetDestroyCallback(), ns3::Ipv6EndPoint::SetDestroyCallback(), ns3::Ipv4EndPoint::SetIcmpCallback(), ns3::Ipv6EndPoint::SetIcmpCallback(), ns3::Ipv4EndPoint::SetRxCallback(), and ns3::Ipv6EndPoint::SetRxCallback().

Referenced by Bind(), and Bind6().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpSocketImpl::ForwardIcmp	(	Ipv4Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo
	)

private

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

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_icmpCallback, and NS_LOG_FUNCTION.

Referenced by FinishBind().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpSocketImpl::ForwardIcmp6	(	Ipv6Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo
	)

private

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

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_icmpCallback6, and NS_LOG_FUNCTION.

Referenced by FinishBind().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpSocketImpl::ForwardUp	(	Ptr< Packet >	p,
		Ipv4Header	header,
		uint16_t	port,
		Ptr< Ipv4Interface >	incomingInterface
	)

private

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

References ns3::Packet::AddPacketTag(), ns3::Ipv4Interface::GetDevice(), ns3::NetDevice::GetIfIndex(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), ns3::Socket::IsRecvPktInfo(), m_deliveryQueue, m_dropTrace, m_rcvBufSize, m_rxAvailable, m_shutdownRecv, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION, NS_LOG_WARN, port, ns3::Packet::RemovePacketTag(), ns3::SocketAddressTag::SetAddress(), and ns3::Ipv4PacketInfoTag::SetRecvIf().

Referenced by FinishBind().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UdpSocketImpl::ForwardUp6	(	Ptr< Packet >	p,
		Ipv6Address	saddr,
		Ipv6Address	daddr,
		uint16_t	port
	)

private

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

References ns3::Packet::AddPacketTag(), ns3::Packet::GetSize(), m_deliveryQueue, m_dropTrace, m_rcvBufSize, m_rxAvailable, m_shutdownRecv, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::SocketAddressTag::SetAddress().

Referenced by FinishBind().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::UdpSocketImpl::GetAllowBroadcast ( ) const

virtual

Query whether broadcast datagram transmissions are allowed.

This method corresponds to using getsockopt() SO_BROADCAST of real network or BSD sockets.

Returns: true if broadcast is allowed, false otherwise

Implements ns3::Socket.

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

References m_allowBroadcast.

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 145 of file udp-socket-impl.cc.

References m_errno, and NS_LOG_FUNCTION_NOARGS.

int32_t ns3::UdpSocketImpl::GetIpMulticastIf ( void ) const

privatevirtual

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

References m_ipMulticastIf.

bool ns3::UdpSocketImpl::GetIpMulticastLoop ( void ) const

privatevirtual

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

References m_ipMulticastLoop.

uint8_t ns3::UdpSocketImpl::GetIpMulticastTtl ( void ) const

privatevirtual

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

References m_ipMulticastTtl.

uint8_t ns3::UdpSocketImpl::GetIpTtl ( void ) const

privatevirtual

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

References m_ipTtl.

bool ns3::UdpSocketImpl::GetMtuDiscover ( void ) const

privatevirtual

Definition at line 1032 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 158 of file udp-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

uint32_t ns3::UdpSocketImpl::GetRcvBufSize ( void ) const

privatevirtual

Definition at line 973 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 755 of file udp-socket-impl.cc.

References m_rxAvailable, and NS_LOG_FUNCTION_NOARGS.

enum Socket::SocketType ns3::UdpSocketImpl::GetSocketType ( void ) const

virtual

Returns: the socket type, analogous to getsockopt (SO_TYPE)

Implements ns3::Socket.

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

References ns3::Socket::NS3_SOCK_DGRAM.

int ns3::UdpSocketImpl::GetSockName ( Address & address ) const

virtual

Parameters

address the address name this socket is associated with.

Returns: 0 if success, -1 otherwise

Implements ns3::Socket.

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

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

Here is the call graph for this function:

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 725 of file udp-socket-impl.cc.

References ns3::MAX_IPV4_UDP_DATAGRAM_SIZE, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoSendTo().

Here is the caller graph for this function:

TypeId ns3::UdpSocketImpl::GetTypeId ( void )

static

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

Attributes defined for this type:

IcmpCallback: Callback invoked whenever an icmp error is received on this socket.
- Set with class: CallbackValue
- Underlying type: Callback
- Initial value: 0
- Flags: construct write read
IcmpCallback6: Callback invoked whenever an icmpv6 error is received on this socket.
- Set with class: CallbackValue
- Underlying type: Callback
- Initial value: 0
- Flags: construct write read

Attributes defined in parent class ns3::UdpSocket:

RcvBufSize: UdpSocket maximum receive buffer size (bytes)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 131072
- Flags: construct write read
IpTtl: socket-specific TTL for unicast IP packets (if non-zero)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
IpMulticastTtl: socket-specific TTL for multicast IP packets (if non-zero)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
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

TraceSources defined for this type:

Drop: Drop UDP packet due to receive buffer overflow

Reimplemented from ns3::UdpSocket.

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

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

Here is the call graph for this function:

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 338 of file udp-socket-impl.cc.

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

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.

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

References NS_LOG_FUNCTION.

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.

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

References NS_LOG_FUNCTION.

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 764 of file udp-socket-impl.cc.

References ns3::Socket::ERROR_AGAIN, ns3::Packet::GetSize(), m_deliveryQueue, m_errno, m_rxAvailable, and NS_LOG_FUNCTION.

Here is the call graph for this 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 786 of file udp-socket-impl.cc.

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

Here is the call graph for this function:

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 345 of file udp-socket-impl.cc.

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

Here is the call graph for this 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 734 of file udp-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Inet6SocketAddress::ConvertFrom(), DoSendTo(), ns3::InetSocketAddress::GetIpv4(), ns3::Inet6SocketAddress::GetIpv6(), ns3::InetSocketAddress::GetPort(), ns3::Inet6SocketAddress::GetPort(), ns3::InetSocketAddress::IsMatchingType(), ns3::Inet6SocketAddress::IsMatchingType(), NS_LOG_FUNCTION, and port.

Here is the call graph for this function:

bool ns3::UdpSocketImpl::SetAllowBroadcast ( bool allowBroadcast )

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.

Parameters

allowBroadcast Whether broadcast is allowed