xf_ping.h

浏览该文件的文档.

 
#ifndef __XF_PING_H__
#define __XF_PING_H__
 
/* ==================== [Includes] ========================================== */
 
#include "lwip/ip_addr.h"
#include "lwip/icmp.h"
 
#include "xf_osal.h"
#include "xf_utils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
#define XF_PING_THREAD_NAME     "xf_ping"
 
/* ==================== [Typedefs] ========================================== */
 
struct _xf_ping_ctx_t;
 
typedef struct _xf_ping_ctx_t *xf_ping_t;
 
typedef struct _xf_ping_cfg_t {
    uint32_t count;             
    uint32_t interval_ms;       
    uint32_t timeout_ms;        
    uint32_t data_size;         
    uint8_t tos;                
    uint8_t ttl;                
    ip_addr_t target_addr;      
    uint32_t task_stack_size;   
    uint32_t task_prio;         
    uint32_t interface;         
    uint8_t auto_delete_flag;   
} xf_ping_cfg_t;
 
typedef struct _xf_ping_cfg_update_flags_t {
    uint32_t b_count            : 1;    
    uint32_t b_interval_ms      : 1;    
    uint32_t b_timeout_ms       : 1;    
    uint32_t b_tos              : 1;    
    uint32_t b_ttl              : 1;    
    uint32_t b_target_addr      : 1;    
    uint32_t b_interface        : 1;    
    uint32_t b_auto_delete_flag : 1;    
    uint32_t reserve            : 24;   
} xf_ping_cfg_update_flags_t;
 
#define XF_PING_DEFAULT_CONFIG() (xf_ping_cfg_t) { \
        .count = 5, \
        .interval_ms = 1000, \
        .timeout_ms = 1000, \
        .data_size = 64, \
        .tos = 0, \
        .ttl = IP_DEFAULT_TTL, \
        .target_addr = *(IP_ANY_TYPE), \
        .task_stack_size = (4 * 1024), \
        .task_prio = XF_OSAL_PRIORITY_NORMOL, \
        .interface = 0, \
        .auto_delete_flag = 0, \
    }
 
typedef enum _xf_ping_event_code_t {
    XF_PING_EVENT_SUCC = 0x00,          
    XF_PING_EVENT_TIMEOUT,              
    XF_PING_EVENT_END,                  
    XF_PING_EVENT_DELETE,               
    XF_PING_EVENT_MAX,                  
} xf_ping_event_code_t;
 
typedef int32_t xf_ping_event_id_t;
 
typedef void (*xf_ping_cb_t)(
    xf_ping_event_id_t event_id, xf_ping_t hdl, void *user_args);
 
typedef struct _xf_ping_ctx_t {
    /* public: */
    /* 只读数据 */
    struct icmp_echo_hdr *packet_hdr;   
    ip_addr_t recv_addr;                
    uint32_t recv_len;                  
    uint32_t elapsed_time_ms;           
    uint32_t total_time_ms;             
    uint32_t interval_ms;               
    uint32_t count;                     
    uint32_t transmitted;               
    uint32_t received;                  
    uint8_t ttl;                        
    uint8_t tos;                        
    uint8_t auto_delete_flag;           
    /* privte: */
    int sock;                           
    /*
        struct sockaddr_storage 太大，在某些芯片上(ws63)无法正常收发，不使用。
        struct sockaddr_storage target_addr;
     */
    union sockaddr_in_in6_u {
        struct sockaddr_in in;
        struct sockaddr_in6 in6;
    } target_addr;                      
    uint8_t target_addr_type;           
    uint32_t flags;                     
    uint32_t icmp_pkt_size;             
    xf_osal_thread_t task_hdl;          
    uint8_t task_exit_flag;             
    uint8_t ping_running_flag;          
    xf_ping_cb_t cb_func;               
    void *user_args;                    
} xf_ping_ctx_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_ping_new_session(
    const xf_ping_cfg_t *p_cfg, xf_ping_cb_t cb_func, void *user_args,
    xf_ping_t *hdl_out);
 
xf_err_t xf_ping_delete_session(xf_ping_t hdl);
 
xf_err_t xf_ping_start(xf_ping_t hdl);
 
xf_err_t xf_ping_restart(
    xf_ping_t hdl, const xf_ping_cfg_t *p_cfg, xf_ping_cfg_update_flags_t *p_flags);
 
bool xf_ping_is_running(xf_ping_t hdl);
 
xf_err_t xf_ping_stop(xf_ping_t hdl);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XF_PING_H__ */