Group PJLIB_UTIL_CLI_IMP

group PJLIB_UTIL_CLI_IMP

Defines

PJ_CLI_CONSOLE_LOG_LEVEL

Default log level for console sessions.

PJ_CLI_TELNET_LOG_LEVEL

Default log level for telnet sessions.

PJ_CLI_TELNET_PORT

Default port number for telnet daemon.

Enums

enum pj_cli_front_end_type

This enumeration specifies front end types.

Values:

enumerator PJ_CLI_CONSOLE_FRONT_END

Console front end.

enumerator PJ_CLI_TELNET_FRONT_END

Telnet front end.

enumerator PJ_CLI_HTTP_FRONT_END

HTTP front end.

enumerator PJ_CLI_GUI_FRONT_END

GUI front end.

struct pj_cli_console_cfg
#include <cli_console.h>

This structure contains various options for CLI console front-end. Application must call pj_cli_console_cfg_default() to initialize this structure with its default values.

struct pj_cli_front_end_op
#include <cli_imp.h>

Front end operations. Only the CLI should call these functions directly.

struct pj_cli_front_end
#include <cli_imp.h>

This structure describes common properties of CLI front-ends. A front- end is a mean to interact with end user, for example the CLI application may interact with console, telnet, web, or even a GUI.

Each end user’s interaction will create an instance of pj_cli_sess.

Application instantiates the front end by calling the appropriate function to instantiate them.

Forward declaration for CLI front-end.

struct pj_cli_sess_op
#include <cli_imp.h>

Session operations.

struct pj_cli_sess
#include <cli_imp.h>

This structure describes common properties of a CLI session. A CLI session is the interaction of an end user to the CLI application via a specific renderer, where the renderer can be console, telnet, web, or a GUI app for mobile. A session is created by its renderer, and it’s creation procedures vary among renderer (for example, a telnet session is created when the end user connects to the application, while a console session is always instantiated once the program is run).

Forward declaration for pj_cli_sess, which will be declared in cli_imp.h.

struct pj_cli_telnet_info
#include <cli_telnet.h>

This structure contains the information about the telnet. Application will get updated information each time the telnet is started/ restarted.