blob: 119db16fee12c7e83941cc202a1bff4994ec3c89 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2018 Intel Corporation
*/
#include <stdint.h>
#ifndef _RTE_TELEMETRY_H_
#define _RTE_TELEMETRY_H_
/**
* @file
* RTE Telemetry
*
* The telemetry library provides a method to retrieve statistics from
* DPDK by sending a JSON encoded message over a socket. DPDK will send
* a JSON encoded response containing telemetry data.
***/
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* Initialize Telemetry
*
* @return
* 0 on successful initialisation.
* @return
* -ENOMEM on memory allocation error
* @return
* -EPERM on unknown error failure
* @return
* -EALREADY if Telemetry is already initialised.
*/
int32_t __rte_experimental
rte_telemetry_init(void);
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* Clean up and free memory.
*
* @return
* 0 on success
* @return
* -EPERM on failure
*/
int32_t __rte_experimental
rte_telemetry_cleanup(void);
/**
* @warning
* @b EXPERIMENTAL: this API may change without prior notice
*
* Runs various tests to ensure telemetry initialisation and register/unregister
* functions are working correctly.
*
* @return
* 0 on success when all tests have passed
* @return
* -1 on failure when the test has failed
*/
int32_t __rte_experimental
rte_telemetry_selftest(void);
#endif
|
