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 enum M2MB_MDNS_COMMAND
{
  M2MB_MDNS_START_E,    
  M2MB_MDNS_STOP_E,     
  M2MB_MDNS_DISABLE_E,  
  M2MB_MDNS_ADDSVC_E,   
  M2MB_MDNS_RMSVC_E,    
  M2MB_MDNS_SET_HOSTNAME_E, 
  M2MB_MDNS_UPDATE_TXT_RECORD_E, 
} M2MB_MDNS_COMMAND_T;

typedef struct M2MB_MDNS_TXT_RECORD
{
        const CHAR *svcName;    
        const CHAR *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;

typedef struct M2MB_MDNS_START
{
  UINT32 ip_version;   
  UINT8 device_id;    
} M2MB_MDNS_START_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;    
} M2MB_MDNS_TXT_T;

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


/* Global functions =========================================================*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_start( M2MB_MDNS_START_T *start, M2MB_MDNS_CB_T app_cb, UINT8 blocking);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_stop(VOID);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_set_hostname(const CHAR *host_name);

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

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_unregister_service(const CHAR *svc_name);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_mdns_update_txt(M2MB_MDNS_TXT_T *txt_update);

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

#ifdef __cplusplus
}
#endif
#endif