A Discrete-Event Network Simulator
API
ipv6-address.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007-2008 Louis Pasteur University
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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
19  */
20 
21 #ifndef IPV6_ADDRESS_H
22 #define IPV6_ADDRESS_H
23 
24 #include <stdint.h>
25 #include <cstring>
26 
27 #include <ostream>
28 
29 #include "ns3/attribute-helper.h"
30 #include "ns3/address.h"
31 #include "ns3/ipv4-address.h"
32 #include "ns3/deprecated.h"
33 
34 namespace ns3 {
35 
36 class Ipv6Prefix;
37 class Mac16Address;
38 class Mac48Address;
39 class Mac64Address;
40 
49 {
50 public:
54  Ipv6Address ();
55 
60  Ipv6Address (char const* address);
61 
67  Ipv6Address (uint8_t address[16]);
68 
73  Ipv6Address (Ipv6Address const & addr);
74 
79  Ipv6Address (Ipv6Address const* addr);
80 
84  ~Ipv6Address ();
85 
90  void Set (char const* address);
91 
98  void Set (uint8_t address[16]);
99 
106  bool IsEqual (const Ipv6Address& other) const;
107 
113  void Serialize (uint8_t buf[16]) const;
114 
120  static Ipv6Address Deserialize (const uint8_t buf[16]);
121 
128 
135 
141 
149 
157 
165 
172 
179 
186 
193  void Print (std::ostream& os) const;
194 
199  bool IsLocalhost () const;
200 
205  bool IsMulticast () const;
206 
211  bool IsLinkLocalMulticast () const;
212 
217  bool IsAllNodesMulticast () const;
218 
223  bool IsAllRoutersMulticast () const;
224 
233  bool IsAllHostsMulticast () const;
234 
239  bool IsLinkLocal () const;
240 
245  bool IsSolicitedMulticast () const;
246 
251  bool IsAny () const;
252 
257  bool IsDocumentation () const;
258 
265  Ipv6Address CombinePrefix (Ipv6Prefix const & prefix);
266 
272  static bool IsMatchingType (const Address& address);
273 
278  bool IsIpv4MappedAddress() const;
279 
283  operator Address () const;
284 
290  static Ipv6Address ConvertFrom (const Address& address);
291 
296  static Ipv6Address GetZero ();
297 
302  static Ipv6Address GetAny ();
303 
309 
315 
321 
326  static Ipv6Address GetLoopback ();
327 
332  static Ipv6Address GetOnes ();
333 
339  void GetBytes (uint8_t buf[16]) const;
340 
341 private:
346  Address ConvertTo (void) const;
347 
352  static uint8_t GetType (void);
353 
357  uint8_t m_address[16];
358 
366  friend bool operator == (Ipv6Address const &a, Ipv6Address const &b);
367 
375  friend bool operator != (Ipv6Address const &a, Ipv6Address const &b);
376 
384  friend bool operator < (Ipv6Address const &a, Ipv6Address const &b);
385 };
386 
395 {
396 public:
400  Ipv6Prefix ();
401 
406  Ipv6Prefix (uint8_t prefix[16]);
407 
412  Ipv6Prefix (char const* prefix);
413 
419  Ipv6Prefix (uint8_t prefix);
420 
425  Ipv6Prefix (Ipv6Prefix const& prefix);
426 
431  Ipv6Prefix (Ipv6Prefix const* prefix);
432 
436  ~Ipv6Prefix ();
437 
444  bool IsMatch (Ipv6Address a, Ipv6Address b) const;
445 
450  void GetBytes (uint8_t buf[16]) const;
451 
456  uint8_t GetPrefixLength () const;
457 
463  bool IsEqual (const Ipv6Prefix& other) const;
464 
471  void Print (std::ostream &os) const;
472 
477  static Ipv6Prefix GetLoopback ();
478 
483  static Ipv6Prefix GetOnes ();
484 
489  static Ipv6Prefix GetZero ();
490 
491 private:
495  uint8_t m_prefix[16];
496 
504  friend bool operator == (Ipv6Prefix const &a, Ipv6Prefix const &b);
505 
513  friend bool operator != (Ipv6Prefix const &a, Ipv6Prefix const &b);
514 };
515 
518 
526 std::ostream & operator << (std::ostream& os, Ipv6Address const& address);
527 
535 std::ostream & operator << (std::ostream& os, Ipv6Prefix const& prefix);
536 
544 std::istream & operator >> (std::istream &is, Ipv6Address &address);
545 
553 std::istream & operator >> (std::istream &is, Ipv6Prefix &prefix);
554 
555 inline bool operator == (const Ipv6Address& a, const Ipv6Address& b)
556 {
557  return (!std::memcmp (a.m_address, b.m_address, 16));
558 }
559 
560 inline bool operator != (const Ipv6Address& a, const Ipv6Address& b)
561 {
562  return std::memcmp (a.m_address, b.m_address, 16);
563 }
564 
565 inline bool operator < (const Ipv6Address& a, const Ipv6Address& b)
566 {
567  return (std::memcmp (a.m_address, b.m_address, 16) < 0);
568 }
569 
570 inline bool operator == (const Ipv6Prefix& a, const Ipv6Prefix& b)
571 {
572  return (!std::memcmp (a.m_prefix, b.m_prefix, 16));
573 }
574 
575 inline bool operator != (const Ipv6Prefix& a, const Ipv6Prefix& b)
576 {
577  return std::memcmp (a.m_prefix, b.m_prefix, 16);
578 }
579 
584 class Ipv6AddressHash : public std::unary_function<Ipv6Address, size_t>
585 {
586 public:
592  size_t operator () (Ipv6Address const &x) const;
593 };
594 
595 } /* namespace ns3 */
596 
597 #endif /* IPV6_ADDRESS_H */
598 
bool IsMatch(Ipv6Address a, Ipv6Address b) const
If the Address match the type.
static bool IsMatchingType(const Address &address)
If the Address matches the type.
bool IsAny() const
If the IPv6 address is the "Any" address.
static Ipv6Address GetLoopback()
Get the loopback address.
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
Ipv6Address()
Default constructor.
uint8_t m_address[16]
The address representation on 128 bits (16 bytes).
Definition: ipv6-address.h:357
bool IsLinkLocalMulticast() const
If the IPv6 address is link-local multicast (ff02::/16).
friend bool operator!=(Ipv6Address const &a, Ipv6Address const &b)
Not equal to operator.
Definition: ipv6-address.h:560
Ipv6Prefix()
Default constructor.
friend bool operator<(Ipv6Address const &a, Ipv6Address const &b)
Less than to operator.
Definition: ipv6-address.h:565
friend bool operator==(Ipv6Prefix const &a, Ipv6Prefix const &b)
Equal to operator.
Definition: ipv6-address.h:570
static Ipv6Address Deserialize(const uint8_t buf[16])
Deserialize this address.
bool IsLinkLocal() const
If the IPv6 address is a link-local address (fe80::/64).
~Ipv6Prefix()
Destructor.
bool IsAllRoutersMulticast() const
If the IPv6 address is "all routers multicast" (ff02::2/8).
bool IsEqual(const Ipv6Prefix &other) const
Comparison operation between two Ipv6Prefix.
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
static Ipv6Address MakeAutoconfiguredAddress(Mac16Address addr, Ipv6Address prefix)
Make the autoconfigured IPv6 address with Mac16Address.
size_t operator()(Ipv6Address const &x) const
Unary operator to hash IPv6 address.
bool IsEqual(const Ipv6Address &other) const
Comparison operation between two Ipv6Addresses.
bool IsDocumentation() const
If the IPv6 address is a documentation address (2001:DB8::/32).
NS_DEPRECATED bool IsAllHostsMulticast() const
If the IPv6 address is "all hosts multicast" (ff02::3/8).
friend bool operator!=(Ipv6Prefix const &a, Ipv6Prefix const &b)
Not equal to operator.
Definition: ipv6-address.h:575
bool IsAllNodesMulticast() const
If the IPv6 address is "all nodes multicast" (ff02::1/8).
static Ipv6Prefix GetZero()
Get the zero prefix ( /0).
a polymophic address class
Definition: address.h:90
an EUI-64 address
Definition: mac64-address.h:43
Address ConvertTo(void) const
convert the IPv6Address object to an Address object.
static Ipv6Address GetZero()
Get the 0 (::) Ipv6Address.
void Print(std::ostream &os) const
Print this address to the given output stream.
void GetBytes(uint8_t buf[16]) const
Get the bytes corresponding to the address.
tuple mac
Definition: third.py:92
bool operator<(const int64x64_t &lhs, const int64x64_t &rhs)
Less than operator.
Definition: int64x64-128.h:356
void Set(char const *address)
Sets an Ipv6Address by parsing the input C-string.
static Ipv6Address GetAllHostsMulticast()
Get the "all hosts multicast" address.
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
bool operator!=(Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > a, Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > b)
Inequality test.
Definition: callback.h:1471
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool IsMulticast() const
If the IPv6 address is multicast (ff00::/8).
static Ipv6Address GetAllNodesMulticast()
Get the "all nodes multicast" address.
an EUI-48 address
Definition: mac48-address.h:43
uint8_t m_prefix[16]
The prefix representation.
Definition: ipv6-address.h:495
This class can contain 16 bit addresses.
Definition: mac16-address.h:41
Hash function class for IPv6 addresses.
Definition: ipv6-address.h:584
static Ipv6Address MakeAutoconfiguredLinkLocalAddress(Mac16Address mac)
Make the autoconfigured link-local IPv6 address with Mac16Address.
Describes an IPv6 address.
Definition: ipv6-address.h:48
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
void Print(std::ostream &os) const
Print this address to the given output stream.
#define NS_DEPRECATED
Mark a function as deprecated.
Definition: deprecated.h:60
bool IsSolicitedMulticast() const
If the IPv6 address is a Solicited multicast address.
static Ipv6Prefix GetOnes()
Get the "all-1" IPv6 mask (ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff).
void GetBytes(uint8_t buf[16]) const
Get the bytes corresponding to the prefix.
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.cc:95
~Ipv6Address()
Destructor.
static Ipv6Address GetOnes()
Get the "all-1" IPv6 address (ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff).
static Ipv6Prefix GetLoopback()
Get the loopback prefix ( /128).
Describes an IPv6 prefix.
Definition: ipv6-address.h:394
Ipv4Address GetIpv4MappedAddress() const
Return the Ipv4 address.
uint8_t GetPrefixLength() const
Get prefix length.
tuple address
Definition: first.py:37
bool IsLocalhost() const
If the IPv6 address is localhost (::1).
friend bool operator==(Ipv6Address const &a, Ipv6Address const &b)
Equal to operator.
Definition: ipv6-address.h:555
static Ipv6Address MakeIpv4MappedAddress(Ipv4Address addr)
Make the Ipv4-mapped IPv6 address.
Ipv6Address CombinePrefix(Ipv6Prefix const &prefix)
Combine this address with a prefix.
bool IsIpv4MappedAddress() const
If the address is an IPv4-mapped address.
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type.
static uint8_t GetType(void)
Return the Type of address.
static Ipv6Address MakeSolicitedAddress(Ipv6Address addr)
Make the solicited IPv6 address.
static Ipv6Address GetAllRoutersMulticast()
Get the "all routers multicast" address.
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.
void Serialize(uint8_t buf[16]) const
Serialize this address to a 16-byte buffer.