#include <ipv4-raw-socket-impl.h>

Inheritance diagram for ns3::Ipv4RawSocketImpl:

Collaboration diagram for ns3::Ipv4RawSocketImpl:

Classes
struct	Data

Public Member Functions
	Ipv4RawSocketImpl ()
virtual int	Bind (const Address &address)
	Allocate a local endpoint for this socket.
virtual int	Bind ()
	Allocate a local IPv4 endpoint for this socket.
virtual int	Bind6 ()
	Allocate a local IPv6 endpoint for this socket.
virtual int	Close (void)
	Close a socket.
virtual int	Connect (const Address &address)
	Initiate a connection to a remote host.
bool	ForwardUp (Ptr< const Packet > p, Ipv4Header ipHeader, Ptr< Ipv4Interface > incomingInterface)
virtual bool	GetAllowBroadcast () const
	Query whether broadcast datagram transmissions are allowed.
virtual enum Socket::SocketErrno	GetErrno (void) const
virtual Ptr< Node >	GetNode (void) const
virtual uint32_t	GetRxAvailable (void) const
virtual enum Socket::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 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 &toAddress)
	Send data to a specified peer.
virtual bool	SetAllowBroadcast (bool allowBroadcast)
	Configure whether broadcast datagram transmissions are allowed.
void	SetNode (Ptr< Node > node)
void	SetProtocol (uint16_t protocol)
virtual int	ShutdownRecv (void)
virtual int	ShutdownSend (void)
Public Member Functions inherited from ns3::Socket
	Socket (void)
virtual	~Socket (void)
virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device.
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::Ipv4RawSocketImpl.
Static Public Member Functions inherited from ns3::Socket
static Ptr< Socket >	CreateSocket (Ptr< Node > node, TypeId tid)

Private Member Functions
virtual void	DoDispose (void)

Private Attributes
Ipv4Address	m_dst
enum Socket::SocketErrno	m_err
uint32_t	m_icmpFilter
bool	m_iphdrincl
Ptr< Node >	m_node
uint16_t	m_protocol
std::list< struct Data >	m_recv
bool	m_shutdownRecv
bool	m_shutdownSend
Ipv4Address	m_src

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

Definition at line 16 of file ipv4-raw-socket-impl.h.

Constructor & Destructor Documentation

ns3::Ipv4RawSocketImpl::Ipv4RawSocketImpl ( )

Definition at line 53 of file ipv4-raw-socket-impl.cc.

References ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Address::GetAny(), m_dst, m_err, m_node, m_protocol, m_shutdownRecv, m_shutdownSend, m_src, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

int ns3::Ipv4RawSocketImpl::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 99 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::IsMatchingType(), m_err, m_src, and NS_LOG_FUNCTION.

Here is the call graph for this function:

int ns3::Ipv4RawSocketImpl::Bind ( )

virtual

Allocate a local IPv4 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

Definition at line 112 of file ipv4-raw-socket-impl.cc.

References ns3::Ipv4Address::GetAny(), m_src, and NS_LOG_FUNCTION.

Here is the call graph for this function:

int ns3::Ipv4RawSocketImpl::Bind6 ( )

virtual

Allocate a local IPv6 endpoint for this socket.

Returns: 0 on success, -1 on failure.

Implements ns3::Socket.

Definition at line 119 of file ipv4-raw-socket-impl.cc.

int ns3::Ipv4RawSocketImpl::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 130 of file ipv4-raw-socket-impl.cc.

References ns3::Ipv4::DeleteRawSocket(), ns3::Object::GetObject(), m_node, and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

virtual

Initiate a connection to a remote host.

Parameters

address Address of remote.

Implements ns3::Socket.

Definition at line 155 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::IsMatchingType(), m_dst, m_err, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Ipv4RawSocketImpl::DoDispose ( void )

privatevirtual

Definition at line 72 of file ipv4-raw-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION.

bool ns3::Ipv4RawSocketImpl::ForwardUp	(	Ptr< const Packet >	p,
		Ipv4Header	ipHeader,
		Ptr< Ipv4Interface >	incomingInterface
	)

Definition at line 307 of file ipv4-raw-socket-impl.cc.

References ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::Packet::Copy(), ns3::Ipv4RawSocketImpl::Data::fromIp, ns3::Ipv4RawSocketImpl::Data::fromProtocol, ns3::Ipv4Address::GetAny(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4Interface::GetDevice(), ns3::NetDevice::GetIfIndex(), ns3::Ipv4Header::GetProtocol(), ns3::Ipv4Header::GetSource(), ns3::Icmpv4Header::GetType(), ns3::Socket::IsRecvPktInfo(), m_dst, m_icmpFilter, m_protocol, m_recv, m_shutdownRecv, m_src, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Ipv4RawSocketImpl::Data::packet, ns3::Packet::PeekHeader(), ns3::Packet::RemovePacketTag(), and ns3::Ipv4PacketInfoTag::SetRecvIf().

Referenced by ns3::Ipv4L3Protocol::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Ipv4RawSocketImpl::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 363 of file ipv4-raw-socket-impl.cc.

enum Socket::SocketErrno ns3::Ipv4RawSocketImpl::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 80 of file ipv4-raw-socket-impl.cc.

References m_err, and NS_LOG_FUNCTION.

Ptr< Node > ns3::Ipv4RawSocketImpl::GetNode ( void ) const

virtual

Returns: the node this socket is associated with.

Implements ns3::Socket.

Definition at line 93 of file ipv4-raw-socket-impl.cc.

References m_node, and NS_LOG_FUNCTION.

uint32_t ns3::Ipv4RawSocketImpl::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 256 of file ipv4-raw-socket-impl.cc.

References m_recv, and NS_LOG_FUNCTION.

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

virtual

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

Implements ns3::Socket.

Definition at line 87 of file ipv4-raw-socket-impl.cc.

References ns3::Socket::NS3_SOCK_RAW.

int ns3::Ipv4RawSocketImpl::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 124 of file ipv4-raw-socket-impl.cc.

References m_src.

uint32_t ns3::Ipv4RawSocketImpl::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 175 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

Referenced by SendTo().

Here is the caller graph for this function:

TypeId ns3::Ipv4RawSocketImpl::GetTypeId ( void )

static

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

Attributes defined for this type:

Protocol: Protocol number to match.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: construct write read
IcmpFilter: Any icmp header whose type field matches a bit in this filter is dropped. Type must be less than 32.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write read
IpHeaderInclude: Include IP Header information (a.k.a setsockopt (IP_HDRINCL)).
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Socket.

Definition at line 23 of file ipv4-raw-socket-impl.cc.

References m_icmpFilter, m_iphdrincl, m_protocol, and ns3::TypeId::SetParent().

Here is the call graph for this function:

int ns3::Ipv4RawSocketImpl::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 168 of file ipv4-raw-socket-impl.cc.

References ns3::Socket::ERROR_OPNOTSUPP, m_err, and NS_LOG_FUNCTION.

Ptr< Packet > ns3::Ipv4RawSocketImpl::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 267 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION, and RecvFrom().

Here is the call graph for this function:

Ptr< Packet > ns3::Ipv4RawSocketImpl::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 274 of file ipv4-raw-socket-impl.cc.

References ns3::Packet::CreateFragment(), ns3::Ipv4RawSocketImpl::Data::fromIp, ns3::Ipv4RawSocketImpl::Data::fromProtocol, ns3::Packet::GetSize(), m_recv, NS_LOG_FUNCTION, ns3::Ipv4RawSocketImpl::Data::packet, and ns3::Packet::RemoveAtStart().

Referenced by Recv().

Here is the call graph for this function:

Here is the caller graph for this function:

int ns3::Ipv4RawSocketImpl::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 181 of file ipv4-raw-socket-impl.cc.

References m_dst, m_protocol, NS_LOG_FUNCTION, and SendTo().

Here is the call graph for this function:

int ns3::Ipv4RawSocketImpl::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 188 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Address::GetAny(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4::GetInterfaceForAddress(), ns3::InetSocketAddress::GetIpv4(), ns3::Ipv4::GetNetDevice(), ns3::Object::GetObject(), ns3::Ipv4::GetRoutingProtocol(), ns3::Packet::GetSize(), ns3::Ipv4Route::GetSource(), ns3::Ipv4Header::GetSource(), GetTxAvailable(), ns3::InetSocketAddress::IsMatchingType(), ns3::Socket::m_boundnetdevice, m_err, m_iphdrincl, m_node, m_protocol, m_shutdownSend, m_src, ns3::Socket::NotifyDataSent(), ns3::Socket::NotifySend(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::RemoveHeader(), ns3::Ipv4RoutingProtocol::RouteOutput(), ns3::Ipv4::Send(), ns3::Ipv4::SendWithHeader(), ns3::Ipv4Header::SetDestination(), and ns3::Ipv4Header::SetProtocol().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Ipv4RawSocketImpl::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