M2MB PING

This section describes the M2MB APIs for Ping feature. More...

#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
enum	M2MB_PING_CFGID {   M2MB_PING_CFGID_ADDRESS,   M2MB_PING_CFGID_DATA_SIZE,   M2MB_PING_CFGID_COUNT,   M2MB_PING_CFGID_STAT,   M2MB_PING_CFGID_CB }
	M2MB_PING_CFGID_E defines configuration IDs for ping. More...
enum	M2MB_PING_EVENT {   M2MB_PING_REQ_RESULT,   M2MB_PING_COMPLETE }
	M2MB_PING_EVENT_E defines events passed in the ping callback. More...
typedef enum M2MB_PING_CFGID	M2MB_PING_CFGID_E
	M2MB_PING_CFGID_E defines configuration IDs for ping. More...
typedef enum M2MB_PING_EVENT	M2MB_PING_EVENT_E
	M2MB_PING_EVENT_E defines events passed in the ping callback. More...
typedef 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. More...
typedef struct M2MB_PING_COMPLETE_STATUS	M2MB_PING_COMPLETE_STATUS_T
	M2MB_PING_COMPLETE_STATUS_T defines the data type of M2MB_PING_COMPLETE event. More...
typedef INT32(*	M2MB_PING_CB_T) (M2MB_PING_EVENT_E ev, VOID *data)
	M2MB_PING_CB_T defines callback for ping request. More...
INT32	m2mb_ping_start (VOID)
	m2mb_ping_start is called to initiate Ping. More...
INT32	m2mb_ping_stop (VOID)
	m2mb_ping_stop is called to stop ping procedure. More...
INT32	m2mb_ping_cfg_set (M2MB_PING_CFGID_E cfgID, UINT32 value)
	m2mb_ping_cfg_set is called to set the ping configuration. More...
INT32	m2mb_ping_cfg_get (M2MB_PING_CFGID_E cfgID, VOID *value)
	m2mb_ping_cfg_get is called to set the ping configuration. More...

Detailed Description

This section describes the M2MB APIs for Ping feature.

PING is used ping any network device through IP address.

Macro Definition Documentation

M2MB_NETWORK_PING_INVALID_IP_ADDRESS

#define M2MB_NETWORK_PING_INVALID_IP_ADDRESS   M2MB_NET_ERR_INVALID_IPADDR

Macro for invalid IP address

Definition at line 55 of file m2mb_ping.h.

M2MB_NETWORK_PING_REQUEST_TIMED_OUT

#define M2MB_NETWORK_PING_REQUEST_TIMED_OUT   2

Macro for ping request timed out

Definition at line 56 of file m2mb_ping.h.

M2MB_NETWORK_PING_SUCCESS

#define M2MB_NETWORK_PING_SUCCESS   0

MACROs for PING_STATUS Macro for ping success

Definition at line 54 of file m2mb_ping.h.

M2MB_PING_PACKET_SIZE_MAX_RX

#define M2MB_PING_PACKET_SIZE_MAX_RX   (1556)

Macro for maximum number of bytes to receive

Definition at line 51 of file m2mb_ping.h.

M2MB_PING_PACKET_SIZE_MAX_TX

#define M2MB_PING_PACKET_SIZE_MAX_TX   (1576)

Macro for maximum number of bytes to transmit

Definition at line 50 of file m2mb_ping.h.

Typedef Documentation

M2MB_PING_CB_T

typedef INT32( * M2MB_PING_CB_T) (M2MB_PING_EVENT_E ev, VOID *data)

M2MB_PING_CB_T defines callback for ping request.

This callback is called to indicate the event to the application. The data pointer has to be interpreted based on the event and has to be either M2MB_PING_REQ_STATUS_T or M2MB_PING_COMPLETE_STATUS_T.here data is of type either M2MB_PING_REQ_STATUS_T or M2MB_PING_COMPLETE_STATUS_T, depends on event type.

