#include <ipv4-raw-socket-impl.h>
Classes | |
struct | Data |
Public Member Functions | |
Ipv4RawSocketImpl () | |
void | SetNode (Ptr< Node > node) |
virtual enum Socket::SocketErrno | GetErrno (void) const |
virtual Ptr< Node > | GetNode (void) const |
virtual int | Bind (const Address &address) |
virtual int | Bind () |
virtual int | GetSockName (Address &address) const |
virtual int | Close (void) |
Close a socket. | |
virtual int | ShutdownSend (void) |
virtual int | ShutdownRecv (void) |
virtual int | Connect (const Address &address) |
Initiate a connection to a remote host. | |
virtual int | Listen (void) |
Listen for incoming connections. | |
virtual uint32_t | GetTxAvailable (void) const |
Returns the number of bytes which can be sent in a single call to Send. | |
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 uint32_t | GetRxAvailable (void) const |
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. | |
void | SetProtocol (uint16_t protocol) |
bool | ForwardUp (Ptr< const Packet > p, Ipv4Header ipHeader, Ptr< NetDevice > device) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::Ipv4RawSocketImpl. | |
Private Member Functions | |
virtual void | DoDispose (void) |
Private Attributes | |
enum Socket::SocketErrno | m_err |
Ptr< Node > | m_node |
Ipv4Address | m_src |
Ipv4Address | m_dst |
uint16_t | m_protocol |
std::list< struct Data > | m_recv |
bool | m_shutdownSend |
bool | m_shutdownRecv |
uint32_t | m_icmpFilter |
Definition at line 13 of file ipv4-raw-socket-impl.h.
ns3::Ipv4RawSocketImpl::Ipv4RawSocketImpl | ( | ) |
Definition at line 34 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.
int ns3::Ipv4RawSocketImpl::Bind | ( | ) | [virtual] |
Allocate a local endpoint for this socket.
Implements ns3::Socket.
Definition at line 86 of file ipv4-raw-socket-impl.cc.
References ns3::Ipv4Address::GetAny(), m_src, and NS_LOG_FUNCTION.
int ns3::Ipv4RawSocketImpl::Bind | ( | const Address & | address | ) | [virtual] |
address | the address to try to allocate |
Allocate a local endpoint for this socket.
Implements ns3::Socket.
Definition at line 73 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.
int ns3::Ipv4RawSocketImpl::Close | ( | void | ) | [virtual] |
Close a socket.
After the Close call, the socket is no longer valid, and cannot safely be used for subsequent operations.
Implements ns3::Socket.
Definition at line 99 of file ipv4-raw-socket-impl.cc.
References m_node, and NS_LOG_FUNCTION.
int ns3::Ipv4RawSocketImpl::Connect | ( | const Address & | address | ) | [virtual] |
Initiate a connection to a remote host.
address | Address of remote. |
Implements ns3::Socket.
Definition at line 124 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.
void ns3::Ipv4RawSocketImpl::DoDispose | ( | void | ) | [private, virtual] |
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.
Reimplemented from ns3::Object.
Definition at line 53 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< NetDevice > | device | |||
) |
Definition at line 233 of file ipv4-raw-socket-impl.cc.
References ns3::Ipv4RawSocketImpl::Data::fromIp, ns3::Ipv4RawSocketImpl::Data::fromProtocol, ns3::Ipv4Address::GetAny(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetProtocol(), ns3::Ipv4Header::GetSource(), ns3::Icmpv4Header::GetType(), m_dst, m_icmpFilter, m_protocol, m_recv, m_shutdownRecv, m_src, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION, and ns3::Ipv4RawSocketImpl::Data::packet.
enum Socket::SocketErrno ns3::Ipv4RawSocketImpl::GetErrno | ( | void | ) | const [virtual] |
Implements ns3::Socket.
Definition at line 61 of file ipv4-raw-socket-impl.cc.
References m_err, and NS_LOG_FUNCTION.
Implements ns3::Socket.
Definition at line 67 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 185 of file ipv4-raw-socket-impl.cc.
References m_recv, and NS_LOG_FUNCTION.
int ns3::Ipv4RawSocketImpl::GetSockName | ( | Address & | address | ) | const [virtual] |
Implements ns3::Socket.
Definition at line 93 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 144 of file ipv4-raw-socket-impl.cc.
References NS_LOG_FUNCTION.
TypeId ns3::Ipv4RawSocketImpl::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::Ipv4RawSocketImpl.
Attributes defined for this type:
No TraceSources defined for this type.
Reimplemented from ns3::Object.
Definition at line 17 of file ipv4-raw-socket-impl.cc.
References ns3::TypeId::AddAttribute(), m_icmpFilter, m_protocol, and ns3::TypeId::SetParent().
int ns3::Ipv4RawSocketImpl::Listen | ( | void | ) | [virtual] |
Listen for incoming connections.
Implements ns3::Socket.
Definition at line 137 of file ipv4-raw-socket-impl.cc.
References ns3::Socket::ERROR_OPNOTSUPP, m_err, and NS_LOG_FUNCTION.
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.
maxSize | reader will accept packet up to maxSize | |
flags | Socket control flags |
Implements ns3::Socket.
Definition at line 196 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.
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. |
Implements ns3::Socket.
Definition at line 203 of file ipv4-raw-socket-impl.cc.
References ns3::Ipv4RawSocketImpl::Data::fromIp, ns3::Ipv4RawSocketImpl::Data::fromProtocol, m_recv, NS_LOG_FUNCTION, and ns3::Ipv4RawSocketImpl::Data::packet.
Referenced by Recv().
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.
p | ns3::Packet to send | |
flags | Socket control flags |
Implements ns3::Socket.
Definition at line 150 of file ipv4-raw-socket-impl.cc.
References m_dst, m_protocol, 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.
Implements ns3::Socket.
Definition at line 157 of file ipv4-raw-socket-impl.cc.
References ns3::InetSocketAddress::ConvertFrom(), ns3::Socket::ERROR_INVAL, ns3::InetSocketAddress::GetIpv4(), ns3::InetSocketAddress::IsMatchingType(), m_err, m_node, m_protocol, m_shutdownSend, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by Send().
Definition at line 47 of file ipv4-raw-socket-impl.cc.
References m_node.
void ns3::Ipv4RawSocketImpl::SetProtocol | ( | uint16_t | protocol | ) |
Definition at line 226 of file ipv4-raw-socket-impl.cc.
References m_protocol, and NS_LOG_FUNCTION.
int ns3::Ipv4RawSocketImpl::ShutdownRecv | ( | void | ) | [virtual] |
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 117 of file ipv4-raw-socket-impl.cc.
References m_shutdownRecv, and NS_LOG_FUNCTION.
int ns3::Ipv4RawSocketImpl::ShutdownSend | ( | void | ) | [virtual] |
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 110 of file ipv4-raw-socket-impl.cc.
References m_shutdownSend, and NS_LOG_FUNCTION.
Ipv4Address ns3::Ipv4RawSocketImpl::m_dst [private] |
Definition at line 55 of file ipv4-raw-socket-impl.h.
Referenced by Connect(), ForwardUp(), Ipv4RawSocketImpl(), and Send().
enum Socket::SocketErrno ns3::Ipv4RawSocketImpl::m_err [private] |
Definition at line 52 of file ipv4-raw-socket-impl.h.
Referenced by Bind(), Connect(), GetErrno(), Ipv4RawSocketImpl(), Listen(), and SendTo().
uint32_t ns3::Ipv4RawSocketImpl::m_icmpFilter [private] |
Definition at line 60 of file ipv4-raw-socket-impl.h.
Referenced by ForwardUp(), and GetTypeId().
Ptr<Node> ns3::Ipv4RawSocketImpl::m_node [private] |
Definition at line 53 of file ipv4-raw-socket-impl.h.
Referenced by Close(), DoDispose(), GetNode(), Ipv4RawSocketImpl(), SendTo(), and SetNode().
uint16_t ns3::Ipv4RawSocketImpl::m_protocol [private] |
Definition at line 56 of file ipv4-raw-socket-impl.h.
Referenced by ForwardUp(), GetTypeId(), Ipv4RawSocketImpl(), Send(), SendTo(), and SetProtocol().
std::list<struct Data> ns3::Ipv4RawSocketImpl::m_recv [private] |
Definition at line 57 of file ipv4-raw-socket-impl.h.
Referenced by ForwardUp(), GetRxAvailable(), and RecvFrom().
bool ns3::Ipv4RawSocketImpl::m_shutdownRecv [private] |
Definition at line 59 of file ipv4-raw-socket-impl.h.
Referenced by ForwardUp(), Ipv4RawSocketImpl(), and ShutdownRecv().
bool ns3::Ipv4RawSocketImpl::m_shutdownSend [private] |
Definition at line 58 of file ipv4-raw-socket-impl.h.
Referenced by Ipv4RawSocketImpl(), SendTo(), and ShutdownSend().
Ipv4Address ns3::Ipv4RawSocketImpl::m_src [private] |
Definition at line 54 of file ipv4-raw-socket-impl.h.
Referenced by Bind(), ForwardUp(), GetSockName(), and Ipv4RawSocketImpl().