A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 Emmanuelle Laprise, INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Emmanuelle Laprise <emmanuelle.laprise@bluekazoo.ca>,
19  * Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
20  */
21 #ifndef PACKET_SOCKET_H
22 #define PACKET_SOCKET_H
24 #include <stdint.h>
25 #include <queue>
26 #include "ns3/callback.h"
27 #include "ns3/traced-callback.h"
28 #include "ns3/ptr.h"
29 #include "ns3/socket.h"
30 #include "ns3/net-device.h"
32 namespace ns3 {
34 class Node;
35 class Packet;
36 class NetDevice;
37 class PacketSocketAddress;
93 class PacketSocket : public Socket
94 {
95 public:
100  static TypeId GetTypeId (void);
102  PacketSocket ();
103  virtual ~PacketSocket ();
109  void SetNode (Ptr<Node> node);
111  virtual enum SocketErrno GetErrno (void) const;
112  virtual enum SocketType GetSocketType (void) const;
113  virtual Ptr<Node> GetNode (void) const;
121  virtual int Bind (void);
129  virtual int Bind6 (void);
137  virtual int Bind (const Address & address);
138  virtual int Close (void);
139  virtual int ShutdownSend (void);
140  virtual int ShutdownRecv (void);
141  virtual int Connect (const Address &address);
142  virtual int Listen (void);
143  virtual uint32_t GetTxAvailable (void) const;
144  virtual int Send (Ptr<Packet> p, uint32_t flags);
145  virtual int SendTo (Ptr<Packet> p, uint32_t flags, const Address &toAddress);
146  virtual uint32_t GetRxAvailable (void) const;
147  virtual Ptr<Packet> Recv (uint32_t maxSize, uint32_t flags);
148  virtual Ptr<Packet> RecvFrom (uint32_t maxSize, uint32_t flags,
149  Address &fromAddress);
150  virtual int GetSockName (Address &address) const;
151  virtual int GetPeerName (Address &address) const;
152  virtual bool SetAllowBroadcast (bool allowBroadcast);
153  virtual bool GetAllowBroadcast () const;
155 private:
166  void ForwardUp (Ptr<NetDevice> device, Ptr<const Packet> packet,
167  uint16_t protocol, const Address &from, const Address &to,
168  NetDevice::PacketType packetType);
175  int DoBind (const PacketSocketAddress &address);
182  uint32_t GetMinMtu (PacketSocketAddress ad) const;
183  virtual void DoDispose (void);
188  enum State {
190  STATE_BOUND, // open and bound
191  STATE_CONNECTED, // open, bound and connected
193  };
196  mutable enum SocketErrno m_errno;
199  enum State m_state;
200  uint16_t m_protocol;
202  uint32_t m_device;
205  std::queue<std::pair<Ptr<Packet>, Address> > m_deliveryQueue;
206  uint32_t m_rxAvailable;
211  // Socket options (attributes)
212  uint32_t m_rcvBufSize;
214 };
219 class PacketSocketTag : public Tag
220 {
221 public:
225  PacketSocketTag ();
240  void SetDestAddress(Address a);
245  Address GetDestAddress (void) const;
251  static TypeId GetTypeId (void);
252  virtual TypeId GetInstanceTypeId (void) const;
253  virtual uint32_t GetSerializedSize (void) const;
254  virtual void Serialize (TagBuffer i) const;
255  virtual void Deserialize (TagBuffer i);
256  virtual void Print (std::ostream &os) const;
258 private:
261 };
265 class DeviceNameTag : public Tag
266 {
267 public:
271  DeviceNameTag ();
276  void SetDeviceName (std::string n);
281  std::string GetDeviceName (void) const;
286  static TypeId GetTypeId (void);
287  virtual TypeId GetInstanceTypeId (void) const;
288  virtual uint32_t GetSerializedSize (void) const;
289  virtual void Serialize (TagBuffer i) const;
290  virtual void Deserialize (TagBuffer i);
291  virtual void Print (std::ostream &os) const;
293 private:
294  std::string m_deviceName;
295 };
297 } // namespace ns3
299 #endif /* PACKET_SOCKET_H */
static TypeId GetTypeId(void)
Get the type ID.
virtual enum SocketErrno GetErrno(void) const
Get last error number.
Enumeration of the possible errors returned by a socket.
Definition: socket.h:82
std::string m_deviceName
Device name.
Address GetDestAddress(void) const
Get the destination address of the corresponding packet.
Ptr< Packet > Recv(void)
Read a single packet from the socket.
Definition: socket.cc:175
NetDevice::PacketType m_packetType
Packet type.
Address m_destAddr
Default destination address.
Forward calls to a chain of Callback.
an address for a packet 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.
Packet types are used as they are in Linux.
Definition: net-device.h:606
virtual void DoDispose(void)
Destructor implementation.
A PacketSocket is a link between an application and a net device.
Definition: packet-socket.h:93
virtual uint32_t GetSerializedSize(void) const
Enumeration of the possible socket types.
Definition: socket.h:104
void SetPacketType(NetDevice::PacketType t)
Set the packet type.
virtual int Bind(void)
Bind the socket to the NetDevice and register the protocol handler.
virtual void Print(std::ostream &os) const
uint32_t m_rxAvailable
Rx queue size [Bytes].
virtual int GetSockName(Address &address) const
Get socket address.
a polymophic address class
Definition: address.h:90
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Ptr< Node > m_node
the associated node
virtual void Serialize(TagBuffer i) const
virtual int GetPeerName(Address &address) const
Get the peer address of a connected socket.
A low-level Socket API based loosely on the BSD Socket API.
Definition: socket.h:66
virtual bool SetAllowBroadcast(bool allowBroadcast)
Configure whether broadcast datagram transmissions are allowed.
void SetDestAddress(Address a)
Set the destination address of the corresponding packet.
virtual int ShutdownRecv(void)
virtual void Deserialize(TagBuffer i)
enum State m_state
Socket state.
virtual uint32_t GetSerializedSize(void) const
static TypeId GetTypeId(void)
Get the type ID.
Create an empty PacketSocketTag.
bool m_isSingleDevice
Is bound to a single netDevice.
virtual Ptr< Node > GetNode(void) const
Return the node this socket is associated with.
virtual int Listen(void)
Listen for incoming connections.
States of the socket.
uint32_t m_device
index of the bound NetDevice
virtual uint32_t GetRxAvailable(void) const
Return number of bytes which can be returned from one or multiple calls to Recv.
tag a set of bytes in a packet
Definition: tag.h:36
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual int Send(Ptr< Packet > p, uint32_t flags)
Send data (or dummy data) to the remote host.
uint32_t m_rcvBufSize
Rx buffer size [Bytes].
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)
Send data to a specified peer.
bool m_shutdownSend
Send no longer allowed.
This class implements a tag that carries the ns3 device name from where a packet is coming...
virtual bool GetAllowBroadcast() const
Query whether broadcast datagram transmissions are allowed.
enum SocketErrno m_errno
Socket error code.
virtual void Deserialize(TagBuffer i)
virtual int Close(void)
Close a socket.
uint16_t m_protocol
Socket protocol.
Address m_destAddr
Destination address.
bool m_shutdownRecv
Receive no longer allowed.
void SetNode(Ptr< Node > node)
Set the associated node.
static TypeId GetTypeId(void)
Get the type ID.
read and write tag data
Definition: tag-buffer.h:51
int DoBind(const PacketSocketAddress &address)
Bind the socket to the NetDevice and register the protocol handler specified in the address...
virtual uint32_t GetTxAvailable(void) const
Returns the number of bytes which can be sent in a single call to Send.
virtual void Serialize(TagBuffer i) const
std::queue< std::pair< Ptr< Packet >, Address > > m_deliveryQueue
Rx queue.
virtual ~PacketSocket()
NetDevice::PacketType GetPacketType(void) const
Get the packet type.
virtual void Print(std::ostream &os) const
Create an empty DeviceNameTag.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
virtual int Connect(const Address &address)
Initiate a connection to a remote host.
uint32_t GetMinMtu(PacketSocketAddress ad) const
Get the minimum MTU supported by the NetDevices bound to a specific address.
virtual int Bind6(void)
Bind the socket to the NetDevice and register the protocol handler.
std::string GetDeviceName(void) const
Get the device name from where the corresponding packet is coming.
tuple address
Definition: first.py:37
This class implements a tag that carries the dest address of a packet and the packet type...
TracedCallback< Ptr< const Packet > > m_dropTrace
Traced callback: dropped packets.
virtual int ShutdownSend(void)
a unique identifier for an interface.
Definition: type-id.h:58
virtual enum SocketType GetSocketType(void) const
void ForwardUp(Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
Called by the L3 protocol when it received a packet to pass on to TCP.
void SetDeviceName(std::string n)
Set the device name.