A Discrete-Event Network Simulator
API
ipv4-end-point.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2005 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 IPV4_END_POINT_H
22#define IPV4_END_POINT_H
23
24#include <stdint.h>
25#include "ns3/ipv4-address.h"
26#include "ns3/callback.h"
27#include "ns3/net-device.h"
28#include "ns3/ipv4-header.h"
29#include "ns3/ipv4-interface.h"
30
31namespace ns3 {
32
33class Header;
34class Packet;
35
50public:
58
64
70
75 uint16_t GetLocalPort (void);
76
82
87 uint16_t GetPeerPort (void);
88
94 void SetPeer (Ipv4Address address, uint16_t port);
95
114 void BindToNetDevice (Ptr<NetDevice> netdevice);
115
126
127 // Called from socket implementations to get notified about important events.
132 void SetRxCallback (Callback<void,Ptr<Packet>, Ipv4Header, uint16_t, Ptr<Ipv4Interface> > callback);
142 void SetDestroyCallback (Callback<void> callback);
143
154 void ForwardUp (Ptr<Packet> p, const Ipv4Header& header, uint16_t sport,
155 Ptr<Ipv4Interface> incomingInterface);
156
169 void ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl,
170 uint8_t icmpType, uint8_t icmpCode,
171 uint32_t icmpInfo);
172
177 void SetRxEnabled (bool enabled);
178
183 bool IsRxEnabled (void);
184
185private:
190
194 uint16_t m_localPort;
195
200
204 uint16_t m_peerPort;
205
210
215
220
225
230};
231
232} // namespace ns3
233
234
235#endif /* IPV4_END_POINT_H */
Callback template class.
Definition: callback.h:1279
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
A representation of an internet endpoint/connection.
uint16_t GetPeerPort(void)
Get the peer port.
bool m_rxEnabled
true if the endpoint can receive packets.
void BindToNetDevice(Ptr< NetDevice > netdevice)
Bind a socket to specific device.
void SetDestroyCallback(Callback< void > callback)
Set the default destroy callback.
void SetLocalAddress(Ipv4Address address)
Set the local address.
void ForwardUp(Ptr< Packet > p, const Ipv4Header &header, uint16_t sport, Ptr< Ipv4Interface > incomingInterface)
Forward the packet to the upper level.
Ipv4Address GetPeerAddress(void)
Get the peer address.
Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t > m_icmpCallback
The ICMPv6 callback.
void ForwardIcmp(Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
Forward the ICMP packet to the upper level.
uint16_t m_localPort
The local port.
Ipv4EndPoint(Ipv4Address address, uint16_t port)
Constructor.
void SetRxEnabled(bool enabled)
Enable or Disable the endpoint Rx capability.
Ptr< NetDevice > GetBoundNetDevice(void)
Returns socket's bound netdevice, if any.
Ipv4Address m_peerAddr
The peer address.
uint16_t m_peerPort
The peer port.
Ptr< NetDevice > m_boundnetdevice
The NetDevice the EndPoint is bound to (if any).
void SetIcmpCallback(Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t > callback)
Set the ICMP callback.
void SetPeer(Ipv4Address address, uint16_t port)
Set the peer information (address and port).
uint16_t GetLocalPort(void)
Get the local port.
void SetRxCallback(Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface > > callback)
Set the reception callback.
Ipv4Address m_localAddr
The local address.
bool IsRxEnabled(void)
Checks if the endpoint can receive packets.
Callback< void > m_destroyCallback
The destroy callback.
Ipv4Address GetLocalAddress(void)
Get the local address.
Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface > > m_rxCallback
The RX callback.
Packet header for IPv4.
Definition: ipv4-header.h:34
uint16_t port
Definition: dsdv-manet.cc:45
address
Definition: first.py:40
Every class exported by the ns3 library is enclosed in the ns3 namespace.