m2mb_mdns.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2MB_mDNS_API_H
#define  M2MB_mDNS_API_H
#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/


/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/

#define M2MB_MDNS_MAX_TXT_RECORDS   10 
/* Global typedefs ==============================================================================*/

typedef struct M2MB_MDNS_TXT_RECORD
{
    const UINT8 *svcName;   
    const UINT8 *txt;       
} M2MB_MDNS_TXT_RECORD_T;

typedef struct M2MB_MDNS_SVC_REG_STATUS
{
  const CHAR *svc_Name;     
  M2MB_STATUS_T status;     
} M2MB_MDNS_SVC_REG_STATUS_T;

typedef struct M2MB_MDNS_SVC_INFO
{
  CHAR *instance;           
  CHAR *type;               
  UINT16 port;              
  CHAR *txt[M2MB_MDNS_MAX_TXT_RECORDS]; 
} M2MB_MDNS_SVC_INFO_T;

/*
   @brief Structure for updating or adding a new text record.
   
   @details
     This structure contains the text record in the format key=value and a service name
     that is already registered. If the key in the text record already exists for
     the given service name, the value is updated with the given value, otherwise,
     the text record is added as a new text record.
*/
typedef struct M2MB_MDNS_TXT
{
  const CHAR *svc_Name; 
  const CHAR *txt[10];    
} M2MB_MDNS_TXT_T;

typedef UINT32(*M2MB_MDNS_CB_T)(VOID *arg);

typedef enum M2MB_MDNS_CONF_ID
{
    M2MB_MDNS_CONF_INVALID                  = 0,        
    M2MB_MDNS_CONF_SET_UPDATE_TXT           = 1, 
}M2MB_MDNS_CONF_ID_E;

typedef struct M2MB_MDNS_INIT_PARAMS
{
    UINT32 ip_version;              
    UINT8 device_id;                
    M2MB_MDNS_CB_T app_cb;          
    UINT8 blocking;                 
}M2MB_MDNS_INIT_PARAMS_T;

typedef union 
{
    M2MB_MDNS_TXT_T *txt_update;                     
} M2MB_MDNS_CONF_PARAMS_T;

/* Global functions =========================================================*/

typedef void(*MDNS_NAME_RESULT_CB_T)(struct netif* netif, UINT8 result);

void m2mb_mdns_resp_register_name_result_cb(MDNS_NAME_RESULT_CB_T cb);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_init( HANDLE *handle, M2MB_MDNS_INIT_PARAMS_T * init_params);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_set_hostname(HANDLE handle, const CHAR *host_name);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_register_service(HANDLE handle, 
    M2MB_MDNS_SVC_INFO_T *svc_info, UINT8 blocking );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_unregister_service(HANDLE handle, const CHAR *svc_name);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_set_cfg( HANDLE handle, M2MB_MDNS_CONF_ID_E conf_id, 
    M2MB_MDNS_CONF_PARAMS_T * conf_params);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_deinit( HANDLE handle );

/*-----------------------------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif