A Discrete-Event Network Simulator
API
ipv4-end-point.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005 INRIA
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18  */
19 
20 #ifndef IPV4_END_POINT_H
21 #define IPV4_END_POINT_H
22 
23 #include "ipv4-header.h"
24 #include "ipv4-interface.h"
25 
26 #include "ns3/callback.h"
27 #include "ns3/ipv4-address.h"
28 #include "ns3/net-device.h"
29 
30 #include <stdint.h>
31 
32 namespace ns3
33 {
34 
35 class Header;
36 class Packet;
37 
52 {
53  public:
60  ~Ipv4EndPoint();
61 
67 
73 
78  uint16_t GetLocalPort() const;
79 
85 
90  uint16_t GetPeerPort() const;
91 
97  void SetPeer(Ipv4Address address, uint16_t port);
98 
117  void BindToNetDevice(Ptr<NetDevice> netdevice);
118 
129 
130  // Called from socket implementations to get notified about important events.
135  void SetRxCallback(
136  Callback<void, Ptr<Packet>, Ipv4Header, uint16_t, Ptr<Ipv4Interface>> callback);
146  void SetDestroyCallback(Callback<void> callback);
147 
158  void ForwardUp(Ptr<Packet> p,
159  const Ipv4Header& header,
160  uint16_t sport,
161  Ptr<Ipv4Interface> incomingInterface);
162 
175  void ForwardIcmp(Ipv4Address icmpSource,
176  uint8_t icmpTtl,
177  uint8_t icmpType,
178  uint8_t icmpCode,
179  uint32_t icmpInfo);
180 
185  void SetRxEnabled(bool enabled);
186 
191  bool IsRxEnabled() const;
192 
193  private:
198 
202  uint16_t m_localPort;
203 
208 
212  uint16_t m_peerPort;
213 
218 
223 
228 
233 
238 };
239 
240 } // namespace ns3
241 
242 #endif /* IPV4_END_POINT_H */
Callback template class.
Definition: callback.h:438
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
A representation of an internet endpoint/connection.
bool m_rxEnabled
true if the endpoint can receive packets.
void BindToNetDevice(Ptr< NetDevice > netdevice)
Bind a socket to specific device.
Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t > m_icmpCallback
The ICMPv6 callback.
void SetDestroyCallback(Callback< void > callback)
Set the default destroy callback.
Ipv4Address GetLocalAddress() const
Get the local address.
void SetLocalAddress(Ipv4Address address)
Set the local address.
uint16_t GetPeerPort() const
Get the peer port.
void ForwardUp(Ptr< Packet > p, const Ipv4Header &header, uint16_t sport, Ptr< Ipv4Interface > incomingInterface)
Forward the packet to the upper level.
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.
Ptr< NetDevice > GetBoundNetDevice() const
Returns socket's bound netdevice, if any.
Ipv4EndPoint(Ipv4Address address, uint16_t port)
Constructor.
uint16_t GetLocalPort() const
Get the local port.
bool IsRxEnabled() const
Checks if the endpoint can receive packets.
void SetRxEnabled(bool enabled)
Enable or Disable the endpoint Rx capability.
Ipv4Address GetPeerAddress() const
Get the peer address.
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).
Ipv4Address m_localAddr
The local address.
Callback< void > m_destroyCallback
The destroy callback.
Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface > > m_rxCallback
The RX callback.
void SetRxCallback(Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface >> callback)
Set the reception callback.
Packet header for IPv4.
Definition: ipv4-header.h:34
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
uint16_t port
Definition: dsdv-manet.cc:44
address
Definition: first.py:47
Every class exported by the ns3 library is enclosed in the ns3 namespace.