Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Socket / Protocols / INet / INet6Address.cci
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief INet6Address inline non-template implementation */
25
26 #include "INet6Address.ih"
27
28 // Custom includes
29 #include <algorithm>
30 #include <boost/lambda/lambda.hpp>
31
32 #define prefix_ inline
33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
34
35 prefix_ senf::INet6Address::INet6Address(senf::NoInit_t)
36 {}
37
38 prefix_ senf::INet6Address::INet6Address(boost::uint16_t a0, boost::uint16_t a1,
39                                          boost::uint16_t a2, boost::uint16_t a3,
40                                          boost::uint16_t a4, boost::uint16_t a5,
41                                          boost::uint16_t a6, boost::uint16_t a7)
42 {
43     (*this)[ 0] = boost::uint8_t(a0>>8);
44     (*this)[ 1] = boost::uint8_t(a0);
45     (*this)[ 2] = boost::uint8_t(a1>>8);
46     (*this)[ 3] = boost::uint8_t(a1);
47     (*this)[ 4] = boost::uint8_t(a2>>8);
48     (*this)[ 5] = boost::uint8_t(a2);
49     (*this)[ 6] = boost::uint8_t(a3>>8);
50     (*this)[ 7] = boost::uint8_t(a3);
51     (*this)[ 8] = boost::uint8_t(a4>>8);
52     (*this)[ 9] = boost::uint8_t(a4);
53     (*this)[10] = boost::uint8_t(a5>>8);
54     (*this)[11] = boost::uint8_t(a5);
55     (*this)[12] = boost::uint8_t(a6>>8);
56     (*this)[13] = boost::uint8_t(a6);
57     (*this)[14] = boost::uint8_t(a7>>8);
58     (*this)[15] = boost::uint8_t(a7);
59 }
60
61 prefix_ senf::INet6Address senf::INet6Address::from_in6addr(in6_addr const & in6addr)
62 {
63     return senf::INet6Address::from_data(&in6addr.s6_addr[0]);
64 }
65
66 prefix_ senf::INet6Address senf::INet6Address::from_inet4address(INet4Address const & addr4)
67 {
68     INet6Address addr;
69     addr[10] = 0xffu;
70     addr[11] = 0xffu;
71     std::copy(addr4.begin(), addr4.end(), addr.begin()+12);
72     return addr;
73 }
74
75 prefix_ senf::INet6Network senf::INet6Address::network()
76     const
77 {
78     return senf::INet6Network(*this, 64);
79 }
80
81 prefix_ bool senf::INet6Address::universalId()
82     const
83 {
84     return (*this)[8] & 2u;
85 }
86
87 prefix_ bool senf::INet6Address::groupId()
88     const
89 {
90     return (*this)[8] & 1u;
91 }
92
93 prefix_ senf::INet4Address senf::INet6Address::inet4address()
94     const
95 {
96     return INet4Address::from_data(&(*this)[12]);
97 }
98
99 prefix_ bool senf::INet6Address::inet4Mapped()
100     const
101 {
102     return CheckINet6Network<0u,0u,0u,0u,0u,0xFFFFu,96>::match(*this);
103 }
104
105 prefix_ bool senf::INet6Address::multicast()
106     const
107 {
108     return (*this)[0] == 0xFFu || (inet4Mapped() && inet4address().multicast());
109 }
110
111 prefix_ senf::INet6Address::ScopeId senf::INet6Address::scope()
112     const
113 {
114     static ScopeId const scopeMap[]
115         = { ReservedScope, InterfaceScope, LinkScope, ReservedScope,
116             AdminScope, SiteScope, UnassignedScope, UnassignedScope,
117             OrganizationScope, UnassignedScope, UnassignedScope, UnassignedScope,
118             UnassignedScope, UnassignedScope, GlobalScope, ReservedScope };
119     return multicast() ? scopeMap[(*this)[1] & 0x0Fu] :
120         (*this)[0] == 0xFEu ? (((*this)[1]&0xC0) == 0x80 ? LinkScope :
121                                ((*this)[1]&0xC0) == 0xC0 ? SiteScope : GlobalScope )
122         : GlobalScope;
123 }
124
125 prefix_ bool senf::INet6Address::unicast()
126     const
127 {
128     return ! multicast();
129 }
130
131 prefix_ bool senf::INet6Address::hasEUI64()
132     const
133 {
134     return unicast() && ((*this)[0]&0xE0u) != 0u;
135 }
136
137 prefix_ bool senf::INet6Address::globalScope()
138     const
139 {
140     return scope() == GlobalScope;
141 }
142
143 prefix_ bool senf::INet6Address::linkScope()
144     const
145 {
146     return scope() == LinkScope;
147 }
148
149 prefix_ bool senf::INet6Address::inet4Compatible()
150     const
151 {
152     return CheckINet6Network<0u,96>::match(*this);
153 }
154
155 prefix_ bool senf::INet6Address::globalMulticastAddr()
156     const
157 {
158     return multicast() && ! ((*this)[1] & 0x10u);
159 }
160
161 prefix_ bool senf::INet6Address::prefixMulticastAddr()
162     const
163 {
164     return multicast() && ((*this)[1] & 0x20u);
165 }
166
167 prefix_ bool senf::INet6Address::embeddedRpAddr()
168     const
169 {
170     return multicast() && ((*this)[1] & 0x40u);
171 }
172
173 prefix_ bool senf::INet6Address::boolean_test()
174     const
175 {
176     using boost::lambda::_1;
177     return std::find_if(begin(),end(), _1 != 0x00) != end();
178 }
179
180 prefix_ void senf::INet6Address::network(boost::uint64_t net)
181 {
182     (*this)[ 0] = net >> 56;
183     (*this)[ 1] = net >> 48;
184     (*this)[ 2] = net >> 40;
185     (*this)[ 3] = net >> 32;
186     (*this)[ 4] = net >> 24;
187     (*this)[ 5] = net >> 16;
188     (*this)[ 6] = net >>  8;
189     (*this)[ 7] = net      ;
190 }
191
192 prefix_ void senf::INet6Address::id(boost::uint64_t id)
193 {
194     (*this)[ 8] = id >> 56;
195     (*this)[ 9] = id >> 48;
196     (*this)[10] = id >> 40;
197     (*this)[11] = id >> 32;
198     (*this)[12] = id >> 24;
199     (*this)[13] = id >> 16;
200     (*this)[14] = id >>  8;
201     (*this)[15] = id      ;
202 }
203
204 //-/////////////////////////////////////////////////////////////////////////////////////////////////
205 // senf::INet6Network
206
207 prefix_ senf::INet6Network::INet6Network()
208     : prefix_len_(), address_()
209 {}
210
211 prefix_ senf::INet6Network::INet6Network(INet6Address const & address, unsigned prefix_len)
212     : prefix_len_(prefix_len), address_(address)
213 {
214     using boost::lambda::_1;
215     using boost::lambda::_2;
216     detail::apply_mask(prefix_len_, address_.begin(), address_.end(), _1 &= _2);
217 }
218
219 prefix_ senf::INet6Address const & senf::INet6Network::address()
220     const
221 {
222     return address_;
223 }
224
225 prefix_ unsigned senf::INet6Network::prefix_len()
226     const
227 {
228     return prefix_len_;
229 }
230
231 prefix_ bool senf::INet6Network::boolean_test()
232     const
233 {
234     return prefix_len() && address();
235 }
236
237 prefix_ bool senf::INet6Network::operator==(INet6Network const & other)
238     const
239 {
240     return prefix_len() == other.prefix_len() && address() == other.address();
241 }
242
243 prefix_ bool senf::INet6Network::match(INet6Address const & addr)
244     const
245 {
246     using boost::lambda::_1;
247     using boost::lambda::_2;
248     using boost::lambda::_3;
249     return detail::find_if_mask(prefix_len_, address_.begin(), address_.end(), addr.begin(),
250                                 _1 != (_2 & _3)) == address_.end();
251 }
252
253 prefix_ bool senf::INet6Network::match(INet6Network const & net)
254     const
255 {
256     return net.prefix_len() >= prefix_len() && match(net.address());
257 }
258
259 prefix_ senf::INet6Address senf::INet6Network::host(boost::uint64_t id)
260 {
261     INet6Address addr (address());
262     addr.id(id);
263     return addr;
264 }
265
266 prefix_ senf::INet6Network senf::INet6Network::subnet(boost::uint64_t net, unsigned prefix_len)
267 {
268     using boost::lambda::_1;
269     using boost::lambda::_2;
270     using boost::lambda::var;
271     using boost::lambda::ret;
272     INet6Address addr (address());
273     net <<= (64-prefix_len);
274     detail::apply_mask(prefix_len, addr.begin(), addr.end(),
275                        ( ( _1 |= ret<boost::uint8_t>((var(net) >> 56) & _2) ),
276                          ( var(net) <<= 8 ) ));
277     return INet6Network(addr, prefix_len);
278 }
279
280 prefix_ std::ostream & senf::operator<<(std::ostream & os, INet6Network const & addr)
281 {
282     os << addr.address() << '/' << addr.prefix_len();
283     return os;
284 }
285
286 //-/////////////////////////////////////////////////////////////////////////////////////////////////
287 // namespace senf::detail members
288
289 prefix_ boost::uint8_t senf::detail::low_bits_mask(unsigned bits)
290 {
291     return ((1<<bits)-1);
292 }
293
294 //-/////////////////////////////////////////////////////////////////////////////////////////////////
295 #undef prefix_
296
297 \f
298 // Local Variables:
299 // mode: c++
300 // fill-column: 100
301 // comment-column: 40
302 // c-file-style: "senf"
303 // indent-tabs-mode: nil
304 // ispell-local-dictionary: "american"
305 // compile-command: "scons -u test"
306 // End: