A Discrete-Event Network Simulator
API
mac48-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 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 #ifndef MAC48_ADDRESS_H
21 #define MAC48_ADDRESS_H
22 
23 #include <stdint.h>
24 #include <ostream>
25 #include "ns3/attribute.h"
26 #include "ns3/attribute-helper.h"
27 #include "ipv4-address.h"
28 #include "ipv6-address.h"
29 
30 namespace ns3 {
31 
32 class Address;
33 
44 {
45 public:
46  Mac48Address ();
52  Mac48Address (const char *str);
53 
59  void CopyFrom (const uint8_t buffer[6]);
65  void CopyTo (uint8_t buffer[6]) const;
66 
72  operator Address () const;
81  static Mac48Address ConvertFrom (const Address &address);
86  static bool IsMatchingType (const Address &address);
91  static Mac48Address Allocate (void);
92 
96  bool IsBroadcast (void) const;
97 
101  bool IsGroup (void) const;
102 
106  static Mac48Address GetBroadcast (void);
107 
113 
120 
124  static Mac48Address GetMulticastPrefix (void);
125 
130  static Mac48Address GetMulticast6Prefix (void);
131 
137  typedef void (* TracedCallback)(Mac48Address value);
138 
139 private:
145  Address ConvertTo (void) const;
146 
151  static uint8_t GetType (void);
152 
160  friend bool operator == (const Mac48Address &a, const Mac48Address &b);
161 
169  friend bool operator != (const Mac48Address &a, const Mac48Address &b);
170 
178  friend bool operator < (const Mac48Address &a, const Mac48Address &b);
179 
187  friend std::ostream& operator<< (std::ostream& os, const Mac48Address & address);
188 
196  friend std::istream& operator>> (std::istream& is, Mac48Address & address);
197 
198  uint8_t m_address[6];
199 };
200 
202 
203 inline bool operator == (const Mac48Address &a, const Mac48Address &b)
204 {
205  return memcmp (a.m_address, b.m_address, 6) == 0;
206 }
207 inline bool operator != (const Mac48Address &a, const Mac48Address &b)
208 {
209  return memcmp (a.m_address, b.m_address, 6) != 0;
210 }
211 inline bool operator < (const Mac48Address &a, const Mac48Address &b)
212 {
213  return memcmp (a.m_address, b.m_address, 6) < 0;
214 }
215 
216 std::ostream& operator<< (std::ostream& os, const Mac48Address & address);
217 std::istream& operator>> (std::istream& is, Mac48Address & address);
218 
219 } // namespace ns3
220 
221 #endif /* MAC48_ADDRESS_H */
uint8_t m_address[6]
address value
static bool IsMatchingType(const Address &address)
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
bool IsBroadcast(void) const
static Mac48Address GetMulticastPrefix(void)
Forward calls to a chain of Callback.
a polymophic address class
Definition: address.h:90
bool operator<(const EventId &a, const EventId &b)
Definition: event-id.h:155
friend std::istream & operator>>(std::istream &is, Mac48Address &address)
Stream extraction operator.
void CopyTo(uint8_t buffer[6]) const
static Mac48Address Allocate(void)
Allocate a new Mac48Address.
static Mac48Address GetMulticast(Ipv4Address address)
static Mac48Address GetBroadcast(void)
friend bool operator<(const Mac48Address &a, const Mac48Address &b)
Less than operator.
static Mac48Address ConvertFrom(const Address &address)
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
friend bool operator!=(const Mac48Address &a, const Mac48Address &b)
Not equal to operator.
static uint8_t GetType(void)
Return the Type of address.
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:1592
Every class exported by the ns3 library is enclosed in the ns3 namespace.
address
Definition: first.py:44
friend bool operator==(const Mac48Address &a, const Mac48Address &b)
Equal to operator.
an EUI-48 address
Definition: mac48-address.h:43
bool IsGroup(void) const
void CopyFrom(const uint8_t buffer[6])
Describes an IPv6 address.
Definition: ipv6-address.h:49
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
Address ConvertTo(void) const
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:137
static Mac48Address GetMulticast6Prefix(void)
Get the multicast prefix for IPv6 (33:33:00:00:00:00).
friend std::ostream & operator<<(std::ostream &os, const Mac48Address &address)
Stream insertion operator.
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type.