Mercurial > code
annotate C++/SocketAddress.h @ 304:bae4af872cde
MFS
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 15 Nov 2014 13:19:30 +0100 |
parents | c019f194475a |
children | cba77da58496 |
rev | line source |
---|---|
170 | 1 /* |
2 * SocketAddress.h -- socket addresses management | |
3 * | |
299 | 4 * Copyright (c) 2013, 2014 David Demelier <markand@malikania.fr> |
170 | 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 | |
273
4b2e82992765
Socket: SocketAddress also require string header
David Demelier <markand@malikania.fr>
parents:
272
diff
changeset
|
22 #include <string> |
4b2e82992765
Socket: SocketAddress also require string header
David Demelier <markand@malikania.fr>
parents:
272
diff
changeset
|
23 |
272
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
24 #if defined(_WIN32) |
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
25 # include <Winsock2.h> |
282 | 26 # include <Ws2tcpip.h> |
272
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
27 #else |
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
28 # include <sys/socket.h> |
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
29 #endif |
6e3b7b9cdfa0
Socket: SocketAddress lacks headers for sockaddr_storage
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
30 |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
31 /** |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
32 * @class SocketAddress |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
33 * @brief base class for socket addresses |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
34 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
35 * 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
|
36 * on socket clients. |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
37 * |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
38 * @see Internet |
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
39 * @see Unix |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
40 */ |
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
41 class SocketAddress { |
170 | 42 protected: |
43 sockaddr_storage m_addr; | |
44 socklen_t m_addrlen; | |
45 | |
46 public: | |
47 /** | |
48 * Default constructor. | |
49 */ | |
50 SocketAddress(); | |
51 | |
52 /** | |
53 * Constructor with address and size. | |
54 * | |
55 * @param addr the address | |
56 * @param length the address length | |
57 */ | |
58 SocketAddress(const sockaddr_storage &addr, socklen_t length); | |
59 | |
60 /** | |
61 * Default destructor. | |
62 */ | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
63 virtual ~SocketAddress() = default; |
170 | 64 |
65 /** | |
66 * Get the address length | |
67 * | |
68 * @return the length | |
69 */ | |
70 socklen_t length() const; | |
71 | |
72 /** | |
73 * Get the address. | |
74 * | |
75 * @return the address | |
76 */ | |
77 const sockaddr_storage &address() const; | |
246
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. The check is lexicographical. |
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 is less than 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); |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
87 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
88 /** |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
89 * Compare the addresses. |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
90 * |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
91 * @param s1 the first address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
92 * @param s2 the second address |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
93 * @return true if s1 == s2 |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
94 */ |
9cfa6fbc9c03
Socket: add operators for SocketAddress
David Demelier <markand@malikania.fr>
parents:
245
diff
changeset
|
95 friend bool operator==(const SocketAddress &s1, const SocketAddress &s2); |
170 | 96 }; |
97 | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
98 namespace address { |
170 | 99 |
100 /** | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
101 * @class Internet |
170 | 102 * @brief internet protocol connect class |
103 * | |
104 * Create a connect address for internet protocol, | |
105 * using getaddrinfo(3). | |
106 */ | |
297
836903141476
Socket: provide experimental SSL support
David Demelier <markand@malikania.fr>
parents:
282
diff
changeset
|
107 class Internet : public SocketAddress { |
170 | 108 public: |
109 /** | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
110 * Create an IPv4 or IPV6 end point. |
170 | 111 * |
112 * @param host the hostname | |
113 * @param port the port | |
114 * @param family AF_INET, AF_INET6, ... | |
115 * @throw SocketError on error | |
116 */ | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
117 Internet(const std::string &host, unsigned port, int family); |
170 | 118 }; |
119 | |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
120 #if !defined(_WIN32) |
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 /** |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
123 * @class Unix |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
124 * @brief unix family sockets |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
125 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
126 * 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
|
127 */ |
297
836903141476
Socket: provide experimental SSL support
David Demelier <markand@malikania.fr>
parents:
282
diff
changeset
|
128 class Unix : public SocketAddress { |
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
129 public: |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
130 /** |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
131 * Construct an address to a path. |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
132 * |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
133 * @param path the path |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
134 * @param rm remove the file before (default: false) |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
135 */ |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
136 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
|
137 }; |
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
138 |
260 | 139 #endif // ! !_WIN32 |
140 | |
245
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
141 } // !address |
3c12f0e8bbb9
Converter: add cstring missing
David Demelier <markand@malikania.fr>
parents:
188
diff
changeset
|
142 |
170 | 143 #endif // !_SOCKET_ADDRESS_H_ |