BA / SerialCom

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of OmniWheels by Gustav Atmel

mbed-os/features/netsocket/nsapi_dns.h@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gustavatmel 1:9c5af431a1f1 1
gustavatmel 1:9c5af431a1f1 2 /** \addtogroup netsocket */
gustavatmel 1:9c5af431a1f1 3 /** @{*/
gustavatmel 1:9c5af431a1f1 4 /* nsapi_dns.h
gustavatmel 1:9c5af431a1f1 5 * Original work Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
gustavatmel 1:9c5af431a1f1 6 * Modified work Copyright (c) 2015 ARM Limited
gustavatmel 1:9c5af431a1f1 7 *
gustavatmel 1:9c5af431a1f1 8 * Licensed under the Apache License, Version 2.0 (the "License");
gustavatmel 1:9c5af431a1f1 9 * you may not use this file except in compliance with the License.
gustavatmel 1:9c5af431a1f1 10 * You may obtain a copy of the License at
gustavatmel 1:9c5af431a1f1 11 *
gustavatmel 1:9c5af431a1f1 12 * http://www.apache.org/licenses/LICENSE-2.0
gustavatmel 1:9c5af431a1f1 13 *
gustavatmel 1:9c5af431a1f1 14 * Unless required by applicable law or agreed to in writing, software
gustavatmel 1:9c5af431a1f1 15 * distributed under the License is distributed on an "AS IS" BASIS,
gustavatmel 1:9c5af431a1f1 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gustavatmel 1:9c5af431a1f1 17 * See the License for the specific language governing permissions and
gustavatmel 1:9c5af431a1f1 18 * limitations under the License.
gustavatmel 1:9c5af431a1f1 19 */
gustavatmel 1:9c5af431a1f1 20 #ifndef NSAPI_DNS_H
gustavatmel 1:9c5af431a1f1 21 #define NSAPI_DNS_H
gustavatmel 1:9c5af431a1f1 22
gustavatmel 1:9c5af431a1f1 23 #include "nsapi_types.h"
gustavatmel 1:9c5af431a1f1 24 #ifdef __cplusplus
gustavatmel 1:9c5af431a1f1 25 #include "netsocket/NetworkStack.h"
gustavatmel 1:9c5af431a1f1 26 #endif
gustavatmel 1:9c5af431a1f1 27
gustavatmel 1:9c5af431a1f1 28 #ifndef __cplusplus
gustavatmel 1:9c5af431a1f1 29
gustavatmel 1:9c5af431a1f1 30
gustavatmel 1:9c5af431a1f1 31 /** Query a domain name server for an IP address of a given hostname
gustavatmel 1:9c5af431a1f1 32 *
gustavatmel 1:9c5af431a1f1 33 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 34 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 35 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 36 * @param version IP version to resolve
gustavatmel 1:9c5af431a1f1 37 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 38 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 39 */
gustavatmel 1:9c5af431a1f1 40 nsapi_error_t nsapi_dns_query(nsapi_stack_t *stack, const char *host,
gustavatmel 1:9c5af431a1f1 41 nsapi_addr_t *addr, nsapi_version_t version);
gustavatmel 1:9c5af431a1f1 42
gustavatmel 1:9c5af431a1f1 43 /** Query a domain name server for multiple IP address of a given hostname
gustavatmel 1:9c5af431a1f1 44 *
gustavatmel 1:9c5af431a1f1 45 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 46 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 47 * @param addr Array for the host addresses
gustavatmel 1:9c5af431a1f1 48 * @param addr_count Number of addresses allocated in the array
gustavatmel 1:9c5af431a1f1 49 * @param version IP version to resolve
gustavatmel 1:9c5af431a1f1 50 * @return Number of addresses found on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 51 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 52 */
gustavatmel 1:9c5af431a1f1 53 nsapi_size_or_error_t nsapi_dns_query_multiple(nsapi_stack_t *stack, const char *host,
gustavatmel 1:9c5af431a1f1 54 nsapi_addr_t *addr, nsapi_size_t addr_count, nsapi_version_t version);
gustavatmel 1:9c5af431a1f1 55
gustavatmel 1:9c5af431a1f1 56 /** Add a domain name server to list of servers to query
gustavatmel 1:9c5af431a1f1 57 *
gustavatmel 1:9c5af431a1f1 58 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 59 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 60 */
gustavatmel 1:9c5af431a1f1 61 nsapi_error_t nsapi_dns_add_server(nsapi_addr_t addr);
gustavatmel 1:9c5af431a1f1 62
gustavatmel 1:9c5af431a1f1 63
gustavatmel 1:9c5af431a1f1 64 #else
gustavatmel 1:9c5af431a1f1 65
gustavatmel 1:9c5af431a1f1 66
gustavatmel 1:9c5af431a1f1 67 /** Query a domain name server for an IP address of a given hostname
gustavatmel 1:9c5af431a1f1 68 *
gustavatmel 1:9c5af431a1f1 69 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 70 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 71 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 72 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 73 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 74 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 75 */
gustavatmel 1:9c5af431a1f1 76 nsapi_error_t nsapi_dns_query(NetworkStack *stack, const char *host,
gustavatmel 1:9c5af431a1f1 77 SocketAddress *addr, nsapi_version_t version = NSAPI_IPv4);
gustavatmel 1:9c5af431a1f1 78
gustavatmel 1:9c5af431a1f1 79 /** Query a domain name server for an IP address of a given hostname
gustavatmel 1:9c5af431a1f1 80 *
gustavatmel 1:9c5af431a1f1 81 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 82 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 83 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 84 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 85 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 86 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 87 */
gustavatmel 1:9c5af431a1f1 88 extern "C" nsapi_error_t nsapi_dns_query(nsapi_stack_t *stack, const char *host,
gustavatmel 1:9c5af431a1f1 89 nsapi_addr_t *addr, nsapi_version_t version = NSAPI_IPv4);
gustavatmel 1:9c5af431a1f1 90
gustavatmel 1:9c5af431a1f1 91 /** Query a domain name server for an IP address of a given hostname
gustavatmel 1:9c5af431a1f1 92 *
gustavatmel 1:9c5af431a1f1 93 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 94 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 95 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 96 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 97 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 98 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 99 */
gustavatmel 1:9c5af431a1f1 100 template <typename S>
gustavatmel 1:9c5af431a1f1 101 nsapi_error_t nsapi_dns_query(S *stack, const char *host,
gustavatmel 1:9c5af431a1f1 102 SocketAddress *addr, nsapi_version_t version = NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 103 {
gustavatmel 1:9c5af431a1f1 104 return nsapi_dns_query(nsapi_create_stack(stack), host, addr, version);
gustavatmel 1:9c5af431a1f1 105 }
gustavatmel 1:9c5af431a1f1 106
gustavatmel 1:9c5af431a1f1 107 /** Query a domain name server for multiple IP address of a given hostname
gustavatmel 1:9c5af431a1f1 108 *
gustavatmel 1:9c5af431a1f1 109 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 110 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 111 * @param addr Array for the host addresses
gustavatmel 1:9c5af431a1f1 112 * @param addr_count Number of addresses allocated in the array
gustavatmel 1:9c5af431a1f1 113 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 114 * @return Number of addresses found on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 115 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 116 */
gustavatmel 1:9c5af431a1f1 117 nsapi_size_or_error_t nsapi_dns_query_multiple(NetworkStack *stack, const char *host,
gustavatmel 1:9c5af431a1f1 118 SocketAddress *addr, nsapi_size_t addr_count, nsapi_version_t version = NSAPI_IPv4);
gustavatmel 1:9c5af431a1f1 119
gustavatmel 1:9c5af431a1f1 120 /** Query a domain name server for multiple IP address of a given hostname
gustavatmel 1:9c5af431a1f1 121 *
gustavatmel 1:9c5af431a1f1 122 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 123 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 124 * @param addr Array for the host addresses
gustavatmel 1:9c5af431a1f1 125 * @param addr_count Number of addresses allocated in the array
gustavatmel 1:9c5af431a1f1 126 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 127 * @return Number of addresses found on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 128 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 129 */
gustavatmel 1:9c5af431a1f1 130 extern "C" nsapi_size_or_error_t nsapi_dns_query_multiple(nsapi_stack_t *stack, const char *host,
gustavatmel 1:9c5af431a1f1 131 nsapi_addr_t *addr, nsapi_size_t addr_count, nsapi_version_t version = NSAPI_IPv4);
gustavatmel 1:9c5af431a1f1 132
gustavatmel 1:9c5af431a1f1 133 /** Query a domain name server for multiple IP address of a given hostname
gustavatmel 1:9c5af431a1f1 134 *
gustavatmel 1:9c5af431a1f1 135 * @param stack Network stack as target for DNS query
gustavatmel 1:9c5af431a1f1 136 * @param host Hostname to resolve
gustavatmel 1:9c5af431a1f1 137 * @param addr Array for the host addresses
gustavatmel 1:9c5af431a1f1 138 * @param addr_count Number of addresses allocated in the array
gustavatmel 1:9c5af431a1f1 139 * @param version IP version to resolve (defaults to NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 140 * @return Number of addresses found on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 141 * NSAPI_ERROR_DNS_FAILURE indicates the host could not be found
gustavatmel 1:9c5af431a1f1 142 */
gustavatmel 1:9c5af431a1f1 143 template <typename S>
gustavatmel 1:9c5af431a1f1 144 nsapi_size_or_error_t nsapi_dns_query_multiple(S *stack, const char *host,
gustavatmel 1:9c5af431a1f1 145 SocketAddress *addr, nsapi_size_t addr_count, nsapi_version_t version = NSAPI_IPv4)
gustavatmel 1:9c5af431a1f1 146 {
gustavatmel 1:9c5af431a1f1 147 return nsapi_dns_query_multiple(nsapi_create_stack(stack),
gustavatmel 1:9c5af431a1f1 148 host, addr, addr_count, version);
gustavatmel 1:9c5af431a1f1 149 }
gustavatmel 1:9c5af431a1f1 150
gustavatmel 1:9c5af431a1f1 151 /** Add a domain name server to list of servers to query
gustavatmel 1:9c5af431a1f1 152 *
gustavatmel 1:9c5af431a1f1 153 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 154 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 155 */
gustavatmel 1:9c5af431a1f1 156 extern "C" nsapi_error_t nsapi_dns_add_server(nsapi_addr_t addr);
gustavatmel 1:9c5af431a1f1 157
gustavatmel 1:9c5af431a1f1 158 /** Add a domain name server to list of servers to query
gustavatmel 1:9c5af431a1f1 159 *
gustavatmel 1:9c5af431a1f1 160 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 161 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 162 */
gustavatmel 1:9c5af431a1f1 163 static inline nsapi_error_t nsapi_dns_add_server(const SocketAddress &address)
gustavatmel 1:9c5af431a1f1 164 {
gustavatmel 1:9c5af431a1f1 165 return nsapi_dns_add_server(address.get_addr());
gustavatmel 1:9c5af431a1f1 166 }
gustavatmel 1:9c5af431a1f1 167
gustavatmel 1:9c5af431a1f1 168 /** Add a domain name server to list of servers to query
gustavatmel 1:9c5af431a1f1 169 *
gustavatmel 1:9c5af431a1f1 170 * @param addr Destination for the host address
gustavatmel 1:9c5af431a1f1 171 * @return 0 on success, negative error code on failure
gustavatmel 1:9c5af431a1f1 172 */
gustavatmel 1:9c5af431a1f1 173 static inline nsapi_error_t nsapi_dns_add_server(const char *address)
gustavatmel 1:9c5af431a1f1 174 {
gustavatmel 1:9c5af431a1f1 175 return nsapi_dns_add_server(SocketAddress(address));
gustavatmel 1:9c5af431a1f1 176 }
gustavatmel 1:9c5af431a1f1 177
gustavatmel 1:9c5af431a1f1 178
gustavatmel 1:9c5af431a1f1 179 #endif
gustavatmel 1:9c5af431a1f1 180
gustavatmel 1:9c5af431a1f1 181 #endif
gustavatmel 1:9c5af431a1f1 182
gustavatmel 1:9c5af431a1f1 183 /** @}*/