EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/netsocket/SocketAddress.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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