Parameters

[in]	ev	Indicate the event of type M2MB_PING_EVENT_E to the application.
[in]	data	The data pointer has to be interpreted based on the event. If event is M2MB_PING_REQ_RESULT data is M2MB_PING_REQ_STATUS_T else NULL.

Definition at line 150 of file m2mb_ping.h.

M2MB_PING_CFGID_E

typedef enum M2MB_PING_CFGID M2MB_PING_CFGID_E

M2MB_PING_CFGID_E defines configuration IDs for ping.

This enum is used to get/set ping configuration using m2mb_ping_cfg_get/m2mb_ping_cfg_set APIs.

M2MB_PING_COMPLETE_STATUS_T

typedef 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_COMPLETE_STATUS_T defines the data type of the data filed in the ping request callback for M2MB_PING_COMPLETE event.

M2MB_PING_EVENT_E

typedef enum M2MB_PING_EVENT M2MB_PING_EVENT_E

M2MB_PING_EVENT_E defines events passed in the ping callback.

This enum is used while passing the event in the ping callback.

M2MB_PING_REQ_STATUS_T

typedef 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.

M2MB_PING_REQ_STATUS_T defines the data type of the data filed in the ping request callback for M2MB_PING_REQ_RESULT event.

Enumeration Type Documentation

M2MB_PING_CFGID

enum M2MB_PING_CFGID

M2MB_PING_CFGID_E defines configuration IDs for ping.

This enum is used to get/set ping configuration using m2mb_ping_cfg_get/m2mb_ping_cfg_set APIs.

Enumerator
M2MB_PING_CFGID_ADDRESS	ping address ping data size
M2MB_PING_CFGID_DATA_SIZE	ping count
M2MB_PING_CFGID_COUNT	ping start
M2MB_PING_CFGID_STAT	ping user call back
M2MB_PING_CFGID_CB

Definition at line 68 of file m2mb_ping.h.

M2MB_PING_EVENT

enum M2MB_PING_EVENT

M2MB_PING_EVENT_E defines events passed in the ping callback.

This enum is used while passing the event in the ping callback.

Enumerator
M2MB_PING_REQ_RESULT	ping request result, call back returns M2MB_PING_REQ_STATUS_T type data last ping result, call back returns M2MB_PING_COMPLETE_STATUS_T type data
M2MB_PING_COMPLETE

Definition at line 89 of file m2mb_ping.h.

Function Documentation

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_cfg_get stores the configuration set by user. This configuration is used when ping start API is called.

Parameters

[in]	cfgID	Configuration ID, from M2MB_PING_CFG_T.
[out]	value	Configured value.

Returns

Returns M2MB_OK on success, M2MB_ERROR on error.

Note

Example

void m2m_s2w_nw_ping_cb( M2MB_PING_EVENT_E ev, VOID* data )
    {         
      if( ev == M2MB_PING_REQ_RESULT )
      {               
              M2MB_PING_REQ_STATUS_T *pPingrslt = (M2MB_PING_REQ_STATUS_T *)data;
              
              if (m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET, pPingrslt->pDst, &rsp.dst->Addr4 ) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET;
              }                       
              else if(m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET6, pPingrslt->pDst, &rsp.dst->Addr6) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET6;
              }               
                              
      
              if (pPingrslt->status == M2M_NETWORK_PING_SUCCESS)
              {                                       
                      //ping is success
              }
              else if (pPingrslt->status == M2MB_NET_ERR_INVALID_IPADDR)
              {
                      //ping ip is invalid
              }
              else
              {
                      //ping request is timedout
              }                       
      }       
      else if( ev == M2MB_PING_COMPLETE )
      {
              //ping completed
      }       
    }
