BLOG | DOCUMENTATION | GITHUB

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

cli.h File Reference

Command Line Interface. More...

Go to the source code of this file.

Data Structures

struct  pj_cli_cfg
 
struct  pj_cli_cmd_val
 
struct  pj_cli_hint_info
 
struct  pj_cli_exec_info
 
struct  pj_cli_arg_choice_val
 
struct  pj_cli_dyn_choice_param
 

Typedefs

typedef struct pj_cli_t pj_cli_t
 
typedef int pj_cli_cmd_id
 
typedef int pj_cli_arg_id
 
typedef struct pj_cli_cmd_spec pj_cli_cmd_spec
 
typedef struct pj_cli_arg_spec pj_cli_arg_spec
 
typedef void(* pj_cli_get_dyn_choice) (pj_cli_dyn_choice_param *param)
 
typedef pj_status_t(* pj_cli_cmd_handler) (pj_cli_cmd_val *cval)
 

Functions

void pj_cli_write_log (pj_cli_t *cli, int level, const char *buffer, int len)
 
pj_status_t pj_cli_create (pj_cli_cfg *cfg, pj_cli_t **p_cli)
 
pj_cli_cmd_id pj_cli_get_cmd_id (const pj_cli_cmd_spec *cmd)
 
pj_cli_cfgpj_cli_get_param (pj_cli_t *cli)
 
void pj_cli_quit (pj_cli_t *cli, pj_cli_sess *req, pj_bool_t restart)
 
pj_bool_t pj_cli_is_quitting (pj_cli_t *cli)
 
pj_bool_t pj_cli_is_restarting (pj_cli_t *cli)
 
void pj_cli_destroy (pj_cli_t *cli)
 
void pj_cli_cfg_default (pj_cli_cfg *param)
 
void pj_cli_register_front_end (pj_cli_t *cli, pj_cli_front_end *fe)
 
pj_status_t pj_cli_add_cmd_from_xml (pj_cli_t *cli, pj_cli_cmd_spec *group, const pj_str_t *xml, pj_cli_cmd_handler handler, pj_cli_cmd_spec **p_cmd, pj_cli_get_dyn_choice get_choice)
 
void pj_cli_exec_info_default (pj_cli_exec_info *param)
 
void pj_cli_sess_write_msg (pj_cli_sess *sess, const char *buffer, pj_size_t len)
 
pj_status_t pj_cli_sess_parse (pj_cli_sess *sess, char *cmdline, pj_cli_cmd_val *val, pj_pool_t *pool, pj_cli_exec_info *info)
 
void pj_cli_sess_end_session (pj_cli_sess *sess)
 
pj_status_t pj_cli_sess_exec (pj_cli_sess *sess, char *cmdline, pj_pool_t *pool, pj_cli_exec_info *info)
 

Detailed Description

Command Line Interface.

 


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.