A Discrete-Event Network Simulator
API
ipv6-raw-socket-impl.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007-2009 Strasbourg University
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
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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  * Author: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
19  */
20 
21 #ifndef IPV6_RAW_SOCKET_IMPL_H
22 #define IPV6_RAW_SOCKET_IMPL_H
23 
24 #include <list>
25 
26 #include "ns3/socket.h"
27 #include "ns3/ipv6-address.h"
28 #include "ns3/ipv6-header.h"
29 
30 namespace ns3
31 {
32 
33 class NetDevice;
34 class Node;
35 
66 class Ipv6RawSocketImpl : public Socket
67 {
68 public:
73  static TypeId GetTypeId ();
74 
76  virtual ~Ipv6RawSocketImpl ();
77 
82  void SetNode (Ptr<Node> node);
83 
84  virtual enum Socket::SocketErrno GetErrno () const;
85 
90  virtual enum Socket::SocketType GetSocketType () const;
91 
92  virtual Ptr<Node> GetNode () const;
93 
94  virtual int Bind (const Address& address);
95  virtual int Bind ();
96  virtual int Bind6 ();
97 
98  virtual int GetSockName (Address& address) const;
99  virtual int GetPeerName (Address& address) const;
100 
101  virtual int Close ();
102  virtual int ShutdownSend ();
103  virtual int ShutdownRecv ();
104  virtual int Connect (const Address& address);
105  virtual int Listen ();
106  virtual uint32_t GetTxAvailable () const;
107  virtual uint32_t GetRxAvailable () const;
108  virtual int Send (Ptr<Packet> p, uint32_t flags);
109  virtual int SendTo (Ptr<Packet> p, uint32_t flags, const Address& toAddress);
110  virtual Ptr<Packet> Recv (uint32_t maxSize, uint32_t flags);
111  virtual Ptr<Packet> RecvFrom (uint32_t maxSize, uint32_t flags, Address& fromAddress);
112  virtual void Ipv6JoinGroup (Ipv6Address address, Socket::Ipv6MulticastFilterMode filterMode, std::vector<Ipv6Address> sourceAddresses);
113 
118  void SetProtocol (uint16_t protocol);
119 
128 
129  virtual bool SetAllowBroadcast (bool allowBroadcast);
130  virtual bool GetAllowBroadcast () const;
131 
135  void Icmpv6FilterSetPassAll();
136 
141 
146  void Icmpv6FilterSetPass(uint8_t type);
147 
152  void Icmpv6FilterSetBlock(uint8_t type);
153 
159  bool Icmpv6FilterWillPass(uint8_t type);
160 
166  bool Icmpv6FilterWillBlock(uint8_t type);
167 
168 
169 private:
173  typedef struct
174  {
177  uint16_t fromProtocol;
178  } Data;
179 
183  virtual void DoDispose ();
184 
189 
194 
199 
204 
208  uint16_t m_protocol;
209 
213  std::list<Data> m_data;
214 
219 
224 
228  typedef struct
229  {
230  uint32_t icmpv6Filt[8];
231  } Icmpv6Filter;
232 
237 };
238 
239 } /* namespace ns3 */
240 
241 #endif /* IPV6_RAW_SOCKET_IMPL_H */
242 
void SetNode(Ptr< Node > node)
Set the node associated with this socket.
Packet header for IPv6.
Definition: ipv6-header.h:34
virtual void Ipv6JoinGroup(Ipv6Address address, Socket::Ipv6MulticastFilterMode filterMode, std::vector< Ipv6Address > sourceAddresses)
Joins a IPv6 multicast group.
virtual void DoDispose()
Dispose object.
virtual int Connect(const Address &address)
Initiate a connection to a remote host.
Ipv6Address fromIp
Source address.
Ipv6Address m_src
Source address.
Ptr< Packet > Recv(void)
Read a single packet from the socket.
Definition: socket.cc:175
Icmpv6Filter m_icmpFilter
ICMPv6 filter.
bool m_shutdownSend
Flag to shutdown send capability.
std::list< Data > m_data
Packet waiting to be processed.
virtual enum Socket::SocketType GetSocketType() const
Get socket type (NS3_SOCK_RAW)
uint16_t fromProtocol
Protocol used.
Ptr< Packet > packet
Packet data.
static TypeId GetTypeId()
Get the type ID of this class.
bool ForwardUp(Ptr< const Packet > p, Ipv6Header hdr, Ptr< NetDevice > device)
Forward up to receive method.
SocketErrno
Enumeration of the possible errors returned by a socket.
Definition: socket.h:82
virtual Ptr< Node > GetNode() const
Return the node this socket is associated with.
virtual int Send(Ptr< Packet > p, uint32_t flags)
Send data (or dummy data) to the remote host.
a polymophic address class
Definition: address.h:90
virtual int Bind()
Allocate a local IPv4 endpoint for this socket.
bool m_shutdownRecv
Flag to shutdown receive capability.
A low-level Socket API based loosely on the BSD Socket API.
Definition: socket.h:66
Ipv6MulticastFilterMode
Enumeration of the possible filter of a socket.
Definition: socket.h:138
Struct to hold the ICMPv6 filter.
void Icmpv6FilterSetBlock(uint8_t type)
Set the filter to block one ICMPv6 type.
virtual int Bind6()
Allocate a local IPv6 endpoint for this socket.
IPv6 raw data and additional information.
virtual int Listen()
Listen for incoming connections.
virtual uint32_t GetRxAvailable() const
Return number of bytes which can be returned from one or multiple calls to Recv.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
address
Definition: first.py:37
bool Icmpv6FilterWillBlock(uint8_t type)
Ask the filter about the status of one ICMPv6 type.
void Icmpv6FilterSetPass(uint8_t type)
Set the filter to pass one ICMPv6 type.
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 bool SetAllowBroadcast(bool allowBroadcast)
Configure whether broadcast datagram transmissions are allowed.
virtual bool GetAllowBroadcast() const
Query whether broadcast datagram transmissions are allowed.
void SetProtocol(uint16_t protocol)
Set protocol field.
virtual int GetPeerName(Address &address) const
Get the peer address of a connected socket.
Describes an IPv6 address.
Definition: ipv6-address.h:49
enum Socket::SocketErrno m_err
Last error number.
virtual int GetSockName(Address &address) const
Get socket address.
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)
Send data to a specified peer.
virtual int Close()
Close a socket.
virtual enum Socket::SocketErrno GetErrno() const
Get last error number.
Ipv6Address m_dst
Destination address.
bool Icmpv6FilterWillPass(uint8_t type)
Ask the filter about the status of one ICMPv6 type.
void Icmpv6FilterSetPassAll()
Clean the ICMPv6 filter structure.
virtual uint32_t GetTxAvailable() const
Returns the number of bytes which can be sent in a single call to Send.
SocketType
Enumeration of the possible socket types.
Definition: socket.h:104
a unique identifier for an interface.
Definition: type-id.h:58
uint16_t m_protocol
Protocol.
void Icmpv6FilterSetBlockAll()
Set the filter to block all the ICMPv6 types.