void main(void)
    {
      char addrstr[40];
      M2MB_IP46_ADDR_T * IPaddr;
        UINT32  payload;
        UINT32  count;

      if(NULL == m2mb_socket_bsd_inet_ntop(IPaddr->type, &IPaddr->a, addrstr, 40))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_ADDRESS, (UINT32)addrstr ))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_DATA_SIZE, payload))     
              return M2MB_ERROR;
      
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_COUNT, count ))                
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_CB, (UINT32)m2m_s2w_nw_ping_cb )) 
              return M2MB_ERROR;

      memcpy(&pingstats.ip, IPaddr, sizeof(M2MB_IP46_ADDR_T) );
      if(M2MB_OK != m2mb_ping_start())
              {
              return M2MB_ERROR;
              }
              
    UINT32 val;
    if(M2MB_OK != m2mb_ping_cfg_get( M2MB_PING_CFGID_ADDRESS, &val )) 
      return M2MB_ERROR;
    else
        // print val
    }

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_cfg_set stores the configuration set by user. This configuration is used when ping start API is called.

Parameters

[in]	cfgID	Configuration ID, from M2MB_PING_CFG_T.
[in]	value	Configuration value.

Returns

Returns M2MB_OK on success, M2MB_ERROR value on error.

Note

Example

void m2m_s2w_nw_ping_cb( M2MB_PING_EVENT_E ev, VOID* data )
    {         
      if( ev == M2MB_PING_REQ_RESULT )
      {               
              M2MB_PING_REQ_STATUS_T *pPingrslt = (M2MB_PING_REQ_STATUS_T *)data;
              
              if (m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET, pPingrslt->pDst, &rsp.dst->Addr4 ) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET;
              }                       
              else if(m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET6, pPingrslt->pDst, &rsp.dst->Addr6) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET6;
              }               
                              
      
              if (pPingrslt->status == M2M_NETWORK_PING_SUCCESS)
              {                                       
                      //ping is success
              }
              else if (pPingrslt->status == M2MB_NET_ERR_INVALID_IPADDR)
              {
                      //ping ip is invalid
              }
              else
              {
                      //ping request is timedout
              }                       
      }       
      else if( ev == M2MB_PING_COMPLETE )
      {
              //ping completed
      }       
    }
void main(void)
    {
      char addrstr[40];
      M2MB_IP46_ADDR_T * IPaddr;
        UINT32  payload;
        UINT32  count;

      if(NULL == m2mb_socket_bsd_inet_ntop(IPaddr->type, &IPaddr->a, addrstr, 40))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_ADDRESS, (UINT32)addrstr ))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_DATA_SIZE, payload))     
              return M2MB_ERROR;
      
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_COUNT, count ))                
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_CB, (UINT32)m2m_s2w_nw_ping_cb )) 
              return M2MB_ERROR;

      memcpy(&pingstats.ip, IPaddr, sizeof(M2MB_IP46_ADDR_T) );
      if(M2MB_OK != m2mb_ping_start())
              {
              return M2MB_ERROR;
              }
    }

m2mb_ping_start()

INT32 m2mb_ping_start

(

VOID

)

m2mb_ping_start is called to initiate Ping.

m2mb_ping_start initiates Ping procedure.

Returns

returns status.

Note

This API has to be called after ping configuration. Example

    void m2m_s2w_nw_ping_cb( M2MB_PING_EVENT_E ev, VOID* data )
    {         
      if( ev == M2MB_PING_REQ_RESULT )
      {               
              M2MB_PING_REQ_STATUS_T *pPingrslt = (M2MB_PING_REQ_STATUS_T *)data;
              
              if (m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET, pPingrslt->pDst, &rsp.dst->Addr4 ) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET;
              }                       
              else if(m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET6, pPingrslt->pDst, &rsp.dst->Addr6) == 1)
              {                               
                      dst.type = M2MB_SOCKET_BSD_AF_INET6;
              }               
                              
      
              if (pPingrslt->status == M2M_NETWORK_PING_SUCCESS)
              {                                       
                      //ping is success
              }
              else if (pPingrslt->status == M2MB_NET_ERR_INVALID_IPADDR)
              {
                      //ping ip is invalid
              }
              else
              {
                      //ping request is timedout
              }                       
      }       
      else if( ev == M2MB_PING_COMPLETE )
      {
              //ping completed
      }       
    }
