WE310F5  39.00.000
m2mb_dns_client.h File Reference

This file contains the public APIs and structures of the Domain Name System (DNS) client module. More...

Go to the source code of this file.

Data Structures

struct  M2MB_HOST_NAME_TO_IP
 Structure to get IP address from host name. More...
 
struct  M2MB_DNSC_SRV_ADD_INFO
 Structure is used by the Configuration ID M2MB_DNSC_CONF_SET_SRV_ADD to configure the given dns server information. More...
 
struct  M2MB_HOST_NAME_TO_IP_INFO
 Structure is used by the CONF IDs M2MB_DNSC_CONF_GET_HOST_BY_NAME and M2MB_DNSC_CONF_GET_HOST_BY_NAME2 to get IP address from host name. More...
 
union  M2MB_DNSC_CONF_PARAMS_T
 Structure is used by SET/GET configuration paramters of CONF IDs mentioned in enum M2MB_DNSC_CONF_ID_E. More...
 
enum  M2MB_DNS_SERVER_ID {
  M2MB_DNS_SERVER_PRIMARY,
  M2MB_DNS_SERVER_SECONDARY,
  M2MB_DNS_SERVER_MAX_SUPPORTED
}
 MACROs used to signify the server IDs for SET/GET DNS server details. More...
 
enum  M2MB_DNSC_CONF_ID {
  M2MB_DNSC_CONF_INVALID = 0,
  M2MB_DNSC_CONF_SET_SRV_ADD = 1,
  M2MB_DNSC_CONF_SET_SRV_DEL = 2,
  M2MB_DNSC_CONF_GET_IS_STARTED = 3,
  M2MB_DNSC_CONF_GET_SERVER_LIST = 4
}
 DNS client GET/SET Configuration enumeration. More...
 
typedef enum M2MB_DNS_SERVER_ID M2MB_DNS_SERVER_ID_E
 MACROs used to signify the server IDs for SET/GET DNS server details. More...
 
typedef enum M2MB_DNSC_CONF_ID M2MB_DNSC_CONF_ID_E
 DNS client GET/SET Configuration enumeration. More...
 
typedef struct M2MB_HOST_NAME_TO_IP M2MB_HOST_NAME_TO_IP_T
 Structure to get IP address from host name. More...
 
typedef struct M2MB_DNSC_SRV_ADD_INFO M2MB_DNSC_SRV_ADD_INFO_T
 Structure is used by the Configuration ID M2MB_DNSC_CONF_SET_SRV_ADD to configure the given dns server information. More...
 
typedef struct M2MB_HOST_NAME_TO_IP_INFO M2MB_HOST_NAME_TO_IP_INFO_T
 Structure is used by the CONF IDs M2MB_DNSC_CONF_GET_HOST_BY_NAME and M2MB_DNSC_CONF_GET_HOST_BY_NAME2 to get IP address from host name. More...
 
M2MB_STATUS_T m2mb_dns_client_init (HANDLE *handle)
 Initialize DNS client. More...
 
M2MB_STATUS_T m2mb_dns_client_set_cfg (HANDLE handle, M2MB_DNSC_CONF_ID_E conf_id, M2MB_DNSC_CONF_PARAMS_T *conf_params)
 SET the dns client configuration parameters. More...
 
M2MB_STATUS_T m2mb_dns_client_get_cfg (HANDLE handle, M2MB_DNSC_CONF_ID_E conf_id, M2MB_DNSC_CONF_PARAMS_T *conf_params)
 GET the dns client configuration parameters. More...
 
M2MB_HOST_NAME_TO_IP_Tm2mb_dns_client_get_host_by_name (UINT8 *name)
 Get IP address of host name. More...
 
M2MB_HOST_NAME_TO_IP_Tm2mb_dns_client_get_host_by_name2 (UINT8 *name, INT32 af)
 Get the IP address from the host name of the server. More...
 
M2MB_STATUS_T m2mb_dns_client_resolve_host (UINT8 *hostname, M2MB_IP46_ADDR_T *ipaddr)
 Resolve the URL details. More...
 
M2MB_STATUS_T m2mb_dns_client_deinit (HANDLE handle)
 De-initialize DNS client module. More...
 

Detailed Description

This file contains the public APIs and structures of the Domain Name System (DNS) client module.

epl/inc/nwk/m2mb_dns_client.h

DNS client provides APIs to get the IP address from the HOST name.

User has to set the DNS server to get the host name resolved. This module stores the primary and secondary server IP address. User can provide server IP address.

Note
<Notes, dependencies mandatory> Dependencies: m2mb_types.h
Author
Sandeep Itha
Date
30/10/2017

Definition in file m2mb_dns_client.h.