A low-level Socket API based loosely on the BSD Socket API.A few things to keep in mind about this type of socket: More...

#include <socket.h>

Inheritance diagram for ns3::Socket:

Public Types
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 }

Public Member Functions
virtual int	Bind (const Address &address)=0
	Allocate a local endpoint for this socket. More...

virtual int	Bind ()=0
	Allocate a local IPv4 endpoint for this socket. More...

virtual int	Bind6 ()=0
	Allocate a local IPv6 endpoint for this socket. More...

virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device. More...

virtual int	Close (void)=0
	Close a socket. More...

virtual int	Connect (const Address &address)=0
	Initiate a connection to a remote host. More...

virtual bool	GetAllowBroadcast () const =0
	Query whether broadcast datagram transmissions are allowed. More...

Ptr< NetDevice >	GetBoundNetDevice ()
	Returns socket's bound netdevice, if any. More...

virtual enum Socket::SocketErrno	GetErrno (void) const =0

uint8_t	GetIpTos (void) const

virtual uint8_t	GetIpTtl (void) const

virtual uint8_t	GetIpv6HopLimit (void) const

uint8_t	GetIpv6Tclass (void) const

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

bool	IsIpRecvTos (void) const
	Ask if the socket is currently passing information about IP Type of Service up the stack. More...

bool	IsIpRecvTtl (void) const
	Ask if the socket is currently passing information about IP_TTL up the stack. More...

bool	IsIpv6RecvHopLimit (void) const
	Ask if the socket is currently passing information about IPv6 Hop Limit up the stack. More...

bool	IsIpv6RecvTclass (void) const
	Ask if the socket is currently passing information about IPv6 Traffic Class up the stack. More...

bool	IsRecvPktInfo () const
	Get status indicating whether enable/disable packet information to socket. More...

virtual int	Listen (void)=0
	Listen for incoming connections. More...

virtual Ptr< Packet >	Recv (uint32_t maxSize, uint32_t flags)=0
	Read data from the socket. More...

Ptr< Packet >	Recv (void)
	Read a single packet from the socket. More...

int	Recv (uint8_t *buf, uint32_t size, uint32_t flags)
	Recv data (or dummy data) from the remote host. More...

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

Ptr< Packet >	RecvFrom (Address &fromAddress)
	Read a single packet from the socket and retrieve the sender address. More...

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

virtual int	Send (Ptr< Packet > p, uint32_t flags)=0
	Send data (or dummy data) to the remote host. More...

int	Send (Ptr< Packet > p)
	Send data (or dummy data) to the remote host. More...

int	Send (const uint8_t *buf, uint32_t size, uint32_t flags)
	Send data (or dummy data) to the remote host. More...

virtual int	SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
	Send data to a specified peer. More...

int	SendTo (const uint8_t *buf, uint32_t size, uint32_t flags, const Address &address)
	Send data to a specified peer. More...

