WL865E4-P  36.07.001
m2mb_ping.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
29 /* Global declarations ==========================================================================*/
30 #ifndef M2MB_PING_H
31 #define M2MB_PING_H
32 /* Failure return codes MUST be < 0 */
33 #include <stdint.h>
34 #include <string.h>
35 #include "m2mb_types.h"
36 
49 /*-----------------------------------------------------------------------------------------------*/
50 #define M2MB_PING_PACKET_SIZE_MAX_TX (1576)
51 #define M2MB_PING_PACKET_SIZE_MAX_RX (1556)
54 #define M2MB_NETWORK_PING_SUCCESS 0
55 #define M2MB_NETWORK_PING_INVALID_IP_ADDRESS M2MB_NET_ERR_INVALID_IPADDR
56 #define M2MB_NETWORK_PING_REQUEST_TIMED_OUT 2
58 /* Global typedefs -------------------------------------------------------- */
59 
68 typedef enum M2MB_PING_CFGID
69 {
71  M2MB_PING_CFGID_ADDRESS,
73  M2MB_PING_CFGID_DATA_SIZE,
75  M2MB_PING_CFGID_COUNT,
77  M2MB_PING_CFGID_STAT,
79  M2MB_PING_CFGID_CB
80 }M2MB_PING_CFGID_E;
81 
89 typedef enum M2MB_PING_EVENT
90 {
92  M2MB_PING_REQ_RESULT,
94  M2MB_PING_COMPLETE
95 }M2MB_PING_EVENT_E;
96 
105 typedef struct M2MB_PING_REQ_STATUS
106 {
108  INT32 status;
110  UINT32 time;
112  UINT16 dataSize;
114  UINT8 *pDst;
115 }M2MB_PING_REQ_STATUS_T;
116 
125 typedef struct M2MB_PING_COMPLETE_STATUS
126 {
128  UINT8 success;
130  UINT8 *pDst;
131 }M2MB_PING_COMPLETE_STATUS_T;
132 
150 typedef INT32 ( *M2MB_PING_CB_T)( M2MB_PING_EVENT_E ev, VOID* data );
151 
152 /* Global functions =========================================================*/
153 /*---------------------------------------------------------------------------*/
231 /*---------------------------------------------------------------------------*/
232 INT32 m2mb_ping_start( VOID );
233 
234 /*---------------------------------------------------------------------------*/
318 /*---------------------------------------------------------------------------*/
319 INT32 m2mb_ping_stop( VOID );
320 
321 /*---------------------------------------------------------------------------*/
406 /*-----------------------------------------------------------------------------------------------*/
407 INT32 m2mb_ping_cfg_set( M2MB_PING_CFGID_E cfgID, UINT32 value );
408 
409 /*---------------------------------------------------------------------------*/
499 /*-----------------------------------------------------------------------------------------------*/
500 INT32 m2mb_ping_cfg_get( M2MB_PING_CFGID_E cfgID, VOID *value );
502 #endif /* M2MB_PING_H */
UINT8
unsigned char UINT8
Definition: m2mb_types.h:83
M2MB_PING_CFGID
M2MB_PING_CFGID
M2MB_PING_CFGID_E defines configuration IDs for ping.
Definition: m2mb_ping.h:68
m2mb_ping_cfg_set
INT32 m2mb_ping_cfg_set(M2MB_PING_CFGID_E cfgID, UINT32 value)
m2mb_ping_cfg_set is called to set the ping configuration.
M2MB_PING_CB_T
INT32(* M2MB_PING_CB_T)(M2MB_PING_EVENT_E ev, VOID *data)
M2MB_PING_CB_T defines callback for ping request.
Definition: m2mb_ping.h:150
m2mb_ping_stop
INT32 m2mb_ping_stop(VOID)
m2mb_ping_stop is called to stop ping procedure.
M2MB_PING_CFGID_E
enum M2MB_PING_CFGID M2MB_PING_CFGID_E
M2MB_PING_CFGID_E defines configuration IDs for ping.
UINT16
unsigned short UINT16
Definition: m2mb_types.h:84
UINT32
unsigned long int UINT32
Definition: m2mb_types.h:85
M2MB_PING_EVENT
M2MB_PING_EVENT
M2MB_PING_EVENT_E defines events passed in the ping callback.
Definition: m2mb_ping.h:89
M2MB_PING_EVENT_E
enum M2MB_PING_EVENT M2MB_PING_EVENT_E
M2MB_PING_EVENT_E defines events passed in the ping callback.
m2mb_ping_start
INT32 m2mb_ping_start(VOID)
m2mb_ping_start is called to initiate Ping.
VOID
void VOID
Definition: m2mb_types.h:72
m2mb_ping_cfg_get
INT32 m2mb_ping_cfg_get(M2MB_PING_CFGID_E cfgID, VOID *value)
m2mb_ping_cfg_get is called to set the ping configuration.
M2MB_PING_COMPLETE_STATUS
M2MB_PING_COMPLETE_STATUS_T defines the data type of M2MB_PING_COMPLETE event.
Definition: m2mb_ping.h:125
INT32
signed int INT32
Definition: m2mb_types.h:80
M2MB_PING_REQ_STATUS
M2MB_PING_REQ_STATUS_T defines the data type of M2MB_PING_REQ_RESULT event.
Definition: m2mb_ping.h:105
m2mb_types.h
M2M base types (ver. )
M2MB_PING_COMPLETE_STATUS_T
struct M2MB_PING_COMPLETE_STATUS M2MB_PING_COMPLETE_STATUS_T
M2MB_PING_COMPLETE_STATUS_T defines the data type of M2MB_PING_COMPLETE event.
M2MB_PING_REQ_STATUS_T
struct M2MB_PING_REQ_STATUS M2MB_PING_REQ_STATUS_T
M2MB_PING_REQ_STATUS_T defines the data type of M2MB_PING_REQ_RESULT event.