A Discrete-Event Network Simulator
API
address-utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006 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 #ifndef ADDRESS_UTILS_H
20 #define ADDRESS_UTILS_H
21 
22 #include "ipv4-address.h"
23 #include "ipv6-address.h"
24 #include "mac16-address.h"
25 #include "mac48-address.h"
26 #include "mac64-address.h"
27 
28 #include "ns3/address.h"
29 #include "ns3/buffer.h"
30 
31 namespace ns3
32 {
33 
39 void WriteTo(Buffer::Iterator& i, Ipv4Address ad);
40 
46 void WriteTo(Buffer::Iterator& i, Ipv6Address ad);
47 
53 void WriteTo(Buffer::Iterator& i, const Address& ad);
54 
60 void WriteTo(Buffer::Iterator& i, Mac64Address ad);
61 
67 void WriteTo(Buffer::Iterator& i, Mac48Address ad);
68 
74 void WriteTo(Buffer::Iterator& i, Mac16Address ad);
75 
81 void ReadFrom(Buffer::Iterator& i, Ipv4Address& ad);
82 
88 void ReadFrom(Buffer::Iterator& i, Ipv6Address& ad);
89 
96 void ReadFrom(Buffer::Iterator& i, Address& ad, uint32_t len);
97 
103 void ReadFrom(Buffer::Iterator& i, Mac64Address& ad);
104 
110 void ReadFrom(Buffer::Iterator& i, Mac48Address& ad);
111 
117 void ReadFrom(Buffer::Iterator& i, Mac16Address& ad);
118 
119 namespace addressUtils
120 {
121 
125 bool IsMulticast(const Address& ad);
126 }; // namespace addressUtils
127 
128 }; // namespace ns3
129 
130 #endif /* ADDRESS_UTILS_H */
ns3::addressUtils::IsMulticast
bool IsMulticast(const Address &ad)
Address family-independent test for a multicast address.
Definition: address-utils.cc:140
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::WriteTo
void WriteTo(Buffer::Iterator &i, Ipv4Address ad)
Write an Ipv4Address to a Buffer.
Definition: address-utils.cc:31
ns3::ReadFrom
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
Definition: address-utils.cc:84