WE310F5  39.00.000
m2mb_dns_client.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
30 #ifndef M2MB_DNS_CLIENT_API_H
31 #define M2MB_DNS_CLIENT_API_H
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
46 /*-----------------------------------------------------------------------------------------------*/
47 
53 /* Global declarations ==========================================================================*/
54 
55 
56 
57 /* Global typedefs ==============================================================================*/
58 
65 typedef enum M2MB_DNS_SERVER_ID
66 {
71 
80 typedef enum M2MB_DNSC_CONF_ID
81 {
88 
97 typedef struct M2MB_HOST_NAME_TO_IP
98 {
105 
116  {
120 
130  {
135 
144 typedef union
145  {
151 
152 /* Global functions =========================================================*/
153 /*---------------------------------------------------------------------------*/
194 /*---------------------------------------------------------------------------*/
196 
197 /*---------------------------------------------------------------------------*/
264 /*---------------------------------------------------------------------------*/
266  M2MB_DNSC_CONF_ID_E conf_id, M2MB_DNSC_CONF_PARAMS_T * conf_params );
267 
268 /*---------------------------------------------------------------------------*/
338 /*---------------------------------------------------------------------------*/
340  M2MB_DNSC_CONF_ID_E conf_id, M2MB_DNSC_CONF_PARAMS_T * conf_params );
341 
342 /*-----------------------------------------------------------------------------------------------*/
414 /*-----------------------------------------------------------------------------------------------*/
416 
417 /*-----------------------------------------------------------------------------------------------*/
488 /*-----------------------------------------------------------------------------------------------*/
490  INT32 af );
491 
492 /*---------------------------------------------------------------------------*/
560 /*-----------------------------------------------------------------------------------------------*/
562  M2MB_IP46_ADDR_T *ipaddr );
563 
564 /*---------------------------------------------------------------------------*/
608 /*---------------------------------------------------------------------------*/
610 
614 /*-----------------------------------------------------------------------------------------------*/
615 
616 #ifdef __cplusplus
617 }
618 #endif
619 #endif
M2MB_STATUS_T m2mb_dns_client_resolve_host(UINT8 *hostname, M2MB_IP46_ADDR_T *ipaddr)
Resolve the URL details.
Socket IPv4/IPv6 Internet address union.
Definition: m2mb_socket.h:386
M2MB_DNS_SERVER_ID_E serverID
M2MB_HOST_NAME_TO_IP_T * m2mb_dns_client_get_host_by_name(UINT8 *name)
Get IP address of host name.
unsigned char UINT8
Definition: m2mb_types.h:86
M2MB_HOST_NAME_TO_IP_T * m2mb_dns_client_get_host_by_name2(UINT8 *name, INT32 af)
Get the IP address from the host name of the server.
M2MB_HOST_NAME_TO_IP_T * getHostInfo
INT32 M2MB_STATUS_T
Definition: m2mb_status.h:97
M2MB_DNS_SERVER_ID_E serverID
struct M2MB_HOST_NAME_TO_IP M2MB_HOST_NAME_TO_IP_T
Structure to get IP address from host name.
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 serve...
Structure is used by SET/GET configuration paramters of CONF IDs mentioned in enum M2MB_DNSC_CONF_ID_...
char CHAR
Definition: m2mb_types.h:76
M2MB_STATUS_T m2mb_dns_client_init(HANDLE *handle)
Initialize DNS client.
M2MB_STATUS_T m2mb_dns_client_deinit(HANDLE handle)
De-initialize DNS client module.
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.
M2MB_DNSC_SRV_ADD_INFO_T * srv_info
M2MB_DNSC_CONF_ID
DNS client GET/SET Configuration enumeration.
M2MB_DNS_SERVER_ID
MACROs used to signify the server IDs for SET/GET DNS server details.
Structure to get IP address from host name.
M2MB_NWIF_DNS_SERVER_LIST_T * get_srv_list
Structure is used by the CONF IDs M2MB_DNSC_CONF_GET_HOST_BY_NAME and M2MB_DNSC_CONF_GET_HOST_BY_NAME...
signed int INT32
Definition: m2mb_types.h:82
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.
void * HANDLE
Definition: m2mb_types.h:98
enum M2MB_DNSC_CONF_ID M2MB_DNSC_CONF_ID_E
DNS client GET/SET Configuration enumeration.
Structure is used by the Configuration ID M2MB_DNSC_CONF_SET_SRV_ADD to configure the given dns serve...
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_NAME...
enum M2MB_DNS_SERVER_ID M2MB_DNS_SERVER_ID_E
MACROs used to signify the server IDs for SET/GET DNS server details.
For use with m2mb_nwif_cfgget() to get IP addresses of DNS servers.
Definition: m2mb_nwif.h:136