mmping.h

/*
 * Copyright 2021-2023 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MMPING_DEFAULT_PING_INTERVAL_MS                (1000)
#define MMPING_DEFAULT_PING_COUNT                      (0)
#define MMPING_DEFAULT_DATA_SIZE                       (56)
#define MMPING_MIN_DATA_SIZE                           (8)
#define MMPING_MAX_DATA_SIZE                           (1500)
#define MMPING_MAX_COUNT                               (0xffff)
#define MMPING_MAX_RETRIES                             (2)
#define MMPING_INITIAL_RETRY_INTERVAL_MS               (1000)
 
#define MMPING_IPADDR_MAXLEN                           (48)
 
#define MMPING_ICMP_ECHO_HDR_LEN                       (8)
 
struct mmping_args
{
    char ping_src[MMPING_IPADDR_MAXLEN];
    char ping_target[MMPING_IPADDR_MAXLEN];
    uint32_t ping_interval_ms;
    uint32_t ping_count;
    uint32_t ping_size;
};
 
#define MMPING_ARGS_DEFAULT                                      \
        {                                                        \
            { 0 }, { 0 }, MMPING_DEFAULT_PING_INTERVAL_MS,       \
            MMPING_DEFAULT_PING_COUNT, MMPING_DEFAULT_DATA_SIZE, \
        }
 
struct mmping_stats
{
    char ping_receiver[MMPING_IPADDR_MAXLEN];
    uint32_t ping_total_count;
    uint32_t ping_recv_count;
    uint32_t ping_min_time_ms;
    uint32_t ping_avg_time_ms;
    uint32_t ping_max_time_ms;
    bool ping_is_running;
};
 
uint16_t mmping_start(const struct mmping_args *args);
 
void mmping_stop(void);
 
void mmping_stats(struct mmping_stats *stats);
 
#ifdef __cplusplus
}
#endif