Mercurial > code
annotate C++/SocketAddress.h @ 188:ce3e1c3d6fed
Update sockets to style and using instead of typedef
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Tue, 26 Nov 2013 20:32:43 +0100 |
| parents | 18ad49172e6c |
| children | 3c12f0e8bbb9 |
| 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 | |
| 22 #include "Socket.h" | |
| 23 | |
|
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
24 /** |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
25 * @class SocketAddress |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
26 * @brief base class for socket addresses |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
27 * |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
28 * 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
|
29 * on socket clients. |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
30 * |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
31 * @see BindAddressIP |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
32 * @see ConnectAddressIP |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
33 * @see AddressUnix |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
34 */ |
|
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
35 class SocketAddress { |
| 170 | 36 protected: |
| 37 sockaddr_storage m_addr; | |
| 38 socklen_t m_addrlen; | |
| 39 | |
| 40 public: | |
| 41 // Friends. | |
| 42 friend class Socket; | |
| 43 | |
| 44 /** | |
| 45 * Default constructor. | |
| 46 */ | |
| 47 SocketAddress(); | |
| 48 | |
| 49 /** | |
| 50 * Constructor with address and size. | |
| 51 * | |
| 52 * @param addr the address | |
| 53 * @param length the address length | |
| 54 */ | |
| 55 SocketAddress(const sockaddr_storage &addr, socklen_t length); | |
| 56 | |
| 57 /** | |
| 58 * Default destructor. | |
| 59 */ | |
| 60 virtual ~SocketAddress(); | |
| 61 | |
| 62 /** | |
| 63 * Get the address length | |
| 64 * | |
| 65 * @return the length | |
| 66 */ | |
| 67 socklen_t length() const; | |
| 68 | |
| 69 /** | |
| 70 * Get the address. | |
| 71 * | |
| 72 * @return the address | |
| 73 */ | |
| 74 const sockaddr_storage &address() const; | |
| 75 }; | |
| 76 | |
| 77 /** | |
| 78 * @class BindAddressIP | |
| 79 * @brief internet protocol bind class | |
| 80 * | |
| 81 * Create a bind address for internet protocol, | |
| 82 * IPv4 or IPv6. | |
| 83 */ | |
|
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
84 class BindAddressIP : public SocketAddress { |
| 170 | 85 private: |
| 86 std::string m_host; | |
| 87 int m_family; | |
| 88 unsigned m_port; | |
| 89 | |
| 90 public: | |
| 91 /** | |
| 92 * Create a bind end point. | |
| 93 * | |
| 94 * @param addr the interface to bind | |
| 95 * @param port the port | |
| 96 * @param family AF_INET or AF_INET6 | |
| 97 * @throw SocketError on error | |
| 98 */ | |
| 99 BindAddressIP(const std::string &addr, unsigned port, int family); | |
| 100 }; | |
| 101 | |
| 102 /** | |
| 103 * @class ConnectAddressIP | |
| 104 * @brief internet protocol connect class | |
| 105 * | |
| 106 * Create a connect address for internet protocol, | |
| 107 * using getaddrinfo(3). | |
| 108 */ | |
|
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
109 class ConnectAddressIP : public SocketAddress { |
| 170 | 110 public: |
| 111 /** | |
| 112 * Create a connect end point. | |
| 113 * | |
| 114 * @param host the hostname | |
| 115 * @param port the port | |
| 116 * @param family AF_INET, AF_INET6, ... | |
| 117 * @param type of socket SOCK_STREAM, SOCK_DGRAM, ... | |
| 118 * @throw SocketError on error | |
| 119 */ | |
| 120 ConnectAddressIP(const std::string &host, unsigned port, int family, int type = SOCK_STREAM); | |
| 121 }; | |
| 122 | |
|
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
123 #if !defined(_WIN32) |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
124 |
|
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 * @class AddressUnix |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
127 * @brief unix family sockets |
|
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 * 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
|
130 */ |
|
188
ce3e1c3d6fed
Update sockets to style and using instead of typedef
David Demelier <markand@malikania.fr>
parents:
173
diff
changeset
|
131 class AddressUnix : public SocketAddress { |
|
173
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
132 public: |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
133 /** |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
134 * Construct an address to a path. |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
135 * |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
136 * @param path the path |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
137 * @param rm remove the file before (default: false) |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
138 */ |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
139 AddressUnix(const std::string &path, bool rm = false); |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
140 }; |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
141 |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
142 #endif // ! !_WIN32 |
|
18ad49172e6c
Update documentation and add Unix sockets
David Demelier <markand@malikania.fr>
parents:
170
diff
changeset
|
143 |
| 170 | 144 #endif // !_SOCKET_ADDRESS_H_ |