A PacketSocket is a link between an application and a net device. More...
#include <packet-socket.h>
Public Member Functions | |
PacketSocket () | |
virtual | ~PacketSocket () |
void | SetNode (Ptr< Node > node) |
virtual enum SocketErrno | GetErrno (void) const |
virtual Ptr< Node > | GetNode (void) const |
virtual int | Bind (void) |
virtual int | Bind (const Address &address) |
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. | |
virtual int | GetSockName (Address &address) const |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::Object. | |
Private Types | |
enum | State { STATE_OPEN, STATE_BOUND, STATE_CONNECTED, STATE_CLOSED } |
Private Member Functions | |
void | ForwardUp (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType) |
int | DoBind (const PacketSocketAddress &address) |
uint32_t | GetMinMtu (PacketSocketAddress ad) const |
virtual void | DoDispose (void) |
Private Attributes | |
Ptr< Node > | m_node |
enum SocketErrno | m_errno |
bool | m_shutdownSend |
bool | m_shutdownRecv |
enum State | m_state |
uint16_t | m_protocol |
bool | m_isSingleDevice |
uint32_t | m_device |
Address | m_destAddr |
std::queue< Ptr< Packet > > | m_deliveryQueue |
Default destination address. | |
uint32_t | m_rxAvailable |
TracedCallback< Ptr< const Packet > > | m_dropTrace |
uint32_t | m_rcvBufSize |
A PacketSocket is a link between an application and a net device.
A PacketSocket can be used to connect an application to a net device. The application provides the buffers of data, the socket conserts them to a raw packet and the net device then adds the protocol specific headers and trailers. This socket type is very similar to the linux and BSD "packet" sockets.
Here is a summary of the semantics of this class:
Definition at line 78 of file packet-socket.h.
enum ns3::PacketSocket::State [private] |
Definition at line 114 of file packet-socket.h.
ns3::PacketSocket::PacketSocket | ( | ) |
Definition at line 53 of file packet-socket.cc.
References ns3::Socket::ERROR_NOTERROR, m_device, m_errno, m_isSingleDevice, m_shutdownRecv, m_shutdownSend, m_state, NS_LOG_FUNCTION_NOARGS, and STATE_OPEN.
ns3::PacketSocket::~PacketSocket | ( | ) | [virtual] |
Definition at line 71 of file packet-socket.cc.
References NS_LOG_FUNCTION_NOARGS.
int ns3::PacketSocket::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 108 of file packet-socket.cc.
References ns3::PacketSocketAddress::ConvertFrom(), DoBind(), ns3::Socket::ERROR_INVAL, ns3::PacketSocketAddress::IsMatchingType(), m_errno, and NS_LOG_FUNCTION_NOARGS.
int ns3::PacketSocket::Bind | ( | void | ) | [virtual] |
Allocate a local endpoint for this socket.
Implements ns3::Socket.
Definition at line 98 of file packet-socket.cc.
References DoBind(), NS_LOG_FUNCTION_NOARGS, ns3::PacketSocketAddress::SetAllDevices(), and ns3::PacketSocketAddress::SetProtocol().
int ns3::PacketSocket::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 180 of file packet-socket.cc.
References ns3::Socket::ERROR_BADF, m_errno, m_state, NS_LOG_FUNCTION_NOARGS, and STATE_CLOSED.
int ns3::PacketSocket::Connect | ( | const Address & | address | ) | [virtual] |
Initiate a connection to a remote host.
address | Address of remote. |
Implements ns3::Socket.
Definition at line 193 of file packet-socket.cc.
References ns3::Socket::ERROR_AFNOSUPPORT, ns3::Socket::ERROR_BADF, ns3::Socket::ERROR_INVAL, ns3::Socket::ERROR_ISCONN, ns3::PacketSocketAddress::IsMatchingType(), m_destAddr, m_errno, m_state, ns3::Socket::NotifyConnectionFailed(), ns3::Socket::NotifyConnectionSucceeded(), NS_LOG_FUNCTION_NOARGS, STATE_CLOSED, STATE_CONNECTED, and STATE_OPEN.
int ns3::PacketSocket::DoBind | ( | const PacketSocketAddress & | address | ) | [private] |
Definition at line 121 of file packet-socket.cc.
References ns3::Socket::ERROR_BADF, ns3::Socket::ERROR_INVAL, ForwardUp(), ns3::PacketSocketAddress::GetProtocol(), ns3::PacketSocketAddress::GetSingleDevice(), ns3::PacketSocketAddress::IsSingleDevice(), m_device, m_errno, m_isSingleDevice, m_node, m_protocol, m_state, ns3::MakeCallback(), NS_LOG_FUNCTION_NOARGS, STATE_BOUND, STATE_CLOSED, and STATE_CONNECTED.
Referenced by Bind().
void ns3::PacketSocket::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 77 of file packet-socket.cc.
References m_device, and NS_LOG_FUNCTION_NOARGS.
void ns3::PacketSocket::ForwardUp | ( | Ptr< NetDevice > | device, | |
Ptr< const Packet > | packet, | |||
uint16_t | protocol, | |||
const Address & | from, | |||
const Address & | to, | |||
NetDevice::PacketType | packetType | |||
) | [private] |
Definition at line 350 of file packet-socket.cc.
References m_deliveryQueue, m_dropTrace, m_rcvBufSize, m_rxAvailable, m_shutdownRecv, ns3::Socket::NotifyDataRecv(), NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, NS_LOG_WARN, ns3::SocketAddressTag::SetAddress(), ns3::PacketSocketAddress::SetPhysicalAddress(), ns3::PacketSocketAddress::SetProtocol(), and ns3::PacketSocketAddress::SetSingleDevice().
Referenced by DoBind().
enum Socket::SocketErrno ns3::PacketSocket::GetErrno | ( | void | ) | const [virtual] |
Implements ns3::Socket.
Definition at line 84 of file packet-socket.cc.
References m_errno, and NS_LOG_FUNCTION_NOARGS.
uint32_t ns3::PacketSocket::GetMinMtu | ( | PacketSocketAddress | ad | ) | const [private] |
Definition at line 247 of file packet-socket.cc.
References ns3::PacketSocketAddress::GetSingleDevice(), ns3::PacketSocketAddress::IsSingleDevice(), and m_node.
Referenced by GetTxAvailable(), and SendTo().
Implements ns3::Socket.
Definition at line 91 of file packet-socket.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
uint32_t ns3::PacketSocket::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 389 of file packet-socket.cc.
References m_rxAvailable, and NS_LOG_FUNCTION_NOARGS.
int ns3::PacketSocket::GetSockName | ( | Address & | address | ) | const [virtual] |
Implements ns3::Socket.
Definition at line 435 of file packet-socket.cc.
References ns3::PacketSocketAddress::ConvertFrom(), ns3::PacketSocketAddress::GetSingleDevice(), m_device, m_isSingleDevice, m_node, m_protocol, NS_LOG_FUNCTION_NOARGS, ns3::PacketSocketAddress::SetAllDevices(), ns3::PacketSocketAddress::SetPhysicalAddress(), ns3::PacketSocketAddress::SetProtocol(), and ns3::PacketSocketAddress::SetSingleDevice().
uint32_t ns3::PacketSocket::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 267 of file packet-socket.cc.
References ns3::PacketSocketAddress::ConvertFrom(), GetMinMtu(), m_destAddr, m_state, and STATE_CONNECTED.
Referenced by SendTo().
TypeId ns3::PacketSocket::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::Object.
No Attributes defined for this type.
No TraceSources defined for this type.
Reimplemented from ns3::Object.
Definition at line 37 of file packet-socket.cc.
References ns3::TypeId::AddAttribute(), ns3::TypeId::AddTraceSource(), m_dropTrace, m_rcvBufSize, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
int ns3::PacketSocket::Listen | ( | void | ) | [virtual] |
Listen for incoming connections.
Implements ns3::Socket.
Definition at line 227 of file packet-socket.cc.
References ns3::Socket::ERROR_OPNOTSUPP, and m_errno.
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 398 of file packet-socket.cc.
References m_deliveryQueue, m_rxAvailable, and NS_LOG_FUNCTION_NOARGS.
Ptr< Packet > ns3::PacketSocket::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 419 of file packet-socket.cc.
References ns3::SocketAddressTag::GetAddress(), NS_ASSERT, NS_LOG_FUNCTION_NOARGS, and ns3::Socket::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 234 of file packet-socket.cc.
References ns3::Socket::ERROR_NOTCONN, m_destAddr, m_errno, m_state, NS_LOG_FUNCTION_NOARGS, SendTo(), STATE_BOUND, and STATE_OPEN.
int ns3::PacketSocket::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 279 of file packet-socket.cc.
References ns3::PacketSocketAddress::ConvertFrom(), ns3::Socket::ERROR_AFNOSUPPORT, ns3::Socket::ERROR_BADF, ns3::Socket::ERROR_INVAL, ns3::Socket::ERROR_MSGSIZE, ns3::Socket::ERROR_SHUTDOWN, GetMinMtu(), ns3::PacketSocketAddress::GetPhysicalAddress(), ns3::PacketSocketAddress::GetProtocol(), ns3::PacketSocketAddress::GetSingleDevice(), GetTxAvailable(), ns3::PacketSocketAddress::IsMatchingType(), ns3::PacketSocketAddress::IsSingleDevice(), m_errno, m_node, m_shutdownSend, m_state, ns3::Socket::NotifyDataSent(), ns3::Socket::NotifySend(), NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, and STATE_CLOSED.
Referenced by Send().
Definition at line 65 of file packet-socket.cc.
References m_node, and NS_LOG_FUNCTION_NOARGS.
int ns3::PacketSocket::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 167 of file packet-socket.cc.
References ns3::Socket::ERROR_BADF, m_errno, m_shutdownRecv, m_state, NS_LOG_FUNCTION_NOARGS, and STATE_CLOSED.
int ns3::PacketSocket::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 154 of file packet-socket.cc.
References ns3::Socket::ERROR_BADF, m_errno, m_shutdownSend, m_state, NS_LOG_FUNCTION_NOARGS, and STATE_CLOSED.
std::queue<Ptr<Packet> > ns3::PacketSocket::m_deliveryQueue [private] |
Default destination address.
Definition at line 130 of file packet-socket.h.
Referenced by ForwardUp(), and Recv().
Address ns3::PacketSocket::m_destAddr [private] |
Definition at line 128 of file packet-socket.h.
Referenced by Connect(), GetTxAvailable(), and Send().
uint32_t ns3::PacketSocket::m_device [private] |
Definition at line 127 of file packet-socket.h.
Referenced by DoBind(), DoDispose(), GetSockName(), and PacketSocket().
TracedCallback<Ptr<const Packet> > ns3::PacketSocket::m_dropTrace [private] |
Definition at line 133 of file packet-socket.h.
Referenced by ForwardUp(), and GetTypeId().
enum SocketErrno ns3::PacketSocket::m_errno [private] |
Definition at line 121 of file packet-socket.h.
Referenced by Bind(), Close(), Connect(), DoBind(), GetErrno(), Listen(), PacketSocket(), Send(), SendTo(), ShutdownRecv(), and ShutdownSend().
bool ns3::PacketSocket::m_isSingleDevice [private] |
Definition at line 126 of file packet-socket.h.
Referenced by DoBind(), GetSockName(), and PacketSocket().
Ptr<Node> ns3::PacketSocket::m_node [private] |
Definition at line 120 of file packet-socket.h.
Referenced by DoBind(), GetMinMtu(), GetNode(), GetSockName(), SendTo(), and SetNode().
uint16_t ns3::PacketSocket::m_protocol [private] |
Definition at line 125 of file packet-socket.h.
Referenced by DoBind(), and GetSockName().
uint32_t ns3::PacketSocket::m_rcvBufSize [private] |
Definition at line 136 of file packet-socket.h.
Referenced by ForwardUp(), and GetTypeId().
uint32_t ns3::PacketSocket::m_rxAvailable [private] |
Definition at line 131 of file packet-socket.h.
Referenced by ForwardUp(), GetRxAvailable(), and Recv().
bool ns3::PacketSocket::m_shutdownRecv [private] |
Definition at line 123 of file packet-socket.h.
Referenced by ForwardUp(), PacketSocket(), and ShutdownRecv().
bool ns3::PacketSocket::m_shutdownSend [private] |
Definition at line 122 of file packet-socket.h.
Referenced by PacketSocket(), SendTo(), and ShutdownSend().
enum State ns3::PacketSocket::m_state [private] |
Definition at line 124 of file packet-socket.h.
Referenced by Close(), Connect(), DoBind(), GetTxAvailable(), PacketSocket(), Send(), SendTo(), ShutdownRecv(), and ShutdownSend().