cli_telnet.h File Reference

Command Line Interface Telnet Front End API. More...

Go to the source code of this file.

Data Structures
struct	pj_cli_telnet_info
struct	pj_cli_telnet_cfg
typedef void(*	pj_cli_telnet_on_started) (pj_status_t status)
void	pj_cli_telnet_cfg_default (pj_cli_telnet_cfg *param)
pj_status_t	pj_cli_telnet_create (pj_cli_t *cli, pj_cli_telnet_cfg *param, pj_cli_front_end **p_fe)
pj_status_t	pj_cli_telnet_get_info (pj_cli_front_end *fe, pj_cli_telnet_info *info)

Detailed Description

Command Line Interface Telnet Front End API.

Typedef Documentation

pj_cli_telnet_on_started

typedef void(* pj_cli_telnet_on_started) (pj_status_t status)

This specifies the callback called when telnet is started

Parameters

status

The status of telnet startup process.

Function Documentation

pj_cli_telnet_cfg_default()

void pj_cli_telnet_cfg_default

(

pj_cli_telnet_cfg *

param

)

Initialize pj_cli_telnet_cfg with its default values.

Parameters

param

The structure to be initialized.

pj_cli_telnet_create()

pj_status_t pj_cli_telnet_create	(	pj_cli_t *	cli,
		pj_cli_telnet_cfg *	param,
		pj_cli_front_end **	p_fe
	)

Create, initialize, and start a telnet daemon for the application.

Parameters

cli	The CLI application instance.
param	Optional parameters for creating the telnet daemon. If this value is NULL, default parameters will be used.
p_fe	Optional pointer to receive the front-end instance of the telnet front-end just created.

Returns

PJ_SUCCESS on success, or the appropriate error code.

pj_cli_telnet_get_info()

pj_status_t pj_cli_telnet_get_info	(	pj_cli_front_end *	fe,
		pj_cli_telnet_info *	info
	)

Retrieve cli telnet info.

Parameters

fe	The front end.
info	The telnet runtime information.

Returns

PJ_SUCCESS on success.

References PJ_END_DECL.