Home --> Documentations --> PJLIB-UTIL Reference

Data Structures
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

typedef void(* pj_cli_telnet_on_started)(pj_status_t status)

This specifies the callback called when telnet is started

Parameters
statusThe status of telnet startup process.

Function Documentation

void pj_cli_telnet_cfg_default ( pj_cli_telnet_cfg param)

Initialize pj_cli_telnet_cfg with its default values.

Parameters
paramThe structure to be initialized.
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
cliThe CLI application instance.
paramOptional parameters for creating the telnet daemon. If this value is NULL, default parameters will be used.
p_feOptional 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_status_t pj_cli_telnet_get_info ( pj_cli_front_end fe,
pj_cli_telnet_info info 
)

Retrieve cli telnet info.

Parameters
telnet_infoThe telnet runtime information.
Returns
PJ_SUCCESS on success.

 


PJLIB-UTIL Open Source, small footprint, and portable asynchronous/caching DNS resolver, text scanner, STUN client, and XML library
Copyright (C) 2006-2009 Teluu Inc.