Library to resolve text URLs to IP addresses (IPv4)

Dependents:   NetworkSocketAPI NetworkSocketAPI Nucleo-AWS-IoT-mbed

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers DnsQuery.h Source File

DnsQuery.h

00001 /* 
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 #ifndef __DNSQUERY_H__
00019 #define __DNSQUERY_H__
00020 
00021 #include "NetworkStack.h"
00022 #include "UDPSocket.h"
00023 
00024 
00025 /** Function dnsQuery implements the functionality to query a domain name 
00026   * server for an IP-Address of a given hostname.
00027   * @param iface : Network interface to use for DNS resolution.
00028   * @param sock : Previously opened socket to use for DNS resolution.
00029   * @param hostname : The hostname of interest as a string.
00030   *     Format must be without http:// or www. IE google.com, mbed.org, etc.
00031   *     If a standard IP Address is passed, it will be copied into ip unmodified.
00032   * @param ipaddress : A reference to a IPADDRESS_t object which will receive 
00033   *     the resolved IP Address of the host in question.
00034   * @returns 0 on succes, NS_DNS_FAILURE if host is not found,
00035   *     or a negative value for other errors.
00036   */
00037 int32_t dnsQuery(NetworkStack *iface, const char *host, char *ip);
00038 int32_t dnsQuery(UDPSocket *sock, const char *host, char *ip);
00039 
00040 
00041 #endif // __DNSQUERY_H__