Mercurial > code
annotate C++/SocketAddress.h @ 260:2096edb63a4f
Socket: fix Windows
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 05 Oct 2014 13:13:08 +0200 |
parents | 9cfa6fbc9c03 |
children | 6e3b7b9cdfa0 |
rev | line source |
---|---|
170 | 1 /* |
2 * SocketAddress.h -- socket addresses management | |
3 * | |
4 * Copyright (c) 2013, David Demelier <markand@malikania.fr> | |
5 * | |
6 * Permission to use, copy, modify, and/or distribute this software for any | |
7 * purpose with or without fee is hereby granted, provided that the above | |
8 * copyright notice and this permission notice appear in all copies. | |
9 * | |
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
17 */ | |
18 | |
19 #ifndef _SOCKET_ADDRESS_H_ | |
20 #define _SOCKET_ADDRESS_H_ | |
21 | |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
22 /** |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
23 * @class SocketAddress |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
24 * @brief base class for socket addresses |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
25 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
26 * This class is mostly used to bind, connect or getting information |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
27 * on socket clients. |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
28 * |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
29 * @see Internet |
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
30 * @see Unix |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
31 */ |
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
32 class SocketAddress { |
170 | 33 protected: |
34 sockaddr_storage m_addr; | |
35 socklen_t m_addrlen; | |
36 | |
37 public: | |
38 /** | |
39 * Default constructor. | |
40 */ | |
41 SocketAddress(); | |
42 | |
43 /** | |
44 * Constructor with address and size. | |
45 * | |
46 * @param addr the address | |
47 * @param length the address length | |
48 */ | |
49 SocketAddress(const sockaddr_storage &addr, socklen_t length); | |
50 | |
51 /** | |
52 * Default destructor. | |
53 */ | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
54 virtual ~SocketAddress() = default; |
170 | 55 |
56 /** | |
57 * Get the address length | |
58 * | |
59 * @return the length | |
60 */ | |
61 socklen_t length() const; | |
62 | |
63 /** | |
64 * Get the address. | |
65 * | |
66 * @return the address | |
67 */ | |
68 const sockaddr_storage &address() const; | |
246
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
69 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
70 /** |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
71 * Compare the addresses. The check is lexicographical. |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
72 * |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
73 * @param s1 the first address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
74 * @param s2 the second address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
75 * @return true if s1 is less than s2 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
76 */ |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
77 friend bool operator<(const SocketAddress &s1, const SocketAddress &s2); |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
78 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
79 /** |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
80 * Compare the addresses. |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
81 * |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
82 * @param s1 the first address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
83 * @param s2 the second address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
84 * @return true if s1 == s2 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
85 */ |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
86 friend bool operator==(const SocketAddress &s1, const SocketAddress &s2); |
170 | 87 }; |
88 | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
89 namespace address { |
170 | 90 |
91 /** | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
92 * @class Internet |
170 | 93 * @brief internet protocol connect class |
94 * | |
95 * Create a connect address for internet protocol, | |
96 * using getaddrinfo(3). | |
97 */ | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
98 class Internet final : public SocketAddress { |
170 | 99 public: |
100 /** | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
101 * Create an IPv4 or IPV6 end point. |
170 | 102 * |
103 * @param host the hostname | |
104 * @param port the port | |
105 * @param family AF_INET, AF_INET6, ... | |
106 * @throw SocketError on error | |
107 */ | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
108 Internet(const std::string &host, unsigned port, int family); |
170 | 109 }; |
110 | |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
111 #if !defined(_WIN32) |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
112 |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
113 /** |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
114 * @class Unix |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
115 * @brief unix family sockets |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
116 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
117 * Create an address to a specific path. Only available on Unix. |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
118 */ |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
119 class Unix final : public SocketAddress { |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
120 public: |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
121 /** |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
122 * Construct an address to a path. |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
123 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
124 * @param path the path |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
125 * @param rm remove the file before (default: false) |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
126 */ |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
127 Unix(const std::string &path, bool rm = false); |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
128 }; |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
129 |
260 | 130 #endif // ! !_WIN32 |
131 | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
132 } // !address |
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
133 |
170 | 134 #endif // !_SOCKET_ADDRESS_H_ |