A Discrete-Event Network Simulator
API
address-utils.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 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 ADDRESS_UTILS_H
21 #define ADDRESS_UTILS_H
22 
23 #include "ns3/buffer.h"
24 #include "ipv4-address.h"
25 #include "ipv6-address.h"
26 #include "ns3/address.h"
27 #include "mac64-address.h"
28 #include "mac48-address.h"
29 #include "mac16-address.h"
30 
31 namespace ns3 {
32 
38 void WriteTo (Buffer::Iterator &i, Ipv4Address ad);
39 
45 void WriteTo (Buffer::Iterator &i, Ipv6Address ad);
46 
52 void WriteTo (Buffer::Iterator &i, const Address &ad);
53 
59 void WriteTo (Buffer::Iterator &i, Mac64Address ad);
60 
66 void WriteTo (Buffer::Iterator &i, Mac48Address ad);
67 
73 void WriteTo (Buffer::Iterator &i, Mac16Address ad);
74 
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 
124 bool IsMulticast (const Address &ad);
125 };
126 
127 };
128 
129 #endif /* ADDRESS_UTILS_H */
ns3::addressUtils::IsMulticast
bool IsMulticast(const Address &ad)
Address family-independent test for a multicast address.
Definition: address-utils.cc:114
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:28
ns3::ReadFrom
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
Definition: address-utils.cc:70