A Discrete-Event Network Simulator
API
ip-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) 2006 Georgia Tech Research Corporation
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: George F. Riley<riley@ece.gatech.edu>
19//
20
21// NS3 - Layer 4 Protocol base class
22// George F. Riley, Georgia Tech, Spring 2007
23
24#ifndef IP_L4_PROTOCOL_H
25#define IP_L4_PROTOCOL_H
26
27#include "ns3/object.h"
28#include "ns3/callback.h"
29#include "ipv4-header.h"
30#include "ipv6-header.h"
31
32namespace ns3 {
33
34class Packet;
35class Ipv4Address;
36class Ipv4Interface;
37class Ipv6Address;
38class Ipv6Interface;
39class Ipv4Route;
40class Ipv6Route;
41
50class IpL4Protocol : public Object
51{
52public:
56 enum RxStatus {
61 };
62
67 static TypeId GetTypeId (void);
68
69 virtual ~IpL4Protocol ();
70
75 virtual int GetProtocolNumber (void) const = 0;
76
84 virtual enum RxStatus Receive (Ptr<Packet> p,
85 Ipv4Header const &header,
86 Ptr<Ipv4Interface> incomingInterface) = 0;
87
95 virtual enum RxStatus Receive (Ptr<Packet> p,
96 Ipv6Header const &header,
97 Ptr<Ipv6Interface> incomingInterface) = 0;
98
114 virtual void ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,
115 uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
116 Ipv4Address payloadSource, Ipv4Address payloadDestination,
117 const uint8_t payload[8]);
118
119
135 virtual void ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl,
136 uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo,
137 Ipv6Address payloadSource, Ipv6Address payloadDestination,
138 const uint8_t payload[8]);
139
148
155 virtual void SetDownTarget (DownTargetCallback cb) = 0;
156
163 virtual void SetDownTarget6 (DownTargetCallback6 cb) = 0;
164
171 virtual DownTargetCallback GetDownTarget (void) const = 0;
172
179 virtual DownTargetCallback6 GetDownTarget6 (void) const = 0;
180};
181
182} // Namespace ns3
183
184#endif
Callback template class.
Definition: callback.h:422
L4 Protocol abstract base class.
Callback< void, Ptr< Packet >, Ipv6Address, Ipv6Address, uint8_t, Ptr< Ipv6Route > > DownTargetCallback6
callback to send packets over IPv6
virtual enum RxStatus Receive(Ptr< Packet > p, Ipv6Header const &header, Ptr< Ipv6Interface > incomingInterface)=0
Called from lower-level layers to send the packet up in the stack.
virtual DownTargetCallback6 GetDownTarget6(void) const =0
This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 ca...
virtual void SetDownTarget6(DownTargetCallback6 cb)=0
This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 ca...
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.
static TypeId GetTypeId(void)
Get the type ID.
virtual ~IpL4Protocol()
virtual void SetDownTarget(DownTargetCallback cb)=0
This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 ca...
virtual int GetProtocolNumber(void) const =0
Returns the protocol number of this protocol.
virtual DownTargetCallback GetDownTarget(void) const =0
This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 ca...
virtual enum RxStatus Receive(Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface)=0
Called from lower-level layers to send the packet up in the stack.
Callback< void, Ptr< Packet >, Ipv4Address, Ipv4Address, uint8_t, Ptr< Ipv4Route > > DownTargetCallback
callback to send packets over IPv4
RxStatus
Rx status codes.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
Packet header for IPv4.
Definition: ipv4-header.h:34
Describes an IPv6 address.
Definition: ipv6-address.h:50
Packet header for IPv6.
Definition: ipv6-header.h:36
A base class which provides memory management and object aggregation.
Definition: object.h:88
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.