#include <introspected-doxygen.h>

Inheritance diagram for ns3::Ipv4RawSocketImpl:

Classes
struct	Data

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

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

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

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

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

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

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

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

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

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

virtual Ptr< Packet >	RecvFrom (uint32_t maxSize, 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)
	Send data (or dummy data) to the remote host. More...

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

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

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
virtual void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device. More...

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

uint8_t	GetIpTos (void) const

virtual uint8_t	GetIpTtl (void) const

virtual uint8_t	GetIpv6HopLimit (void) const

uint8_t	GetIpv6Tclass (void) const

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

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

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

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

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

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

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 TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Socket
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)

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
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 inherited from ns3::Socket
Ptr< NetDevice >	m_boundnetdevice

bool	m_recvPktInfo

Detailed Description

Doxygen introspection did not find any typical Config paths.

Attributes

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 are defined for this type.

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

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 101 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::IsMatchingType(), and NS_LOG_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 114 of file ipv4-raw-socket-impl.cc.

References ns3::Ipv4Address::GetAny(), and NS_LOG_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 121 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

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 134 of file ipv4-raw-socket-impl.cc.

References ns3::Object::GetObject(), and NS_LOG_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 159 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::IsMatchingType(), and NS_LOG_FUNCTION.

void ns3::Ipv4RawSocketImpl::DoDispose ( void )

privatevirtual

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

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

References ns3::Socket::DoDispose(), and NS_LOG_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 378 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

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 81 of file ipv4-raw-socket-impl.cc.

References 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 95 of file ipv4-raw-socket-impl.cc.

References 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 260 of file ipv4-raw-socket-impl.cc.

References 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 88 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

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 127 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

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 179 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION.

Referenced by SendTo().

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 172 of file ipv4-raw-socket-impl.cc.

References 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 271 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION, and RecvFrom().

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 278 of file ipv4-raw-socket-impl.cc.

References ns3::Packet::CreateFragment(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, and ns3::Packet::RemoveAtStart().

Referenced by Recv().

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 185 of file ipv4-raw-socket-impl.cc.

References NS_LOG_FUNCTION, and SendTo().

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 192 of file ipv4-raw-socket-impl.cc.

References ns3::InetSocketAddress::ConvertFrom(), ns3::Ipv4Address::GetAny(), ns3::Ipv4Header::GetDestination(), ns3::InetSocketAddress::GetIpv4(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::Ipv4Route::GetSource(), ns3::Ipv4Header::GetSource(), GetTxAvailable(), ns3::InetSocketAddress::IsMatchingType(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::RemoveHeader(), ns3::Ipv4Header::SetDestination(), and ns3::Ipv4Header::SetProtocol().

Referenced by Send().

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

Returns: true if operation succeeds

Implements ns3::Socket.

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

References NS_LOG_FUNCTION.

int ns3::Ipv4RawSocketImpl::ShutdownRecv ( void )

virtual

Returns: zero on success, -1 on failure.

Do not allow any further Recv calls. This method is typically implemented for Tcp sockets by a half close.

Implements ns3::Socket.

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

References NS_LOG_FUNCTION.

int ns3::Ipv4RawSocketImpl::ShutdownSend ( void )

virtual

Returns: zero on success, -1 on failure.

Do not allow any further Send calls. This method is typically implemented for Tcp sockets by a half close.

Implements ns3::Socket.

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

References NS_LOG_FUNCTION.

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

src/internet/model/ipv4-raw-socket-impl.h
src/internet/model/ipv4-raw-socket-impl.cc

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Member Function Documentation