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.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
DNS Class Reference
[Netsocket]
Base class for DNS provider. More...
#include <DNS.h>
Inherited by NetworkInterface, and NetworkStack.
Public Types | |
| typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address) | hostbyname_cb_t ) |
| Hostname translation callback for gethostbyname_async. | |
Public Member Functions | |
| virtual nsapi_error_t | gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)=0 |
| Translate a hostname to an IP address with specific version using network interface name. | |
| virtual nsapi_value_or_error_t | gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)=0 |
| Translate a hostname to an IP address (asynchronous) | |
| virtual nsapi_error_t | gethostbyname_async_cancel (int id)=0 |
| Cancel asynchronous hostname translation. | |
| virtual nsapi_error_t | add_dns_server (const SocketAddress &address, const char *interface_name=NULL)=0 |
| Add a domain name server to list of servers to query. | |
Detailed Description
Base class for DNS provider.
Definition at line 25 of file DNS.h.
Member Typedef Documentation
| typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address) hostbyname_cb_t) |
Hostname translation callback for gethostbyname_async.
The callback is called after DNS resolution completes, or a failure occurs.
Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.
- Parameters:
-
result NSAPI_ERROR_OK on success, negative error code on failure. address On success, destination for the host SocketAddress.
Reimplemented in NetworkInterface, and NetworkStack.
Member Function Documentation
| virtual nsapi_error_t add_dns_server | ( | const SocketAddress & | address, |
| const char * | interface_name = NULL |
||
| ) | [pure virtual] |
Add a domain name server to list of servers to query.
- Parameters:
-
address DNS server host address. interface_name Network interface name
- Returns:
- NSAPI_ERROR_OK on success, negative error code on failure.
Implemented in NetworkInterface, and NetworkStack.
| virtual nsapi_error_t gethostbyname | ( | const char * | host, |
| SocketAddress * | address, | ||
| nsapi_version_t | version = NSAPI_UNSPEC, |
||
| const char * | interface_name = NULL |
||
| ) | [pure virtual] |
Translate a hostname to an IP address with specific version using network interface name.
The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.
If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.
- Parameters:
-
host Hostname to resolve. address Pointer to a SocketAddress to store the result. version IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC). interface_name Network interface name
- Returns:
- NSAPI_ERROR_OK on success, negative error code on failure.
Implemented in NetworkInterface, and NetworkStack.
| virtual nsapi_value_or_error_t gethostbyname_async | ( | const char * | host, |
| hostbyname_cb_t | callback, | ||
| nsapi_version_t | version = NSAPI_UNSPEC, |
||
| const char * | interface_name = NULL |
||
| ) | [pure virtual] |
Translate a hostname to an IP address (asynchronous)
The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.
If no stack-specific DNS resolution is provided, the hostname will be resolved using a UDP socket on the stack.
The call is non-blocking. The result of the DNS operation is returned by the callback. If this function returns failure, the callback will not be called. If it is successful, (the IP address was found from the DNS cache), the callback will be called before the function returns.
- Parameters:
-
host Hostname to resolve. callback Callback that is called to return the result. version IP version of address to resolve. NSAPI_UNSPEC indicates that the version is chosen by the stack (defaults to NSAPI_UNSPEC). interface_name Network interface name
- Returns:
- NSAPI_ERROR_OK on immediate success, negative error code on immediate failure or a positive unique ID that represents the hostname translation operation and can be passed to cancel.
Implemented in NetworkInterface, and NetworkStack.
| virtual nsapi_error_t gethostbyname_async_cancel | ( | int | id ) | [pure virtual] |
Cancel asynchronous hostname translation.
When translation is canceled, callback is not called.
- Parameters:
-
id Unique ID of the hostname translation operation returned by gethostbyname_async.
- Returns:
- NSAPI_ERROR_OK on success, negative error code on failure.
Implemented in NetworkInterface, and NetworkStack.
Generated on Tue Jul 12 2022 13:55:30 by
1.7.2