Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/SocketAddress.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /*
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2015 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 5 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 6 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 7 *
kenjiArai 0:5b88d5760320 8 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 11 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 13 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 14 * limitations under the License.
kenjiArai 0:5b88d5760320 15 */
kenjiArai 0:5b88d5760320 16
kenjiArai 0:5b88d5760320 17 /** @file SocketAddress.h SocketAddress class */
kenjiArai 0:5b88d5760320 18 /** \addtogroup netsocket
kenjiArai 0:5b88d5760320 19 * @{*/
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #ifndef SOCKET_ADDRESS_H
kenjiArai 0:5b88d5760320 22 #define SOCKET_ADDRESS_H
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 #include "nsapi_types.h"
kenjiArai 0:5b88d5760320 25 #include "mbed_toolchain.h"
kenjiArai 0:5b88d5760320 26
kenjiArai 0:5b88d5760320 27 // Predeclared classes
kenjiArai 0:5b88d5760320 28 class NetworkStack;
kenjiArai 0:5b88d5760320 29 class NetworkInterface;
kenjiArai 0:5b88d5760320 30
kenjiArai 0:5b88d5760320 31 /** SocketAddress class
kenjiArai 0:5b88d5760320 32 *
kenjiArai 0:5b88d5760320 33 * Representation of an IP address and port pair.
kenjiArai 0:5b88d5760320 34 */
kenjiArai 0:5b88d5760320 35 class SocketAddress {
kenjiArai 0:5b88d5760320 36 public:
kenjiArai 0:5b88d5760320 37 /** Create a SocketAddress from a hostname and port
kenjiArai 0:5b88d5760320 38 *
kenjiArai 0:5b88d5760320 39 * The hostname may be either a domain name or an IP address. If the
kenjiArai 0:5b88d5760320 40 * hostname is an IP address, no network transactions will be performed.
kenjiArai 0:5b88d5760320 41 *
kenjiArai 0:5b88d5760320 42 * On failure, the IP address and port will be set to zero
kenjiArai 0:5b88d5760320 43 *
kenjiArai 0:5b88d5760320 44 * @tparam S Type of the Network stack
kenjiArai 0:5b88d5760320 45 * @param stack Network stack to use for DNS resolution
kenjiArai 0:5b88d5760320 46 * @param host Hostname to resolve
kenjiArai 0:5b88d5760320 47 * @param port Optional 16-bit port, defaults to 0
kenjiArai 0:5b88d5760320 48 * @deprecated
kenjiArai 0:5b88d5760320 49 * Constructors hide possible errors. Replaced by
kenjiArai 0:5b88d5760320 50 * NetworkInterface::gethostbyname.
kenjiArai 0:5b88d5760320 51 */
kenjiArai 0:5b88d5760320 52 template <typename S>
kenjiArai 0:5b88d5760320 53 MBED_DEPRECATED_SINCE("mbed-os-5.1.3",
kenjiArai 0:5b88d5760320 54 "Constructors hide possible errors. Replaced by "
kenjiArai 0:5b88d5760320 55 "NetworkInterface::gethostbyname.")
kenjiArai 0:5b88d5760320 56 SocketAddress(S *stack, const char *host, uint16_t port = 0)
kenjiArai 0:5b88d5760320 57 {
kenjiArai 0:5b88d5760320 58 _SocketAddress(nsapi_create_stack(stack), host, port);
kenjiArai 0:5b88d5760320 59 }
kenjiArai 0:5b88d5760320 60
kenjiArai 0:5b88d5760320 61 /** Create a SocketAddress from a raw IP address and port
kenjiArai 0:5b88d5760320 62 *
kenjiArai 0:5b88d5760320 63 * @note To construct from a host name, use NetworkInterface::gethostbyname
kenjiArai 0:5b88d5760320 64 *
kenjiArai 0:5b88d5760320 65 * @param addr Raw IP address
kenjiArai 0:5b88d5760320 66 * @param port Optional 16-bit port, defaults to 0
kenjiArai 0:5b88d5760320 67 */
kenjiArai 0:5b88d5760320 68 SocketAddress(nsapi_addr_t addr = nsapi_addr_t(), uint16_t port = 0);
kenjiArai 0:5b88d5760320 69
kenjiArai 0:5b88d5760320 70 /** Create a SocketAddress from an IP address and port
kenjiArai 0:5b88d5760320 71 *
kenjiArai 0:5b88d5760320 72 * @param addr Null-terminated representation of the IP address
kenjiArai 0:5b88d5760320 73 * @param port Optional 16-bit port, defaults to 0
kenjiArai 0:5b88d5760320 74 */
kenjiArai 0:5b88d5760320 75 SocketAddress(const char *addr, uint16_t port = 0);
kenjiArai 0:5b88d5760320 76
kenjiArai 0:5b88d5760320 77 /** Create a SocketAddress from raw IP bytes, IP version, and port
kenjiArai 0:5b88d5760320 78 *
kenjiArai 0:5b88d5760320 79 * @param bytes Raw IP address in big-endian order
kenjiArai 0:5b88d5760320 80 * @param version IP address version, NSAPI_IPv4 or NSAPI_IPv6
kenjiArai 0:5b88d5760320 81 * @param port Optional 16-bit port, defaults to 0
kenjiArai 0:5b88d5760320 82 */
kenjiArai 0:5b88d5760320 83 SocketAddress(const void *bytes, nsapi_version_t version, uint16_t port = 0);
kenjiArai 0:5b88d5760320 84
kenjiArai 0:5b88d5760320 85 /** Create a SocketAddress from another SocketAddress
kenjiArai 0:5b88d5760320 86 *
kenjiArai 0:5b88d5760320 87 * @param addr SocketAddress to copy
kenjiArai 0:5b88d5760320 88 */
kenjiArai 0:5b88d5760320 89 SocketAddress(const SocketAddress &addr);
kenjiArai 0:5b88d5760320 90
kenjiArai 0:5b88d5760320 91 /** Destructor */
kenjiArai 0:5b88d5760320 92 ~SocketAddress();
kenjiArai 0:5b88d5760320 93
kenjiArai 0:5b88d5760320 94 /** Set the IP address
kenjiArai 0:5b88d5760320 95 *
kenjiArai 0:5b88d5760320 96 * @param addr Null-terminated represention of the IP address
kenjiArai 0:5b88d5760320 97 * @return True if address is a valid representation of an IP address,
kenjiArai 0:5b88d5760320 98 * otherwise False and SocketAddress is set to null
kenjiArai 0:5b88d5760320 99 */
kenjiArai 0:5b88d5760320 100 bool set_ip_address(const char *addr);
kenjiArai 0:5b88d5760320 101
kenjiArai 0:5b88d5760320 102 /** Set the raw IP bytes and IP version
kenjiArai 0:5b88d5760320 103 *
kenjiArai 0:5b88d5760320 104 * @param bytes Raw IP address in big-endian order
kenjiArai 0:5b88d5760320 105 * @param version IP address version, NSAPI_IPv4 or NSAPI_IPv6
kenjiArai 0:5b88d5760320 106 */
kenjiArai 0:5b88d5760320 107 void set_ip_bytes(const void *bytes, nsapi_version_t version);
kenjiArai 0:5b88d5760320 108
kenjiArai 0:5b88d5760320 109 /** Set the raw IP address
kenjiArai 0:5b88d5760320 110 *
kenjiArai 0:5b88d5760320 111 * @param addr Raw IP address
kenjiArai 0:5b88d5760320 112 */
kenjiArai 0:5b88d5760320 113 void set_addr(nsapi_addr_t addr);
kenjiArai 0:5b88d5760320 114
kenjiArai 0:5b88d5760320 115 /** Set the port
kenjiArai 0:5b88d5760320 116 *
kenjiArai 0:5b88d5760320 117 * @param port 16-bit port
kenjiArai 0:5b88d5760320 118 */
kenjiArai 0:5b88d5760320 119 void set_port(uint16_t port);
kenjiArai 0:5b88d5760320 120
kenjiArai 0:5b88d5760320 121 /** Get the human-readable IP address
kenjiArai 0:5b88d5760320 122 *
kenjiArai 0:5b88d5760320 123 * Allocates memory for a string and converts binary address to
kenjiArai 0:5b88d5760320 124 * human-readable format. String is freed in the destructor.
kenjiArai 0:5b88d5760320 125 *
kenjiArai 0:5b88d5760320 126 * @return Null-terminated representation of the IP Address
kenjiArai 0:5b88d5760320 127 */
kenjiArai 0:5b88d5760320 128 const char *get_ip_address() const;
kenjiArai 0:5b88d5760320 129
kenjiArai 0:5b88d5760320 130 /** Get the raw IP bytes
kenjiArai 0:5b88d5760320 131 *
kenjiArai 0:5b88d5760320 132 * @return Raw IP address in big-endian order
kenjiArai 0:5b88d5760320 133 */
kenjiArai 0:5b88d5760320 134 const void *get_ip_bytes() const;
kenjiArai 0:5b88d5760320 135
kenjiArai 0:5b88d5760320 136 /** Get the IP address version
kenjiArai 0:5b88d5760320 137 *
kenjiArai 0:5b88d5760320 138 * @return IP address version, NSAPI_IPv4 or NSAPI_IPv6
kenjiArai 0:5b88d5760320 139 */
kenjiArai 0:5b88d5760320 140 nsapi_version_t get_ip_version() const;
kenjiArai 0:5b88d5760320 141
kenjiArai 0:5b88d5760320 142 /** Get the raw IP address
kenjiArai 0:5b88d5760320 143 *
kenjiArai 0:5b88d5760320 144 * @return Raw IP address
kenjiArai 0:5b88d5760320 145 */
kenjiArai 0:5b88d5760320 146 nsapi_addr_t get_addr() const;
kenjiArai 0:5b88d5760320 147
kenjiArai 0:5b88d5760320 148 /** Get the port
kenjiArai 0:5b88d5760320 149 *
kenjiArai 0:5b88d5760320 150 * @return The 16-bit port
kenjiArai 0:5b88d5760320 151 */
kenjiArai 0:5b88d5760320 152 uint16_t get_port() const;
kenjiArai 0:5b88d5760320 153
kenjiArai 0:5b88d5760320 154 /** Test if address is zero
kenjiArai 0:5b88d5760320 155 *
kenjiArai 0:5b88d5760320 156 * @return True if address is not zero
kenjiArai 0:5b88d5760320 157 */
kenjiArai 0:5b88d5760320 158 operator bool() const;
kenjiArai 0:5b88d5760320 159
kenjiArai 0:5b88d5760320 160 /** Copy address from another SocketAddress
kenjiArai 0:5b88d5760320 161 *
kenjiArai 0:5b88d5760320 162 * @param addr SocketAddress to copy
kenjiArai 0:5b88d5760320 163 */
kenjiArai 0:5b88d5760320 164 SocketAddress &operator=(const SocketAddress &addr);
kenjiArai 0:5b88d5760320 165
kenjiArai 0:5b88d5760320 166 /** Compare two addresses for equality
kenjiArai 0:5b88d5760320 167 *
kenjiArai 0:5b88d5760320 168 * @return True if both addresses are equal
kenjiArai 0:5b88d5760320 169 */
kenjiArai 0:5b88d5760320 170 friend bool operator==(const SocketAddress &a, const SocketAddress &b);
kenjiArai 0:5b88d5760320 171
kenjiArai 0:5b88d5760320 172 /** Compare two addresses for equality
kenjiArai 0:5b88d5760320 173 *
kenjiArai 0:5b88d5760320 174 * @return True if both addresses are not equal
kenjiArai 0:5b88d5760320 175 */
kenjiArai 0:5b88d5760320 176 friend bool operator!=(const SocketAddress &a, const SocketAddress &b);
kenjiArai 0:5b88d5760320 177
kenjiArai 0:5b88d5760320 178 private:
kenjiArai 0:5b88d5760320 179 void _SocketAddress(NetworkStack *iface, const char *host, uint16_t port);
kenjiArai 0:5b88d5760320 180
kenjiArai 0:5b88d5760320 181 /** Initialize memory */
kenjiArai 0:5b88d5760320 182 void mem_init(void);
kenjiArai 0:5b88d5760320 183
kenjiArai 0:5b88d5760320 184 mutable char *_ip_address;
kenjiArai 0:5b88d5760320 185 nsapi_addr_t _addr;
kenjiArai 0:5b88d5760320 186 uint16_t _port;
kenjiArai 0:5b88d5760320 187 };
kenjiArai 0:5b88d5760320 188
kenjiArai 0:5b88d5760320 189
kenjiArai 0:5b88d5760320 190 #endif
kenjiArai 0:5b88d5760320 191
kenjiArai 0:5b88d5760320 192 /** @}*/