1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
//
// ip/address_v4.hpp
// ~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
#ifndef ASIO_IP_ADDRESS_V4_HPP
#define ASIO_IP_ADDRESS_V4_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include "asio/detail/config.hpp"
#include <string>
#include "asio/detail/array.hpp"
#include "asio/detail/cstdint.hpp"
#include "asio/detail/socket_types.hpp"
#include "asio/detail/string_view.hpp"
#include "asio/detail/winsock_init.hpp"
#include "asio/error_code.hpp"
#if !defined(ASIO_NO_IOSTREAM)
# include <iosfwd>
#endif // !defined(ASIO_NO_IOSTREAM)
#include "asio/detail/push_options.hpp"
namespace asio {
namespace ip {
/// Implements IP version 4 style addresses.
/**
* The asio::ip::address_v4 class provides the ability to use and
* manipulate IP version 4 addresses.
*
* @par Thread Safety
* @e Distinct @e objects: Safe.@n
* @e Shared @e objects: Unsafe.
*/
class address_v4
{
public:
/// The type used to represent an address as an unsigned integer.
typedef uint_least32_t uint_type;
/// The type used to represent an address as an array of bytes.
/**
* @note This type is defined in terms of the C++0x template @c std::array
* when it is available. Otherwise, it uses @c boost:array.
*/
#if defined(GENERATING_DOCUMENTATION)
typedef array<unsigned char, 4> bytes_type;
#else
typedef asio::detail::array<unsigned char, 4> bytes_type;
#endif
/// Default constructor.
address_v4()
{
addr_.s_addr = 0;
}
/// Construct an address from raw bytes.
ASIO_DECL explicit address_v4(const bytes_type& bytes);
/// Construct an address from an unsigned integer in host byte order.
ASIO_DECL explicit address_v4(uint_type addr);
/// Copy constructor.
address_v4(const address_v4& other)
: addr_(other.addr_)
{
}
#if defined(ASIO_HAS_MOVE)
/// Move constructor.
address_v4(address_v4&& other)
: addr_(other.addr_)
{
}
#endif // defined(ASIO_HAS_MOVE)
/// Assign from another address.
address_v4& operator=(const address_v4& other)
{
addr_ = other.addr_;
return *this;
}
#if defined(ASIO_HAS_MOVE)
/// Move-assign from another address.
address_v4& operator=(address_v4&& other)
{
addr_ = other.addr_;
return *this;
}
#endif // defined(ASIO_HAS_MOVE)
/// Get the address in bytes, in network byte order.
ASIO_DECL bytes_type to_bytes() const;
/// Get the address as an unsigned integer in host byte order
ASIO_DECL uint_type to_uint() const;
#if !defined(ASIO_NO_DEPRECATED)
/// Get the address as an unsigned long in host byte order
ASIO_DECL unsigned long to_ulong() const;
#endif // !defined(ASIO_NO_DEPRECATED)
/// Get the address as a string in dotted decimal format.
ASIO_DECL std::string to_string() const;
#if !defined(ASIO_NO_DEPRECATED)
/// (Deprecated: Use other overload.) Get the address as a string in dotted
/// decimal format.
ASIO_DECL std::string to_string(asio::error_code& ec) const;
/// (Deprecated: Use make_address_v4().) Create an address from an IP address
/// string in dotted decimal form.
static address_v4 from_string(const char* str);
/// (Deprecated: Use make_address_v4().) Create an address from an IP address
/// string in dotted decimal form.
static address_v4 from_string(
const char* str, asio::error_code& ec);
/// (Deprecated: Use make_address_v4().) Create an address from an IP address
/// string in dotted decimal form.
static address_v4 from_string(const std::string& str);
/// (Deprecated: Use make_address_v4().) Create an address from an IP address
/// string in dotted decimal form.
static address_v4 from_string(
const std::string& str, asio::error_code& ec);
#endif // !defined(ASIO_NO_DEPRECATED)
/// Determine whether the address is a loopback address.
ASIO_DECL bool is_loopback() const;
/// Determine whether the address is unspecified.
ASIO_DECL bool is_unspecified() const;
#if !defined(ASIO_NO_DEPRECATED)
/// (Deprecated: Use network_v4 class.) Determine whether the address is a
/// class A address.
ASIO_DECL bool is_class_a() const;
/// (Deprecated: Use network_v4 class.) Determine whether the address is a
/// class B address.
ASIO_DECL bool is_class_b() const;
/// (Deprecated: Use network_v4 class.) Determine whether the address is a
/// class C address.
ASIO_DECL bool is_class_c() const;
#endif // !defined(ASIO_NO_DEPRECATED)
/// Determine whether the address is a multicast address.
ASIO_DECL bool is_multicast() const;
/// Compare two addresses for equality.
friend bool operator==(const address_v4& a1, const address_v4& a2)
{
return a1.addr_.s_addr == a2.addr_.s_addr;
}
/// Compare two addresses for inequality.
friend bool operator!=(const address_v4& a1, const address_v4& a2)
{
return a1.addr_.s_addr != a2.addr_.s_addr;
}
/// Compare addresses for ordering.
friend bool operator<(const address_v4& a1, const address_v4& a2)
{
return a1.to_uint() < a2.to_uint();
}
/// Compare addresses for ordering.
friend bool operator>(const address_v4& a1, const address_v4& a2)
{
return a1.to_uint() > a2.to_uint();
}
/// Compare addresses for ordering.
friend bool operator<=(const address_v4& a1, const address_v4& a2)
{
return a1.to_uint() <= a2.to_uint();
}
/// Compare addresses for ordering.
friend bool operator>=(const address_v4& a1, const address_v4& a2)
{
return a1.to_uint() >= a2.to_uint();
}
/// Obtain an address object that represents any address.
static address_v4 any()
{
return address_v4();
}
/// Obtain an address object that represents the loopback address.
static address_v4 loopback()
{
return address_v4(0x7F000001);
}
/// Obtain an address object that represents the broadcast address.
static address_v4 broadcast()
{
return address_v4(0xFFFFFFFF);
}
#if !defined(ASIO_NO_DEPRECATED)
/// (Deprecated: Use network_v4 class.) Obtain an address object that
/// represents the broadcast address that corresponds to the specified
/// address and netmask.
ASIO_DECL static address_v4 broadcast(
const address_v4& addr, const address_v4& mask);
/// (Deprecated: Use network_v4 class.) Obtain the netmask that corresponds
/// to the address, based on its address class.
ASIO_DECL static address_v4 netmask(const address_v4& addr);
#endif // !defined(ASIO_NO_DEPRECATED)
private:
// The underlying IPv4 address.
asio::detail::in4_addr_type addr_;
};
/// Create an IPv4 address from raw bytes in network order.
/**
* @relates address_v4
*/
inline address_v4 make_address_v4(const address_v4::bytes_type& bytes)
{
return address_v4(bytes);
}
/// Create an IPv4 address from an unsigned integer in host byte order.
/**
* @relates address_v4
*/
inline address_v4 make_address_v4(address_v4::uint_type addr)
{
return address_v4(addr);
}
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(const char* str);
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(
const char* str, asio::error_code& ec);
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(const std::string& str);
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(
const std::string& str, asio::error_code& ec);
#if defined(ASIO_HAS_STD_STRING_VIEW) \
|| defined(GENERATING_DOCUMENTATION)
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(string_view str);
/// Create an IPv4 address from an IP address string in dotted decimal form.
/**
* @relates address_v4
*/
ASIO_DECL address_v4 make_address_v4(
string_view str, asio::error_code& ec);
#endif // defined(ASIO_HAS_STD_STRING_VIEW)
// || defined(GENERATING_DOCUMENTATION)
#if !defined(ASIO_NO_IOSTREAM)
/// Output an address as a string.
/**
* Used to output a human-readable string for a specified address.
*
* @param os The output stream to which the string will be written.
*
* @param addr The address to be written.
*
* @return The output stream.
*
* @relates asio::ip::address_v4
*/
template <typename Elem, typename Traits>
std::basic_ostream<Elem, Traits>& operator<<(
std::basic_ostream<Elem, Traits>& os, const address_v4& addr);
#endif // !defined(ASIO_NO_IOSTREAM)
} // namespace ip
} // namespace asio
#include "asio/detail/pop_options.hpp"
#include "asio/ip/impl/address_v4.hpp"
#if defined(ASIO_HEADER_ONLY)
# include "asio/ip/impl/address_v4.ipp"
#endif // defined(ASIO_HEADER_ONLY)
#endif // ASIO_IP_ADDRESS_V4_HPP
|