/usr/include/ns3.27/ns3/udp-l4-protocol.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2005,2006,2007 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef UDP_L4_PROTOCOL_H
#define UDP_L4_PROTOCOL_H
#include <stdint.h>
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ip-l4-protocol.h"
namespace ns3 {
class Node;
class Socket;
class Ipv4EndPointDemux;
class Ipv4EndPoint;
class Ipv6EndPointDemux;
class Ipv6EndPoint;
class UdpSocketImpl;
class NetDevice;
/**
* \ingroup internet
* \defgroup udp UDP
*
* This is an implementation of the User Datagram Protocol described in
* \RFC{768}. It implements a connectionless, unreliable datagram packet
* service. Packets may be reordered or duplicated before they arrive.
* UDP generates and checks checksums to catch transmission errors.
*
* The following options are not presently part of this implementation:
* UDP_CORK, MSG_DONTROUTE, path MTU discovery control (e.g.
* IP_MTU_DISCOVER). MTU handling is also weak in ns-3 for the moment;
* it is best to send datagrams that do not exceed 1500 byte MTU (e.g.
* 1472 byte UDP datagrams)
*/
/**
* \ingroup udp
* \brief Implementation of the UDP protocol
*/
class UdpL4Protocol : public IpL4Protocol {
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
static const uint8_t PROT_NUMBER; //!< protocol number (0x11)
UdpL4Protocol ();
virtual ~UdpL4Protocol ();
/**
* Set node associated with this stack
* \param node the node
*/
void SetNode (Ptr<Node> node);
virtual int GetProtocolNumber (void) const;
/**
* \return A smart Socket pointer to a UdpSocket, allocated by this instance
* of the UDP protocol
*/
Ptr<Socket> CreateSocket (void);
/**
* \brief Allocate an IPv4 Endpoint
* \return the Endpoint
*/
Ipv4EndPoint *Allocate (void);
/**
* \brief Allocate an IPv4 Endpoint
* \param address address to use
* \return the Endpoint
*/
Ipv4EndPoint *Allocate (Ipv4Address address);
/**
* \brief Allocate an IPv4 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param port port to use
* \return the Endpoint
*/
Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice, uint16_t port);
/**
* \brief Allocate an IPv4 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param address address to use
* \param port port to use
* \return the Endpoint
*/
Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice, Ipv4Address address, uint16_t port);
/**
* \brief Allocate an IPv4 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param localAddress local address to use
* \param localPort local port to use
* \param peerAddress remote address to use
* \param peerPort remote port to use
* \return the Endpoint
*/
Ipv4EndPoint *Allocate (Ptr<NetDevice> boundNetDevice,
Ipv4Address localAddress, uint16_t localPort,
Ipv4Address peerAddress, uint16_t peerPort);
/**
* \brief Allocate an IPv6 Endpoint
* \return the Endpoint
*/
Ipv6EndPoint *Allocate6 (void);
/**
* \brief Allocate an IPv6 Endpoint
* \param address address to use
* \return the Endpoint
*/
Ipv6EndPoint *Allocate6 (Ipv6Address address);
/**
* \brief Allocate an IPv6 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param port port to use
* \return the Endpoint
*/
Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice, uint16_t port);
/**
* \brief Allocate an IPv6 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param address address to use
* \param port port to use
* \return the Endpoint
*/
Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice, Ipv6Address address, uint16_t port);
/**
* \brief Allocate an IPv6 Endpoint
* \param boundNetDevice Bound NetDevice (if any)
* \param localAddress local address to use
* \param localPort local port to use
* \param peerAddress remote address to use
* \param peerPort remote port to use
* \return the Endpoint
*/
Ipv6EndPoint *Allocate6 (Ptr<NetDevice> boundNetDevice,
Ipv6Address localAddress, uint16_t localPort,
Ipv6Address peerAddress, uint16_t peerPort);
/**
* \brief Remove an IPv4 Endpoint.
* \param endPoint the end point to remove
*/
void DeAllocate (Ipv4EndPoint *endPoint);
/**
* \brief Remove an IPv6 Endpoint.
* \param endPoint the end point to remove
*/
void DeAllocate (Ipv6EndPoint *endPoint);
// called by UdpSocket.
/**
* \brief Send a packet via UDP (IPv4)
* \param packet The packet to send
* \param saddr The source Ipv4Address
* \param daddr The destination Ipv4Address
* \param sport The source port number
* \param dport The destination port number
*/
void Send (Ptr<Packet> packet,
Ipv4Address saddr, Ipv4Address daddr,
uint16_t sport, uint16_t dport);
/**
* \brief Send a packet via UDP (IPv4)
* \param packet The packet to send
* \param saddr The source Ipv4Address
* \param daddr The destination Ipv4Address
* \param sport The source port number
* \param dport The destination port number
* \param route The route
*/
void Send (Ptr<Packet> packet,
Ipv4Address saddr, Ipv4Address daddr,
uint16_t sport, uint16_t dport, Ptr<Ipv4Route> route);
/**
* \brief Send a packet via UDP (IPv6)
* \param packet The packet to send
* \param saddr The source Ipv4Address
* \param daddr The destination Ipv4Address
* \param sport The source port number
* \param dport The destination port number
*/
void Send (Ptr<Packet> packet,
Ipv6Address saddr, Ipv6Address daddr,
uint16_t sport, uint16_t dport);
/**
* \brief Send a packet via UDP (IPv6)
* \param packet The packet to send
* \param saddr The source Ipv4Address
* \param daddr The destination Ipv4Address
* \param sport The source port number
* \param dport The destination port number
* \param route The route
*/
void Send (Ptr<Packet> packet,
Ipv6Address saddr, Ipv6Address daddr,
uint16_t sport, uint16_t dport, Ptr<Ipv6Route> route);
// inherited from Ipv4L4Protocol
virtual enum IpL4Protocol::RxStatus Receive (Ptr<Packet> p,
Ipv4Header const &header,
Ptr<Ipv4Interface> interface);
virtual enum IpL4Protocol::RxStatus Receive (Ptr<Packet> p,
Ipv6Header const &header,
Ptr<Ipv6Interface> interface);
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]);
virtual void ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl,
uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
Ipv6Address payloadSource,Ipv6Address payloadDestination,
const uint8_t payload[8]);
// From IpL4Protocol
virtual void SetDownTarget (IpL4Protocol::DownTargetCallback cb);
virtual void SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb);
// From IpL4Protocol
virtual IpL4Protocol::DownTargetCallback GetDownTarget (void) const;
virtual IpL4Protocol::DownTargetCallback6 GetDownTarget6 (void) const;
protected:
virtual void DoDispose (void);
/*
* This function will notify other components connected to the node that a new stack member is now connected
* This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.
*/
virtual void NotifyNewAggregate ();
private:
Ptr<Node> m_node; //!< the node this stack is associated with
Ipv4EndPointDemux *m_endPoints; //!< A list of IPv4 end points.
Ipv6EndPointDemux *m_endPoints6; //!< A list of IPv6 end points.
/**
* \brief Copy constructor
*
* Defined and not implemented to avoid misuse
*/
UdpL4Protocol (const UdpL4Protocol &);
/**
* \brief Copy constructor
*
* Defined and not implemented to avoid misuse
* \returns
*/
UdpL4Protocol &operator = (const UdpL4Protocol &);
std::vector<Ptr<UdpSocketImpl> > m_sockets; //!< list of sockets
IpL4Protocol::DownTargetCallback m_downTarget; //!< Callback to send packets over IPv4
IpL4Protocol::DownTargetCallback6 m_downTarget6; //!< Callback to send packets over IPv6
};
} // namespace ns3
#endif /* UDP_L4_PROTOCOL_H */
|