A Discrete-Event Network Simulator
API
ipv6-end-point.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007-2009 Strasbourg University
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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
18  */
19 
20 #ifndef IPV6_END_POINT_H
21 #define IPV6_END_POINT_H
22 
23 #include "ipv6-header.h"
24 #include "ipv6-interface.h"
25 
26 #include "ns3/callback.h"
27 #include "ns3/ipv6-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 
51 {
52  public:
58  Ipv6EndPoint(Ipv6Address addr, uint16_t port);
59 
60  ~Ipv6EndPoint();
61 
67 
72  void SetLocalAddress(Ipv6Address addr);
73 
78  uint16_t GetLocalPort() const;
79 
84  void SetLocalPort(uint16_t port);
85 
91 
96  uint16_t GetPeerPort() const;
97 
103  void SetPeer(Ipv6Address addr, uint16_t port);
104 
123  void BindToNetDevice(Ptr<NetDevice> netdevice);
124 
135 
140  void SetRxCallback(
141  Callback<void, Ptr<Packet>, Ipv6Header, uint16_t, Ptr<Ipv6Interface>> callback);
142 
148 
153  void SetDestroyCallback(Callback<void> callback);
154 
166  void ForwardUp(Ptr<Packet> p,
167  Ipv6Header header,
168  uint16_t port,
169  Ptr<Ipv6Interface> incomingInterface);
170 
183  void ForwardIcmp(Ipv6Address src, uint8_t ttl, uint8_t type, uint8_t code, uint32_t info);
184 
189  void SetRxEnabled(bool enabled);
190 
195  bool IsRxEnabled() const;
196 
197  private:
202 
206  uint16_t m_localPort;
207 
212 
216  uint16_t m_peerPort;
217 
222 
227 
232 
237 
242 };
243 
244 } /* namespace ns3 */
245 
246 #endif /* IPV6_END_POINT_H */
Callback template class.
Definition: callback.h:438
Describes an IPv6 address.
Definition: ipv6-address.h:49
A representation of an IPv6 endpoint/connection.
uint16_t m_peerPort
The peer port.
void ForwardUp(Ptr< Packet > p, Ipv6Header header, uint16_t port, Ptr< Ipv6Interface > incomingInterface)
Forward the packet to the upper level.
uint16_t GetLocalPort() const
Get the local port.
void SetPeer(Ipv6Address addr, uint16_t port)
Set the peer information (address and port).
Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t > m_icmpCallback
The ICMPv6 callback.
Ipv6Address GetPeerAddress() const
Get the peer address.
Callback< void, Ptr< Packet >, Ipv6Header, uint16_t, Ptr< Ipv6Interface > > m_rxCallback
The RX callback.
Ipv6Address m_peerAddr
The peer address.
void SetIcmpCallback(Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t > callback)
Set the ICMP callback.
void SetLocalPort(uint16_t port)
Set the local port.
bool m_rxEnabled
true if the endpoint can receive packets.
Ipv6Address GetLocalAddress() const
Get the local address.
void SetRxCallback(Callback< void, Ptr< Packet >, Ipv6Header, uint16_t, Ptr< Ipv6Interface >> callback)
Set the reception callback.
Callback< void > m_destroyCallback
The destroy callback.
Ipv6EndPoint(Ipv6Address addr, uint16_t port)
Constructor.
Ipv6Address m_localAddr
The local address.
void SetLocalAddress(Ipv6Address addr)
Set the local address.
void BindToNetDevice(Ptr< NetDevice > netdevice)
Bind a socket to specific device.
void SetRxEnabled(bool enabled)
Enable or Disable the endpoint Rx capability.
void ForwardIcmp(Ipv6Address src, uint8_t ttl, uint8_t type, uint8_t code, uint32_t info)
Forward the ICMP packet to the upper level.
Ptr< NetDevice > m_boundnetdevice
The NetDevice the EndPoint is bound to (if any).
uint16_t m_localPort
The local port.
bool IsRxEnabled() const
Checks if the endpoint can receive packets.
Ptr< NetDevice > GetBoundNetDevice() const
Returns socket's bound netdevice, if any.
uint16_t GetPeerPort() const
Get the peer port.
void SetDestroyCallback(Callback< void > callback)
Set the default destroy callback.
Packet header for IPv6.
Definition: ipv6-header.h:35
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
uint16_t port
Definition: dsdv-manet.cc:44
Every class exported by the ns3 library is enclosed in the ns3 namespace.