A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
42 {
43 public:
44  Mac48Address ();
50  Mac48Address (const char *str);
51 
57  void CopyFrom (const uint8_t buffer[6]);
63  void CopyTo (uint8_t buffer[6]) const;
64 
70  operator Address () const;
79  static Mac48Address ConvertFrom (const Address &address);
84  static bool IsMatchingType (const Address &address);
89  static Mac48Address Allocate (void);
90 
94  bool IsBroadcast (void) const;
95 
99  bool IsGroup (void) const;
100 
104  static Mac48Address GetBroadcast (void);
105 
110  static Mac48Address GetMulticast (Ipv4Address address);
111 
117  static Mac48Address GetMulticast (Ipv6Address address);
118 
122  static Mac48Address GetMulticastPrefix (void);
123 
128  static Mac48Address GetMulticast6Prefix (void);
129 private:
135  Address ConvertTo (void) const;
136 
141  static uint8_t GetType (void);
142 
150  friend bool operator == (const Mac48Address &a, const Mac48Address &b);
151 
159  friend bool operator != (const Mac48Address &a, const Mac48Address &b);
160 
168  friend bool operator < (const Mac48Address &a, const Mac48Address &b);
169 
177  friend std::ostream& operator<< (std::ostream& os, const Mac48Address & address);
178 
186  friend std::istream& operator>> (std::istream& is, Mac48Address & address);
187 
188  uint8_t m_address[6];
189 };
190 
197 
198 inline bool operator == (const Mac48Address &a, const Mac48Address &b)
199 {
200  return memcmp (a.m_address, b.m_address, 6) == 0;
201 }
202 inline bool operator != (const Mac48Address &a, const Mac48Address &b)
203 {
204  return memcmp (a.m_address, b.m_address, 6) != 0;
205 }
206 inline bool operator < (const Mac48Address &a, const Mac48Address &b)
207 {
208  return memcmp (a.m_address, b.m_address, 6) < 0;
209 }
210 
211 std::ostream& operator<< (std::ostream& os, const Mac48Address & address);
212 std::istream& operator>> (std::istream& is, Mac48Address & address);
213 
214 } // namespace ns3
215 
216 #endif /* MAC48_ADDRESS_H */
uint8_t m_address[6]
address value
ATTRIBUTE_HELPER_HEADER(ObjectFactory)
static bool IsMatchingType(const Address &address)
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:49
static Mac48Address GetMulticastPrefix(void)
bool IsBroadcast(void) const
a polymophic address class
Definition: address.h:86
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.
bool operator<(const int64x64_t &lhs, const int64x64_t &rhs)
Less than operator.
Definition: int64x64-128.h:327
static Mac48Address ConvertFrom(const Address &address)
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:43
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:1217
friend bool operator==(const Mac48Address &a, const Mac48Address &b)
Equal to operator.
bool IsGroup(void) const
an EUI-48 address
Definition: mac48-address.h:41
void CopyFrom(const uint8_t buffer[6])
Describes an IPv6 address.
Definition: ipv6-address.h:46
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.cc:89
tuple address
Definition: first.py:37
static Mac48Address GetMulticast6Prefix(void)
Get the multicast prefix for IPv6 (33:33:00:00:00:00).
Address ConvertTo(void) const
friend std::ostream & operator<<(std::ostream &os, const Mac48Address &address)
Stream insertion operator.