void main(void)
    {
      char addrstr[40];
      M2MB_IP46_ADDR_T * IPaddr;
        UINT32  payload;
        UINT32  count;

      if(NULL == m2mb_socket_bsd_inet_ntop(IPaddr->type, &IPaddr->a, addrstr, 40))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_ADDRESS, (UINT32)addrstr ))
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_DATA_SIZE, payload))     
              return M2MB_ERROR;
      
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_COUNT, count ))                
              return M2MB_ERROR;
      if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_CB, (UINT32)m2m_s2w_nw_ping_cb )) 
              return M2MB_ERROR;

      memcpy(&pingstats.ip, IPaddr, sizeof(M2MB_IP46_ADDR_T) );
      if(M2MB_OK != m2mb_ping_start())
              {
              return M2MB_ERROR;
              }
    }

m2mb_ping_stop()

INT32 m2mb_ping_stop

(

VOID

)

m2mb_ping_stop is called to stop ping procedure.

m2mb_ping_stop stops the ping procedure. It is called when ping is started in continuous mode in background.

Returns

returns status.

Note

This API has to be called when ping is started in continuous mode in background. Example

    void m2m_s2w_nw_ping_cb( M2MB_PING_EVENT_E ev, VOID* data )
        {               
                if( ev == M2MB_PING_REQ_RESULT )
                {               
                        M2MB_PING_REQ_STATUS_T *pPingrslt = (M2MB_PING_REQ_STATUS_T *)data;
                        
                        if (m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET, pPingrslt->pDst, &rsp.dst->Addr4 ) == 1)
                        {                               
                                dst.type = M2MB_SOCKET_BSD_AF_INET;
                        }                       
                        else if(m2mb_socket_bsd_inet_pton(M2MB_SOCKET_BSD_AF_INET6, pPingrslt->pDst, &rsp.dst->Addr6) == 1)
                        {                               
                                dst.type = M2MB_SOCKET_BSD_AF_INET6;
                        }               
                                        
                
                        if (pPingrslt->status == M2M_NETWORK_PING_SUCCESS)
                        {                                       
                                //ping is success
                        }
                        else if (pPingrslt->status == M2MB_NET_ERR_INVALID_IPADDR)
                        {
                                //ping ip is invalid
                        }
                        else
                        {
                                //ping request is timedout
                        }                       
                }       
                else if( ev == M2MB_PING_COMPLETE )
                {
                        //ping completed
                }       
}
    void main(void)
        {
                char addrstr[40];
                M2MB_IP46_ADDR_T * IPaddr;
            UINT32  payload;
            UINT32  count;

                if(NULL == m2mb_socket_bsd_inet_ntop(IPaddr->type, &IPaddr->a, addrstr, 40))
                        return M2MB_ERROR;
                if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_ADDRESS, (UINT32)addrstr ))
                        return M2MB_ERROR;
                if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_DATA_SIZE, payload))     
                        return M2MB_ERROR;
                
                if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_COUNT, count ))                
                        return M2MB_ERROR;
                if(M2MB_OK != m2mb_ping_cfg_set( M2MB_PING_CFGID_CB, (UINT32)m2m_s2w_nw_ping_cb )) 
                        return M2MB_ERROR;

                memcpy(&pingstats.ip, IPaddr, sizeof(M2MB_IP46_ADDR_T) );
                if(M2MB_OK != m2mb_ping_start())
                {
                        return M2MB_ERROR;
                }
                if(M2MB_OK != m2mb_ping_stop())
                {
                        return M2MB_ERROR;
                }
        }