A Discrete-Event Network Simulator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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;
78 class PacketSocket : public Socket
79 {
80 public:
85  static TypeId GetTypeId (void);
87  PacketSocket ();
88  virtual ~PacketSocket ();
94  void SetNode (Ptr<Node> node);
96  virtual enum SocketErrno GetErrno (void) const;
97  virtual enum SocketType GetSocketType (void) const;
98  virtual Ptr<Node> GetNode (void) const;
106  virtual int Bind (void);
114  virtual int Bind6 (void);
122  virtual int Bind (const Address & address);
123  virtual int Close (void);
124  virtual int ShutdownSend (void);
125  virtual int ShutdownRecv (void);
126  virtual int Connect (const Address &address);
127  virtual int Listen (void);
128  virtual uint32_t GetTxAvailable (void) const;
129  virtual int Send (Ptr<Packet> p, uint32_t flags);
130  virtual int SendTo (Ptr<Packet> p, uint32_t flags, const Address &toAddress);
131  virtual uint32_t GetRxAvailable (void) const;
132  virtual Ptr<Packet> Recv (uint32_t maxSize, uint32_t flags);
133  virtual Ptr<Packet> RecvFrom (uint32_t maxSize, uint32_t flags,
134  Address &fromAddress);
135  virtual int GetSockName (Address &address) const;
136  virtual bool SetAllowBroadcast (bool allowBroadcast);
137  virtual bool GetAllowBroadcast () const;
139 private:
150  void ForwardUp (Ptr<NetDevice> device, Ptr<const Packet> packet,
151  uint16_t protocol, const Address &from, const Address &to,
152  NetDevice::PacketType packetType);
159  int DoBind (const PacketSocketAddress &address);
166  uint32_t GetMinMtu (PacketSocketAddress ad) const;
167  virtual void DoDispose (void);
172  enum State {
174  STATE_BOUND, // open and bound
175  STATE_CONNECTED, // open, bound and connected
177  };
183  enum State m_state;
184  uint16_t m_protocol;
186  uint32_t m_device;
189  std::queue<Ptr<Packet> > m_deliveryQueue;
190  uint32_t m_rxAvailable;
195  // Socket options (attributes)
196  uint32_t m_rcvBufSize;
198 };
203 class PacketSocketTag : public Tag
204 {
205 public:
209  PacketSocketTag ();
224  void SetDestAddress(Address a);
229  Address GetDestAddress (void) const;
235  static TypeId GetTypeId (void);
236  virtual TypeId GetInstanceTypeId (void) const;
237  virtual uint32_t GetSerializedSize (void) const;
238  virtual void Serialize (TagBuffer i) const;
239  virtual void Deserialize (TagBuffer i);
240  virtual void Print (std::ostream &os) const;
242 private:
245 };
249 class DeviceNameTag : public Tag
250 {
251 public:
255  DeviceNameTag ();
260  void SetDeviceName (std::string n);
265  std::string GetDeviceName (void) const;
270  static TypeId GetTypeId (void);
271  virtual TypeId GetInstanceTypeId (void) const;
272  virtual uint32_t GetSerializedSize (void) const;
273  virtual void Serialize (TagBuffer i) const;
274  virtual void Deserialize (TagBuffer i);
275  virtual void Print (std::ostream &os) const;
277 private:
278  std::string m_deviceName;
279 };
281 } // namespace ns3
283 #endif /* PACKET_SOCKET_H */
static TypeId GetTypeId(void)
Get the type ID.
virtual enum SocketErrno GetErrno(void) const
Get last error number.
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:174
NetDevice::PacketType m_packetType
Packet type.
Address m_destAddr
Default destination address.
forward calls to a chain of CallbackAn ns3::TracedCallback has almost exactly the same API as a norma...
std::queue< Ptr< Packet > > m_deliveryQueue
Rx queue.
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.
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
A PacketSocket is a link between an application and a net device.
Definition: packet-socket.h:78
virtual uint32_t GetSerializedSize(void) const
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.
Enumeration of the possible errors returned by a socket.
Definition: socket.h:82
a polymophic address class
Definition: address.h:86
virtual TypeId GetInstanceTypeId(void) const
Ptr< Node > m_node
the associated node
virtual void Serialize(TagBuffer i) const
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.
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
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].
States of the socket.
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
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
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
Packet types are used as they are in Linux.
Definition: net-device.h:274
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)
Enumeration of the possible socket types.
Definition: socket.h:104
a unique identifier for an interface.
Definition: type-id.h:49
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.