WL865E4-P  36.07.001
m2mb_dns_client.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
29 #ifndef M2MB_DNS_CLIENT_API_H
30 #define M2MB_DNS_CLIENT_API_H
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
45 /*-----------------------------------------------------------------------------------------------*/
46 
52 /* Global declarations ==========================================================================*/
53 
54 /* MACROs to set DNS server details */
55 typedef enum M2MB_DNS_SERVER_ID
56 {
57  M2MB_DNS_SERVER_PRIMARY,
58  M2MB_DNS_SERVER_SECONDARY
59 }M2MB_DNS_SERVER_ID_E;
60 
61 /* Global typedefs ==============================================================================*/
70 typedef struct M2MB_HOST_NAME_TO_IP
71 {
72  UINT8 *h_name;
73  UINT8 **h_aliases;
74  INT32 h_addrtype;
75  INT32 h_length;
76  UINT8 **h_addr_list;
77 }M2MB_HOST_NAME_TO_IP_T;
78 
79 
80 /* Global functions =========================================================*/
81 /*---------------------------------------------------------------------------*/
119 /*---------------------------------------------------------------------------*/
120 M2MB_STATUS_T m2mb_dns_client_init( VOID );
121 
122 /*---------------------------------------------------------------------------*/
158 /*---------------------------------------------------------------------------*/
159 M2MB_STATUS_T m2mb_dns_client_is_started( VOID );
160 
161 /*---------------------------------------------------------------------------*/
211 /*---------------------------------------------------------------------------*/
212 M2MB_STATUS_T m2mb_dns_client_deinit( VOID );
213 
214 /*---------------------------------------------------------------------------*/
272 /*-----------------------------------------------------------------------------------------------*/
273 M2MB_STATUS_T m2mb_dns_client_svr_add( UINT8* ipAddr, M2MB_DNS_SERVER_ID_E serverID );
274 
275 /*-----------------------------------------------------------------------------------------------*/
341 /*-----------------------------------------------------------------------------------------------*/
342 M2MB_STATUS_T m2mb_dns_client_svr_delete( M2MB_DNS_SERVER_ID_E serverID );
343 
344 /*-----------------------------------------------------------------------------------------------*/
416 /*-----------------------------------------------------------------------------------------------*/
417 M2MB_HOST_NAME_TO_IP_T* m2mb_dns_client_get_host_by_name( UINT8* name );
418 
419 /*-----------------------------------------------------------------------------------------------*/
495 /*-----------------------------------------------------------------------------------------------*/
496 M2MB_HOST_NAME_TO_IP_T* m2mb_dns_client_get_host_by_name2( UINT8* name, INT32 af );
497 
498 /*---------------------------------------------------------------------------*/
568 /*-----------------------------------------------------------------------------------------------*/
569 M2MB_STATUS_T m2mb_dns_client_resolve_host( UINT8 *hostname, M2MB_IP46_ADDR_T *ipaddr);
570 
571 /*---------------------------------------------------------------------------*/
635 /*-----------------------------------------------------------------------------------------------*/
636 M2MB_STATUS_T m2mb_dns_client_get_server_list( M2MB_NWIF_DNS_SERVER_LIST_T *srv_list );
637 
641 /*-----------------------------------------------------------------------------------------------*/
642 
643 #ifdef __cplusplus
644 }
645 #endif
646 #endif
UINT8
unsigned char UINT8
Definition: m2mb_types.h:83
m2mb_dns_client_get_host_by_name2
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_DNS_SERVER_ID_E
enum M2MB_DNS_SERVER_ID M2MB_DNS_SERVER_ID_E
M2MB_STATUS_T
INT32 M2MB_STATUS_T
Definition: m2mb_status.h:95
m2mb_dns_client_get_server_list
M2MB_STATUS_T m2mb_dns_client_get_server_list(M2MB_NWIF_DNS_SERVER_LIST_T *srv_list)
Get the DNS server list.
m2mb_dns_client_deinit
M2MB_STATUS_T m2mb_dns_client_deinit(VOID)
De-initialize DNS client module.
M2MB_HOST_NAME_TO_IP_T
struct M2MB_HOST_NAME_TO_IP M2MB_HOST_NAME_TO_IP_T
Structure to get IP address from host name.
m2mb_dns_client_get_host_by_name
M2MB_HOST_NAME_TO_IP_T * m2mb_dns_client_get_host_by_name(UINT8 *name)
Get IP address of host name.
M2MB_DNS_SERVER_ID
M2MB_DNS_SERVER_ID
Definition: m2mb_dns_client.h:55
m2mb_dns_client_init
M2MB_STATUS_T m2mb_dns_client_init(VOID)
Initialize DNS client.
m2mb_dns_client_svr_delete
M2MB_STATUS_T m2mb_dns_client_svr_delete(M2MB_DNS_SERVER_ID_E serverID)
Delete the DNS server details.
m2mb_dns_client_svr_add
M2MB_STATUS_T m2mb_dns_client_svr_add(UINT8 *ipAddr, M2MB_DNS_SERVER_ID_E serverID)
Add a DNS server.
M2MB_HOST_NAME_TO_IP
Structure to get IP address from host name.
Definition: m2mb_dns_client.h:70
VOID
void VOID
Definition: m2mb_types.h:72
M2MB_IP46_ADDR
Socket IPv4/IPv6 Internet address union.
Definition: m2mb_socket.h:347
m2mb_dns_client_resolve_host
M2MB_STATUS_T m2mb_dns_client_resolve_host(UINT8 *hostname, M2MB_IP46_ADDR_T *ipaddr)
Resolve the URL details.
INT32
signed int INT32
Definition: m2mb_types.h:80
M2MB_NWIF_DNS_SERVER_LIST
For use with m2mb_nwif_cfgget() to get IP addresses of DNS servers.
Definition: m2mb_nwif.h:136
m2mb_dns_client_is_started
M2MB_STATUS_T m2mb_dns_client_is_started(VOID)
Check the status of DNS client.