void	SetAcceptCallback (Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
	Accept connection requests from remote hosts. More...

virtual bool	SetAllowBroadcast (bool allowBroadcast)=0
	Configure whether broadcast datagram transmissions are allowed. More...

void	SetCloseCallbacks (Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
	Detect socket recv() events such as graceful shutdown or error. More...

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

void	SetDataSentCallback (Callback< void, Ptr< Socket >, uint32_t > dataSent)
	Notify application when a packet has been sent from transport protocol (non-standard socket call) More...

void	SetIpRecvTos (bool ipv4RecvTos)
	Tells a socket to pass information about IP Type of Service up the stack. More...

void	SetIpRecvTtl (bool ipv4RecvTtl)
	Tells a socket to pass information about IP_TTL up the stack. More...

void	SetIpTos (uint8_t ipTos)

virtual void	SetIpTtl (uint8_t ipTtl)

virtual void	SetIpv6HopLimit (uint8_t ipHopLimit)

void	SetIpv6RecvHopLimit (bool ipv6RecvHopLimit)
	Tells a socket to pass information about IPv6 Hop Limit up the stack. More...

void	SetIpv6RecvTclass (bool ipv6RecvTclass)
	Tells a socket to pass information about IPv6 Traffic Class up the stack. More...

void	SetIpv6Tclass (int ipTclass)

void	SetRecvCallback (Callback< void, Ptr< Socket > >)
	Notify application when new data is available to be read. More...

void	SetRecvPktInfo (bool flag)
	Enable/Disable receive packet information to socket. More...

void	SetSendCallback (Callback< void, Ptr< Socket >, uint32_t > sendCb)
	Notify application when space in transmit buffer is added. More...

virtual int	ShutdownRecv (void)=0

virtual int	ShutdownSend (void)=0

Public Member Functions inherited from ns3::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	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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
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 Ptr< Socket >	CreateSocket (Ptr< Node > node, TypeId tid)

static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Protected Member Functions
virtual void	DoDispose (void)

bool	IsManualIpTos (void) const

bool	IsManualIpTtl (void) const

bool	IsManualIpv6HopLimit (void) const

bool	IsManualIpv6Tclass (void) const

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 Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Protected Attributes
Ptr< NetDevice >	m_boundnetdevice

bool	m_recvPktInfo

Private Attributes
Callback< void, Ptr< Socket > >	m_connectionFailed

Callback< bool, Ptr< Socket > , const Address & >	m_connectionRequest

Callback< void, Ptr< Socket > >	m_connectionSucceeded

Callback< void, Ptr< Socket > , uint32_t >	m_dataSent

Callback< void, Ptr< Socket > >	m_errorClose

bool	m_ipRecvTos

bool	m_ipRecvTtl

uint8_t	m_ipTos

uint8_t	m_ipTtl

uint8_t	m_ipv6HopLimit

bool	m_ipv6RecvHopLimit

bool	m_ipv6RecvTclass

uint8_t	m_ipv6Tclass

bool	m_manualIpTos

bool	m_manualIpTtl

bool	m_manualIpv6HopLimit

bool	m_manualIpv6Tclass

Callback< void, Ptr< Socket > , const Address & >	m_newConnectionCreated

Callback< void, Ptr< Socket > >	m_normalClose

Callback< void, Ptr< Socket > >	m_receivedData

Callback< void, Ptr< Socket > , uint32_t >	m_sendCb

Detailed Description

A low-level Socket API based loosely on the BSD Socket API.

A few things to keep in mind about this type of socket:

it uses ns-3 API constructs such as class ns3::Address instead of C-style structs
in contrast to the original BSD socket API, this API is asynchronous: it does not contain blocking calls. Sending and receiving operations must make use of the callbacks provided.
It also uses class ns3::Packet as a fancy byte buffer, allowing data to be passed across the API using an ns-3 Packet instead of a raw data pointer.
Not all of the full POSIX sockets API is supported

Other than that, it tries to stick to the BSD API to make it easier for those who know the BSD API to use this API. More details are provided in the ns-3 tutorial.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 66 of file socket.h.

Member Function Documentation

virtual int ns3::Socket::Bind ( const Address & address )

pure virtual

Allocate a local endpoint for this socket.

Parameters

address the address to try to allocate

Returns: 0 on success, -1 on failure.

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

virtual int ns3::Socket::Bind ( )

pure virtual

Allocate a local IPv4 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

virtual int ns3::Socket::Bind6 ( )

pure virtual

Allocate a local IPv6 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::UdpClient::StartApplication(), ns3::BulkSendApplication::StartApplication(), ns3::UdpTraceClient::StartApplication(), ns3::OnOffApplication::StartApplication(), and ns3::UdpEchoClient::StartApplication().

void ns3::Socket::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 in ns3::TcpSocketBase, and ns3::UdpSocketImpl.

Definition at line 329 of file socket.cc.

References ns3::Node::GetDevice(), ns3::Node::GetNDevices(), GetNode(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::BindToNetDevice(), ns3::TcpSocketBase::BindToNetDevice(), ns3::olsr::RoutingProtocol::DoInitialize(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), and ns3::dsdv::RoutingProtocol::NotifyInterfaceUp().

virtual int ns3::Socket::Close ( void )

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::aodv::RoutingProtocol::NotifyInterfaceDown(), ns3::dsdv::RoutingProtocol::NotifyInterfaceDown(), ns3::V4Ping::StopApplication(), ns3::UdpEchoServer::StopApplication(), ns3::BulkSendApplication::StopApplication(), SimpleSource::StopApplication(), ns3::PacketSink::StopApplication(), ns3::OnOffApplication::StopApplication(), and ns3::UdpEchoClient::StopApplication().

virtual int ns3::Socket::Connect ( const Address & address )

pure virtual

Initiate a connection to a remote host.

Parameters

address Address of remote.

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::TcpWestwood, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::EpcHelper::AddEnb(), DualStackTestCase::DoRun(), ns3::Radvd::Send(), ns3::V4Ping::StartApplication(), ns3::UdpClient::StartApplication(), ns3::BulkSendApplication::StartApplication(), SimpleSource::StartApplication(), ns3::EpsBearerTagUdpClient::StartApplication(), ns3::Ping6::StartApplication(), ns3::UdpTraceClient::StartApplication(), ns3::OnOffApplication::StartApplication(), and ns3::UdpEchoClient::StartApplication().

Ptr< Socket > ns3::Socket::CreateSocket	(	Ptr< Node >	node,
		TypeId	tid
	)

static

This method wraps the creation of sockets that is performed on a given node by a SocketFactory specified by TypeId.

Returns: A smart pointer to a newly created socket.

Parameters

node	The node on which to create the socket
tid	The TypeId of a SocketFactory class to use

Definition at line 70 of file socket.cc.

References ns3::Object::GetObject(), NS_ASSERT, and NS_LOG_FUNCTION.

void ns3::Socket::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, and ns3::Ipv4RawSocketImpl.

Definition at line 314 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv4RawSocketImpl::DoDispose(), and ns3::Ipv6RawSocketImpl::DoDispose().

virtual bool ns3::Socket::GetAllowBroadcast ( ) const

pure 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

Implemented in ns3::Ipv6RawSocketImpl, ns3::TcpSocketBase, ns3::PacketSocket, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Ptr< NetDevice > ns3::Socket::GetBoundNetDevice ( void )

Returns socket's bound netdevice, if any.

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

Returns: Pointer to interface.

Definition at line 350 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6RawSocketImpl::ForwardUp().

virtual enum Socket::SocketErrno ns3::Socket::GetErrno ( void ) const

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

virtual Ptr<Node> ns3::Socket::GetNode ( void ) const

pure virtual

Returns: the node this socket is associated with.

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by BindToNetDevice(), Ipv4FragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().

virtual uint32_t ns3::Socket::GetRxAvailable ( void ) const

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

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

pure virtual

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::BulkSendApplication::StartApplication().

virtual int ns3::Socket::GetSockName ( Address & address ) const

pure virtual

Parameters

address the address name this socket is associated with.

Returns: 0 if success, -1 otherwise

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

virtual uint32_t ns3::Socket::GetTxAvailable ( void ) const

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

bool ns3::Socket::IsIpRecvTos ( void ) const

Ask if the socket is currently passing information about IP Type of Service up the stack.

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

Returns: Wheter the IP_RECVTOS is set

Definition at line 415 of file socket.cc.

bool ns3::Socket::IsIpRecvTtl ( void ) const

Ask if the socket is currently passing information about IP_TTL up the stack.

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

Returns: Wheter the IP_RECVTTL is set

Definition at line 482 of file socket.cc.

bool ns3::Socket::IsIpv6RecvHopLimit ( void ) const

Ask if the socket is currently passing information about IPv6 Hop Limit up the stack.

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

Returns: Wheter the IPV6_RECVHOPLIMIT is set

Definition at line 507 of file socket.cc.

bool ns3::Socket::IsIpv6RecvTclass ( void ) const

Ask if the socket is currently passing information about IPv6 Traffic Class up the stack.

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

Returns: Wheter the IPV6_RECVTCLASS is set

Definition at line 457 of file socket.cc.

bool ns3::Socket::IsRecvPktInfo ( ) const

Get status indicating whether enable/disable packet information to socket.

Returns: True if packet information should be sent to socket

Definition at line 363 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::Ipv6RawSocketImpl::ForwardUp().

virtual int ns3::Socket::Listen ( void )

pure virtual

Listen for incoming connections.

Returns: 0 on success, -1 on error (in which case errno is set).

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::TcpWestwood, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, ns3::TcpTahoe, ns3::TcpReno, ns3::TcpNewReno, and ns3::Ipv4RawSocketImpl.

Referenced by DynamicGlobalRoutingTestCase::DoRun(), DualStackTestCase::DoRun(), and ns3::PacketSink::StartApplication().

virtual Ptr<Packet> ns3::Socket::Recv	(	uint32_t	maxSize,
		uint32_t	flags
	)

pure 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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::EpcEnbApplication::RecvFromLteSocket(), ns3::EpcSgwPgwApplication::RecvFromS1uSocket(), ns3::EpcEnbApplication::RecvFromS1uSocket(), ns3::EpcX2::RecvFromX2cSocket(), and ns3::EpcX2::RecvFromX2uSocket().

Ptr< Packet > ns3::Socket::Recv ( void )

Read a single packet from the socket.

Overloaded version of Recv(maxSize, flags) with maxSize implicitly set to maximum sized integer, and flags set to zero.

Returns: Ptr<Packet> of the next in-sequence packet. Returns 0 if the socket cannot return a next in-sequence packet.

Definition at line 174 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by Recv(), ns3::UdpSocketImpl::RecvFrom(), ns3::NscTcpSocketImpl::RecvFrom(), ns3::TcpSocketBase::RecvFrom(), and ns3::PacketSocket::RecvFrom().

int ns3::Socket::Recv	(	uint8_t *	buf,
		uint32_t	size,
		uint32_t	flags
	)

Recv data (or dummy data) from the remote host.

This method is provided so as to have an API which is closer in appearance to that of real network or BSD sockets.

If the underlying packet was carring null (fake) data, this buffer will be zeroed up to the length specified by the return value.

Parameters

buf	A pointer to a raw byte buffer to write the data to.
size	Number of bytes (at most) to copy to buf
flags	any flags to pass to the socket

Returns: number of bytes copied into buf

Definition at line 181 of file socket.cc.

References ns3::Packet::CopyData(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, and Recv().

virtual Ptr<Packet> ns3::Socket::RecvFrom	(	uint32_t	maxSize,
		uint32_t	flags,
		Address &	fromAddress
	)

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::Ping6::HandleRead(), ns3::Radvd::HandleRead(), ns3::aodv::RoutingProtocol::RecvAodv(), ns3::dsdv::RoutingProtocol::RecvDsdv(), and RecvFrom().

Ptr< Packet > ns3::Socket::RecvFrom ( Address & fromAddress )

Read a single packet from the socket and retrieve the sender address.

Calls RecvFrom (maxSize, flags, fromAddress) with maxSize implicitly set to maximum sized integer, and flags set to zero.

Parameters

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.

Definition at line 194 of file socket.cc.

References NS_LOG_FUNCTION, and RecvFrom().

int ns3::Socket::RecvFrom	(	uint8_t *	buf,
		uint32_t	size,
		uint32_t	flags,
		Address &	fromAddress
	)

Read a single packet from the socket and retrieve the sender address.

This method is provided so as to have an API which is closer in appearance to that of real network or BSD sockets.

Parameters

buf	A pointer to a raw byte buffer to write the data to. If the underlying packet was carring null (fake) data, this buffer will be zeroed up to the length specified by the return value.
size	Number of bytes (at most) to copy to buf
flags	any flags to pass to the socket
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: number of bytes copied into buf

Definition at line 201 of file socket.cc.

References ns3::Packet::CopyData(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, and RecvFrom().

virtual int ns3::Socket::Send	(	Ptr< Packet >	p,
		uint32_t	flags
	)

pure 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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::Ping6::Send(), ns3::Radvd::Send(), Send(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), and ns3::EpcEnbApplication::SendToLteSocket().

int ns3::Socket::Send ( Ptr< Packet > p )

Send data (or dummy data) to the remote host.

Overloaded version of Send(..., flags) with flags set to zero.

Parameters

p	ns3::Packet to send

Returns: the number of bytes accepted for transmission if no error occurs, and -1 otherwise.

Definition at line 134 of file socket.cc.

References NS_LOG_FUNCTION, and Send().

int ns3::Socket::Send	(	const uint8_t *	buf,
		uint32_t	size,
		uint32_t	flags
	)

Send data (or dummy data) to the remote host.

This method is provided so as to have an API which is closer in appearance to that of real network or BSD sockets.

Parameters

buf	A pointer to a raw byte buffer of some data to send. If this buffer is 0, we send dummy data whose size is specified by the second parameter
size	the number of bytes to copy from the buffer
flags	Socket control flags

Definition at line 141 of file socket.cc.

References NS_LOG_FUNCTION, and Send().

virtual int ns3::Socket::SendTo	(	Ptr< Packet >	p,
		uint32_t	flags,
		const Address &	toAddress
	)

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

Implemented in ns3::Ipv6RawSocketImpl, ns3::PacketSocket, ns3::TcpSocketBase, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

int ns3::Socket::SendTo	(	const uint8_t *	buf,
		uint32_t	size,
		uint32_t	flags,
		const Address &	address
	)

Send data to a specified peer.

This method is provided so as to have an API which is closer in appearance to that of real network or BSD sockets.

Parameters

buf	A pointer to a raw byte buffer of some data to send. If this is 0, we send dummy data whose size is specified by the third parameter
size	the number of bytes to copy from the buffer
flags	Socket control flags
address	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.

Definition at line 157 of file socket.cc.

References NS_LOG_FUNCTION, and SendTo().

void ns3::Socket::SetAcceptCallback	(	Callback< bool, Ptr< Socket >, const Address & >	connectionRequest,
		Callback< void, Ptr< Socket >, const Address & >	newConnectionCreated
	)

Accept connection requests from remote hosts.

Parameters

connectionRequest Callback for connection request from peer. This user callback is passed a pointer to this socket, the ip address and the port number of the connection originator. This callback must return true to accept the incoming connection, false otherwise. If the connection is accepted, the "newConnectionCreated" callback will be invoked later to give access to the user to the socket created to match this new connection. If the user does not explicitly specify this callback, all incoming connections will be refused.

newConnectionCreated Callback for new connection: when a new is accepted, it is created and the corresponding socket is passed back to the user through this callback. This user callback is passed a pointer to the new socket, and the ip address and port number of the connection originator.

Definition at line 103 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by DualStackTestCase::DoRun(), and ns3::PacketSink::StartApplication().

virtual bool ns3::Socket::SetAllowBroadcast ( bool allowBroadcast )

pure 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

Returns: true if operation succeeds

Implemented in ns3::Ipv6RawSocketImpl, ns3::TcpSocketBase, ns3::PacketSocket, ns3::NscTcpSocketImpl, ns3::UdpSocketImpl, and ns3::Ipv4RawSocketImpl.

Referenced by ns3::olsr::RoutingProtocol::DoInitialize(), UdpSocketImplTest::DoRun(), Udp6SocketImplTest::DoRun(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::dsdv::RoutingProtocol::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::dsdv::RoutingProtocol::NotifyRemoveAddress(), and ns3::OnOffApplication::StartApplication().

void ns3::Socket::SetCloseCallbacks	(	Callback< void, Ptr< Socket > >	normalClose,
		Callback< void, Ptr< Socket > >	errorClose
	)

Detect socket recv() events such as graceful shutdown or error.

For connection-oriented sockets, the first callback is used to signal that the remote side has gracefully shut down the connection, and the second callback denotes an error corresponding to cases in which a traditional recv() socket call might return -1 (error), such as a connection reset. For datagram sockets, these callbacks may never be invoked.

Parameters

normalClose	this callback is invoked when the peer closes the connection gracefully
errorClose	this callback is invoked when the connection closes abnormally

Definition at line 93 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PacketSink::StartApplication().

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

Parameters

connectionSucceeded	this callback is invoked when the connection request initiated by the user is successfully completed. The callback is passed back a pointer to the same socket object.
connectionFailed	this callback is invoked when the connection request initiated by the user is unsuccessfully completed. The callback is passed back a pointer to the same socket object.

Definition at line 83 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::BulkSendApplication::StartApplication(), ns3::OnOffApplication::StartApplication(), and ns3::TcpSocketBase::TcpSocketBase().

void ns3::Socket::SetDataSentCallback ( Callback< void, Ptr< Socket >, uint32_t > dataSent )

Notify application when a packet has been sent from transport protocol (non-standard socket call)

Parameters

dataSent Callback for the event that data is sent from the underlying transport protocol. This callback is passed a pointer to the socket, and the number of bytes sent.

Definition at line 113 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::TcpSocketBase().

void ns3::Socket::SetIpRecvTos ( bool ipv4RecvTos )

Tells a socket to pass information about IP Type of Service up the stack.

This method corresponds to using setsockopt () IP_RECVTOS of real network or BSD sockets. In our implementation, the socket simply adds a SocketIpTosTag tag to the packet before passing the packet up the stack.

Parameters

ipv4RecvTos Whether the socket should add SocketIpv4TosTag tag to the packet

Definition at line 409 of file socket.cc.

void ns3::Socket::SetIpRecvTtl ( bool ipv4RecvTtl )

Tells a socket to pass information about IP_TTL up the stack.

This method corresponds to using setsockopt () IP_RECVTTL of real network or BSD sockets. In our implementation, the socket simply adds a SocketIpTtlTag tag to the packet before passing the packet up the stack.

Parameters

ipv4RecvTtl Whether the socket should add SocketIpv4TtlTag tag to the packet

Definition at line 476 of file socket.cc.

void ns3::Socket::SetIpv6RecvHopLimit ( bool ipv6RecvHopLimit )

Tells a socket to pass information about IPv6 Hop Limit up the stack.

This method corresponds to using setsockopt () IPV6_RECVHOPLIMIT of real network or BSD sockets. In our implementation, the socket simply adds a SocketIpv6HopLimitTag tag to the packet before passing the packet up the stack.

Parameters

ipv6RecvHopLimit Whether the socket should add SocketIpv6HopLimitTag tag to the packet

Definition at line 501 of file socket.cc.

void ns3::Socket::SetIpv6RecvTclass ( bool ipv6RecvTclass )

Tells a socket to pass information about IPv6 Traffic Class up the stack.

This method corresponds to using setsockopt () IPV6_RECVTCLASS of real network or BSD sockets. In our implementation, the socket simply adds a SocketIpv6TclasssTag tag to the packet before passing the packet up the stack.

Parameters

ipv6RecvTclass Whether the socket should add SocketIpv6TclassTag tag to the packet

Definition at line 451 of file socket.cc.

void ns3::Socket::SetRecvCallback ( Callback< void, Ptr< Socket > > receivedData )

Notify application when new data is available to be read.

This callback is intended to notify a socket that would have been blocked in a blocking socket model that data is available to be read.

Definition at line 127 of file socket.cc.

References NS_LOG_FUNCTION.

void ns3::Socket::SetRecvPktInfo ( bool flag )

Enable/Disable receive packet information to socket.

For IP_PKTINFO/IP6_PKTINFO. This method is only usable for Raw socket and Datagram Socket. Not supported for Stream socket.

Method doesn't make distinction between IPv4 and IPv6. If it is enabled, it is enabled for all types of sockets that supports packet information

Parameters

flag	Enable/Disable receive information

Returns: nothing

Definition at line 357 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by DynamicGlobalRoutingTestCase::DoRun().

void ns3::Socket::SetSendCallback ( Callback< void, Ptr< Socket >, uint32_t > sendCb )

Notify application when space in transmit buffer is added.

This callback is intended to notify a socket that would have been blocked in a blocking socket model that space is available in the transmit buffer and that it can call Send() again.

Parameters

sendCb Callback for the event that the socket transmit buffer fill level has decreased. This callback is passed a pointer to the socket, and the number of bytes available for writing into the buffer (an absolute value). If there is no transmit buffer limit, a maximum-sized integer is always returned.

Definition at line 120 of file socket.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::BulkSendApplication::StartApplication(), and ns3::TcpSocketBase::TcpSocketBase().

virtual int ns3::Socket::ShutdownRecv ( void )

pure virtual