metrics.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2022 Intel Corporation
 */
 
#ifndef _METRICS_H_
#define _METRICS_H_
 
#include <stdint.h>
 
#include <cne_common.h>        // for CNDP_API
#include <cne_lport.h>
#include <uds.h>        // for uds_client_t, uds_info_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uds_info_t metrics_info_t;
typedef uds_client_t metrics_client_t;
 
/* callback returns json data in buffer, up to buf_len long.
 * returns length of buffer used on success, negative on error.
 */
typedef int (*metrics_cb)(metrics_client_t *client, const char *cmd, const char *params);
 
CNDP_API int metrics_register(const char *cmd, metrics_cb fn);
 
CNDP_API int metrics_init(void *priv_);
 
CNDP_API int metrics_destroy(void);
 
#define metrics_append(c, fmt, ...)                                      \
    do {                                                                 \
        uds_append((uds_client_t *)c, (const char *)fmt, ##__VA_ARGS__); \
    } while (0)
 
CNDP_API const char *metrics_cmd(metrics_client_t *client);
 
CNDP_API const char *metrics_params(metrics_client_t *client);
 
CNDP_API int metrics_port_stats(metrics_client_t *c, char *name, lport_stats_t *s);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _METRICS_H_ */