EM-ODP  3.7.0
Event Machine on ODP
CLI (Command Line Interface) related

EM CLI specific helper APIs. More...

Functions

em_status_t emcli_init (void)
 Initialize the EM CLI (if enabled) More...
 
em_status_t emcli_init_local (void)
 Initialize the EM CLI locally on an EM core (if enabled) More...
 
em_status_t emcli_term (void)
 Terminate the EM CLI (if enabled) More...
 
em_status_t emcli_term_local (void)
 Terminate the EM CLI locally on an EM core (if enabled) More...
 

Detailed Description

EM CLI specific helper APIs.

These helper APIs can be used to start/stop an EM CLI socket server providing a list of CLI commands, which can be used to get info about EM (e.g. pools, queues, core map and CPU arch) and info about the underlying ODP instance. The EM CLI server may be connected to with a telnet client.

Note that these EM CLI helper APIs must be called after em_init().

Note that the dependent libcli must be installed to be able to use EM CLI. libcli can be installed with "sudo apt-get install libcli-dev"

Function Documentation

◆ emcli_init()

em_status_t emcli_init ( void  )

Initialize the EM CLI (if enabled)

Returns
EM_OK if successful.

Definition at line 1446 of file em_cli.c.

◆ emcli_init_local()

em_status_t emcli_init_local ( void  )

Initialize the EM CLI locally on an EM core (if enabled)

Returns
EM_OK if successful

Definition at line 1451 of file em_cli.c.

◆ emcli_term()

em_status_t emcli_term ( void  )

Terminate the EM CLI (if enabled)

Returns
EM_OK if successful.

Definition at line 1456 of file em_cli.c.

◆ emcli_term_local()

em_status_t emcli_term_local ( void  )

Terminate the EM CLI locally on an EM core (if enabled)

Returns
EM_OK if successful

Definition at line 1461 of file em_cli.c.