EM-ODP
3.7.0
Event Machine on ODP
em_cli.h
Go to the documentation of this file.
1
/* Copyright (c) 2021, Nokia
2
* All rights reserved.
3
*
4
* SPDX-License-Identifier: BSD-3-Clause
5
*/
6
7
#ifndef EM_CLI_H_
8
#define EM_CLI_H_
9
10
#pragma GCC visibility push(default)
11
12
/**
13
* @file
14
* @defgroup EM CLI (Command Line Interface) related
15
* EM CLI specific helper APIs.
16
* @{
17
*
18
* These helper APIs can be used to start/stop an EM CLI socket server providing
19
* a list of CLI commands, which can be used to get info about EM (e.g. pools,
20
* queues, core map and CPU arch) and info about the underlying ODP instance.
21
* The EM CLI server may be connected to with a telnet client.
22
*
23
* Note that these EM CLI helper APIs must be called after em_init().
24
*
25
* Note that the dependent libcli must be installed to be able to use EM CLI.
26
* libcli can be installed with "sudo apt-get install libcli-dev"
27
*
28
*/
29
30
#ifdef __cplusplus
31
extern
"C"
{
32
#endif
33
34
/**
35
* @brief Initialize the EM CLI (if enabled)
36
*
37
* @return EM_OK if successful.
38
*/
39
em_status_t
emcli_init
(
void
);
40
41
/**
42
* @brief Initialize the EM CLI locally on an EM core (if enabled)
43
*
44
* @return EM_OK if successful
45
*/
46
em_status_t
emcli_init_local
(
void
);
47
48
/**
49
* @brief Terminate the EM CLI (if enabled)
50
*
51
* @return EM_OK if successful.
52
*/
53
em_status_t
emcli_term
(
void
);
54
55
/**
56
* @brief Terminate the EM CLI locally on an EM core (if enabled)
57
*
58
* @return EM_OK if successful
59
*/
60
em_status_t
emcli_term_local
(
void
);
61
62
#ifdef __cplusplus
63
}
64
#endif
65
66
#pragma GCC visibility pop
67
#endif
/* EM_CLI_H_ */
emcli_init
em_status_t emcli_init(void)
Initialize the EM CLI (if enabled)
Definition:
em_cli.c:1446
emcli_init_local
em_status_t emcli_init_local(void)
Initialize the EM CLI locally on an EM core (if enabled)
Definition:
em_cli.c:1451
emcli_term
em_status_t emcli_term(void)
Terminate the EM CLI (if enabled)
Definition:
em_cli.c:1456
emcli_term_local
em_status_t emcli_term_local(void)
Terminate the EM CLI locally on an EM core (if enabled)
Definition:
em_cli.c:1461
em_status_t
uint32_t em_status_t
Definition:
event_machine_types.h:321