ns3::PacketSocket Class Reference
[Socket]
A PacketSocket is a link between an application and a net device.
More...
#include <packet-socket.h>
Public Member Functions | |
| 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 Member Functions | |
| virtual void | DoDispose (void) |
Private Attributes | |
| std::queue< Ptr< Packet > > | m_deliveryQueue |
| Default destination address. | |
Detailed Description
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:
- Bind: Bind uses only the protocol and device fields of the PacketSocketAddress. If none are provided, Bind uses zero for both, which means that the socket is bound to all protocols on all devices on the node.
- Connect: uses only the protocol, device and "physical address" field of the PacketSocketAddress. It is used to set the default destination address for outgoing packets.
- Send: send the input packet to the underlying NetDevices with the default destination address. The socket must be bound and connected.
- SendTo: uses the protocol, device, and "physical address" fields of the PacketSocketAddress. The device value is used to specialize the packet transmission to a single device, the protocol value specifies the protocol of this packet only and the "physical address" field is used to override the default destination address. The socket must be bound.
- Recv: The address represents the address of the packer originator. The fields "physical address", device, and protocol are filled.
- Accept: not allowed
- Listen: returns -1 (OPNOTSUPP)
Member Function Documentation
| virtual int ns3::PacketSocket::Bind | ( | const Address & | address | ) | [virtual] |
- Parameters:
-
address the address to try to allocate
- Returns:
- 0 on success, -1 on failure.
Implements ns3::Socket.
| virtual int ns3::PacketSocket::Bind | ( | void | ) | [virtual] |
Allocate a local endpoint for this socket.
- Returns:
- 0 on success, -1 on failure.
Implements ns3::Socket.
| virtual 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.
| virtual int ns3::PacketSocket::Connect | ( | const Address & | address | ) | [virtual] |
Initiate a connection to a remote host.
- Parameters:
-
address Address of remote.
Implements ns3::Socket.
| virtual 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::Socket.
| virtual enum SocketErrno ns3::PacketSocket::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.
| virtual 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.
| virtual int ns3::PacketSocket::GetSockName | ( | Address & | address | ) | const [virtual] |
| virtual 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.
| static 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.
| virtual int ns3::PacketSocket::Listen | ( | void | ) | [virtual] |
Listen for incoming connections.
- Returns:
- 0 on success, -1 on error (in which case errno is set).
Implements ns3::Socket.
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.
| virtual 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.
- 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.
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.
| virtual 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.
- Returns:
- -1 in case of error or the number of bytes copied in the internal buffer and accepted for transmission.
Implements ns3::Socket.
| virtual int ns3::PacketSocket::ShutdownRecv | ( | void | ) | [virtual] |
- Returns:
- zero on success, -1 on failure.
Implements ns3::Socket.
| virtual int ns3::PacketSocket::ShutdownSend | ( | void | ) | [virtual] |
- Returns:
- zero on success, -1 on failure.
Implements ns3::Socket.
The documentation for this class was generated from the following file:
- src/node/packet-socket.h
