A Discrete-Event Network Simulator
API
udp-l4-protocol.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006,2007 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
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef UDP_L4_PROTOCOL_H
22 #define UDP_L4_PROTOCOL_H
23 
24 #include <stdint.h>
25 
26 #include "ns3/packet.h"
27 #include "ns3/ptr.h"
28 #include "ip-l4-protocol.h"
29 
30 namespace ns3 {
31 
32 class Node;
33 class Socket;
34 class Ipv4EndPointDemux;
35 class Ipv4EndPoint;
36 class Ipv6EndPointDemux;
37 class Ipv6EndPoint;
38 class UdpSocketImpl;
39 class NetDevice;
40 
61 class UdpL4Protocol : public IpL4Protocol {
62 public:
67  static TypeId GetTypeId (void);
68  static const uint8_t PROT_NUMBER;
69 
70  UdpL4Protocol ();
71  virtual ~UdpL4Protocol ();
72 
77  void SetNode (Ptr<Node> node);
78 
79  virtual int GetProtocolNumber (void) const;
80 
86 
91  Ipv4EndPoint *Allocate (void);
104  Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice, uint16_t port);
112  Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice, Ipv4Address address, uint16_t port);
122  Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice,
123  Ipv4Address localAddress, uint16_t localPort,
124  Ipv4Address peerAddress, uint16_t peerPort);
125 
130  Ipv6EndPoint *Allocate6 (void);
143  Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice, uint16_t port);
151  Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice, Ipv6Address address, uint16_t port);
161  Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice,
162  Ipv6Address localAddress, uint16_t localPort,
163  Ipv6Address peerAddress, uint16_t peerPort);
164 
169  void DeAllocate (Ipv4EndPoint *endPoint);
174  void DeAllocate (Ipv6EndPoint *endPoint);
175 
176  // called by UdpSocket.
185  void Send (Ptr<Packet> packet,
186  Ipv4Address saddr, Ipv4Address daddr,
187  uint16_t sport, uint16_t dport);
197  void Send (Ptr<Packet> packet,
198  Ipv4Address saddr, Ipv4Address daddr,
199  uint16_t sport, uint16_t dport, Ptr<Ipv4Route> route);
208  void Send (Ptr<Packet> packet,
209  Ipv6Address saddr, Ipv6Address daddr,
210  uint16_t sport, uint16_t dport);
220  void Send (Ptr<Packet> packet,
221  Ipv6Address saddr, Ipv6Address daddr,
222  uint16_t sport, uint16_t dport, Ptr<Ipv6Route> route);
223 
224  // inherited from Ipv4L4Protocol
226  Ipv4Header const &header,
227  Ptr<Ipv4Interface> interface);
229  Ipv6Header const &header,
230  Ptr<Ipv6Interface> interface);
231 
232  virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,
233  uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
234  Ipv4Address payloadSource,Ipv4Address payloadDestination,
235  const uint8_t payload[8]);
236  virtual void ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl,
237  uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
238  Ipv6Address payloadSource,Ipv6Address payloadDestination,
239  const uint8_t payload[8]);
240 
241  // From IpL4Protocol
244  // From IpL4Protocol
245  virtual IpL4Protocol::DownTargetCallback GetDownTarget (void) const;
247 
248 protected:
249  virtual void DoDispose (void);
250  /*
251  * This function will notify other components connected to the node that a new stack member is now connected
252  * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.
253  */
254  virtual void NotifyNewAggregate ();
255 private:
259 
265  UdpL4Protocol (const UdpL4Protocol &);
273 
274  std::vector<Ptr<UdpSocketImpl> > m_sockets;
277 
278 };
279 
280 } // namespace ns3
281 
282 #endif /* UDP_L4_PROTOCOL_H */
Packet header for IPv6.
Definition: ipv6-header.h:34
Ptr< Socket > CreateSocket(void)
virtual void DoDispose(void)
Destructor implementation.
virtual void SetDownTarget(IpL4Protocol::DownTargetCallback cb)
This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 ca...
UdpL4Protocol & operator=(const UdpL4Protocol &)
Copy constructor.
virtual IpL4Protocol::DownTargetCallback GetDownTarget(void) const
This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 ca...
Ptr< Node > m_node
the node this stack is associated with
virtual void SetDownTarget6(IpL4Protocol::DownTargetCallback6 cb)
This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 ca...
void SetNode(Ptr< Node > node)
Set node associated with this stack.
uint16_t port
Definition: dsdv-manet.cc:45
Demultiplexes packets to various transport layer endpoints.
Packet header for IPv4.
Definition: ipv4-header.h:33
virtual enum IpL4Protocol::RxStatus Receive(Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > interface)
Called from lower-level layers to send the packet up in the stack.
Ipv4EndPoint * Allocate(void)
Allocate an IPv4 Endpoint.
static TypeId GetTypeId(void)
Get the type ID.
virtual int GetProtocolNumber(void) const
Returns the protocol number of this protocol.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void ReceiveIcmp(Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv4Address payloadSource, Ipv4Address payloadDestination, const uint8_t payload[8])
Called from lower-level layers to send the ICMP packet up in the stack.
address
Definition: first.py:37
Ipv6EndPointDemux * m_endPoints6
A list of IPv6 end points.
L4 Protocol abstract base class.
void DeAllocate(Ipv4EndPoint *endPoint)
Remove an IPv4 Endpoint.
IpL4Protocol::DownTargetCallback6 m_downTarget6
Callback to send packets over IPv6.
virtual IpL4Protocol::DownTargetCallback6 GetDownTarget6(void) const
This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 ca...
Describes an IPv6 address.
Definition: ipv6-address.h:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
IpL4Protocol::DownTargetCallback m_downTarget
Callback to send packets over IPv4.
virtual void NotifyNewAggregate()
Notify all Objects aggregated to this one of a new Object being aggregated.
Implementation of the UDP protocol.
Demultiplexer for end points.
std::vector< Ptr< UdpSocketImpl > > m_sockets
list of sockets
A representation of an IPv6 endpoint/connection.
Ipv4EndPointDemux * m_endPoints
A list of IPv4 end points.
void Send(Ptr< Packet > packet, Ipv4Address saddr, Ipv4Address daddr, uint16_t sport, uint16_t dport)
Send a packet via UDP (IPv4)
Ipv6EndPoint * Allocate6(void)
Allocate an IPv6 Endpoint.
RxStatus
Rx status codes.
a unique identifier for an interface.
Definition: type-id.h:58
static const uint8_t PROT_NUMBER
protocol number (0x11)
A representation of an internet endpoint/connection.