ON Semiconductor / mbed-os

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/netsocket/SocketAddress.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

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