m2mb_ntp.h

Go to the documentation of this file.

/* $version: 252422_R1  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_NTP_API_H
#define  M2M_M2MB_NTP_API_H
 
 
/*-----------------------------------------------------------------------------------------------*/
 
 
/* Global declarations ==========================================================================*/
#define M2MB_NTP_DEF_PORT 123       
#define M2MB_NTP_DEF_TIMEOUT 10     
/* Global typedefs ==============================================================================*/
typedef HANDLE M2MB_NTP_HANDLE;
 
typedef enum
{
  M2MB_NTP_VALID_TIME               = 0,          
  M2MB_NTP_ERR_NOT_ENOUGH_RESOURCES = -1,         
  M2MB_NTP_ERR_REG_TIMEOUT          = -2,         
  M2MB_NTP_ERR_CONN_ERR             = -3,         
  M2MB_NTP_ERR_CONN_TIMEOUT         = -4,         
  M2MB_NTP_ERR_HOST_RESOLVE         = -5,         
  M2MB_NTP_ERR_INVALID_PARAMETER    = -6,         
  M2MB_NTP_ERR_SOCK_OPEN            = -7,         
  M2MB_NTP_ERR_TX_TIMEOUT           = -8,         
  M2MB_NTP_ERR_TX_ERROR             = -9,         
  M2MB_NTP_ERR_RX_TIMEOUT           = -11,        
  M2MB_NTP_ERROR                    = -20,        
  M2MB_NTP_ERR_SERVER_AUTH_FAIL     = -30,        
  M2MB_NTP_ERR_KEYS_FILE_MISSING    = -31         
} M2MB_NTP_EVENTS_E;
 
typedef enum
{
  m2mb_ntp_noAuth        = 0,         
  m2mb_ntp_symmetricKey  = 1,         
  m2mb_ntp_autokey       = 2          
} M2MB_NTP_AUTH_TYPE_E;
 
typedef enum
{
  M2MB_NTP_CFG_TIMEOUT        = 0,        
  M2MB_NTP_CFG_PORT           = 1,        
  M2MB_NTP_CFG_SERVER         = 2,        
  M2MB_NTP_CFG_AUTH_TYPE      = 3,        
  M2MB_NTP_CFG_AUTH_KEYID     = 4,        
  M2MB_NTP_CFG_AUTH_KEYSFILE  = 5         
} M2MB_NTP_CFG_E;
 
/*-----------------------------------------------------------------------------------------------*/
typedef void ( *m2mb_ntp_callback )( M2MB_NTP_HANDLE handle,
                                         M2MB_NTP_EVENTS_E ntp_event,
                                         UINT16 resp_size,
                                         void *resp_struct,
                                         void *cb_args );
 
 
/* Global functions =============================================================================*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_init( M2MB_NTP_HANDLE *pHandle, m2mb_ntp_callback callback, void *cb_args);
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_setCid( M2MB_NTP_HANDLE handle, INT16 cid);
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_setCfg( M2MB_NTP_HANDLE handle, M2MB_NTP_CFG_E param, void *value);
 
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_queryServerTime( M2MB_NTP_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_getVersion( M2MB_NTP_HANDLE handle, CHAR *version, UINT16 maxlen );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_ntp_deinit( M2MB_NTP_HANDLE handle );
 
 
/*-----------------------------------------------------------------------------------------------*/
#endif  /* M2M_M2MB_NTP_API_H */