m2mb_ping.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* Global declarations ==========================================================================*/
#ifndef  M2MB_PING_H
#define  M2MB_PING_H
/* Failure return codes MUST be < 0 */
#include <stdint.h>
#include <string.h>
#include "m2mb_types.h"

/*-----------------------------------------------------------------------------------------------*/
#define M2MB_PING_PACKET_SIZE_MAX_TX  (1576) 
#define M2MB_PING_PACKET_SIZE_MAX_RX  (1556) 
#define M2MB_NETWORK_PING_SUCCESS    0                                  
#define M2MB_NETWORK_PING_INVALID_IP_ADDRESS    M2MB_NET_ERR_INVALID_IPADDR     
#define M2MB_NETWORK_PING_REQUEST_TIMED_OUT    2        
/* Global typedefs -------------------------------------------------------- */

typedef enum M2MB_PING_CFGID
{
        M2MB_PING_CFGID_ADDRESS,
        M2MB_PING_CFGID_DATA_SIZE,
        M2MB_PING_CFGID_COUNT,
        M2MB_PING_CFGID_STAT
}M2MB_PING_CFGID_E;

typedef enum M2MB_PING_EVENT
{
        M2MB_PING_REQ_RESULT,
        M2MB_PING_COMPLETE
}M2MB_PING_EVENT_E;

typedef struct M2MB_PING_REQ_STATUS
{
        INT32 status;
        UINT32 time;
        UINT16 dataSize;
        UINT8 *pDst;    
}M2MB_PING_REQ_STATUS_T;

typedef struct M2MB_PING_COMPLETE_STATUS
{
        UINT8 success;
        UINT8 *pDst;    
        UINT32  pkt_transmitted;
        UINT32  rsp_received;
        FLOAT32 percentage_pkt_loss;
        UINT32  average_time_in_ms;
}M2MB_PING_COMPLETE_STATUS_T;

typedef INT32 ( *M2MB_PING_CB_T)( void *user_ctx, M2MB_PING_EVENT_E ev, VOID* data );
typedef union M2MB_PING_CONF_PARAMS{
        UINT8 *ipaddr_string;                   
        UINT16 datasize;                                
        UINT32 pingcnt;                                 
        M2MB_PING_CB_T appCb;
}M2MB_PING_CONF_PARAMS_T;

typedef struct M2MB_PING_INIT_PARAMS
{
    M2MB_PING_CB_T user_cb;       
    void *user_ctx;               
}M2MB_PING_INIT_PARAMS_T;


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

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_ping_init(HANDLE *handle, M2MB_PING_INIT_PARAMS_T init_params);

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


/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ping_start( HANDLE handle );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_ping_stop( HANDLE handle );

/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ping_set_cfg( HANDLE handle, M2MB_PING_CFGID_E cfgID, M2MB_PING_CONF_PARAMS_T *conf_params );
/*---------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_ping_get_cfg( HANDLE handle, M2MB_PING_CFGID_E cfgID, M2MB_PING_CONF_PARAMS_T *conf_params );

#endif /* M2MB_PING_H */