/usr/include/ns3/ipv4-l4-protocol.h is in libns3-dev 3.13+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 | // -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*-
//
// Copyright (c) 2006 Georgia Tech Research Corporation
//
// 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: George F. Riley<riley@ece.gatech.edu>
//
// NS3 - Layer 4 Protocol base class
// George F. Riley, Georgia Tech, Spring 2007
#ifndef IPV4_L4_PROTOCOL_H
#define IPV4_L4_PROTOCOL_H
#include "ns3/object.h"
#include "ns3/callback.h"
#include "ns3/ipv4-header.h"
namespace ns3 {
class Packet;
class Ipv4Address;
class Ipv4Interface;
class Ipv4Route;
/**
* \brief L4 Protocol abstract base class
*
* This is an abstract base class for layer four protocols which use IPv4 as
* the network layer.
*/
class Ipv4L4Protocol : public Object
{
public:
enum RxStatus {
RX_OK,
RX_CSUM_FAILED,
RX_ENDPOINT_CLOSED,
RX_ENDPOINT_UNREACH
};
static TypeId GetTypeId (void);
virtual ~Ipv4L4Protocol ();
/**
* \returns the protocol number of this protocol.
*/
virtual int GetProtocolNumber (void) const = 0;
/**
* \param p packet to forward up
* \param header IPv4 Header information
* \param incomingInterface the Ipv4Interface on which the packet arrived
*
* Called from lower-level layers to send the packet up
* in the stack.
*/
virtual enum RxStatus Receive (Ptr<Packet> p,
Ipv4Header const &header,
Ptr<Ipv4Interface> incomingInterface) = 0;
/**
* \param icmpSource the source address of the icmp message
* \param icmpTtl the ttl of the icmp message
* \param icmpType the 'type' field of the icmp message
* \param icmpCode the 'code' field of the icmp message
* \param icmpInfo extra information dependent on the icmp message
* generated by Icmpv4L4Protocol
* \param payloadSource the source address of the packet which triggered
* the icmp message
* \param payloadDestination the destination address of the packet which
* triggered the icmp message.
* \param payload the first 8 bytes of the udp header of the packet
* which triggered the icmp message.
*/
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]);
typedef Callback<void,Ptr<Packet>, Ipv4Address, Ipv4Address, uint8_t, Ptr<Ipv4Route> > DownTargetCallback;
/**
* This method allows a caller to set the current down target callback
* set for this L4 protocol
*
* \param cb current Callback for the L4 protocol
*/
virtual void SetDownTarget (DownTargetCallback cb) = 0;
/**
* This method allows a caller to get the current down target callback
* set for this L4 protocol, for
*
* \return current Callback for the L4 protocol
*/
virtual DownTargetCallback GetDownTarget (void) const = 0;
};
} // Namespace ns3
#endif
|