class CliCommand The class for the CLI command. More... Definition #include <cli_command.hh> Inherited by CliPipe List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  CliCommand (CliCommand *init_parent_command, const char *init_command_name, const char *init_command_help)
• virtual  ~CliCommand ()
• void  set_allow_cd (bool v, const char *init_cd_prompt)
• int  create_default_cli_commands ()
• int  add_pipes ()
• CliCommand * add_command (const char *init_command_name, const char *init_command_help)
• CliCommand * add_command (const char *init_command_name, const char *init_command_help, const char *init_cd_prompt)
• CliCommand * add_command (const char *init_command_name, const char *init_command_help, const CLI_PROCESS_CALLBACK &init_cli_process_callback)
• CliCommand * add_command (const char *init_command_name, const char *init_command_help, CLI_PROCESS_FUNC init_cli_process_func)
• int  add_command (CliCommand *child_command)
• int  delete_command (CliCommand *child_command)
• int  delete_command (const char *delete_command_name)
• void  delete_all_commands ()
• void  set_can_pipe (bool v)
• const char * global_name () const
• void  set_global_name (const char *v)
• const char * server_name () const
• void  set_server_name (const char *v)
• void  set_dynamic_children (DYNAMIC_CHILDREN_CALLBACK dc_cb)
• void  set_dynamic_process_callback (const CLI_PROCESS_CALLBACK& v)
• const CLI_PROCESS_CALLBACK&  dynamic_process_callback () const

Protected Methods

• void  set_cli_process_callback (const CLI_PROCESS_CALLBACK& v)

Detailed Description

Constructor for a given parent command, command name, and command help.

Parameters:

init_parent_command	the parent CliCommand command.
init_command_name	the command name (this name should not include the command name of the parent command and its ancestors).
init_command_help	the command help.

[virtual]

Destructor

Enable/disable whether this command allows "change directory" to it.

Parameters:

v	if true, enable "change directory", otherwise disable it.
init_cd_prompt	if v is true, the CLI prompt to display when "cd" to this command. If NULL, the CLI prompt will not be changed.

Create the default CLI commands at each level of the command tree.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Create and add the default CLI pipe commands.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Add a child CLI command.

By default, we cannot "cd" to this command.

Parameters:

init_command_name	the command name to add. It can include more than one command levels in the middle. E.g., "show version pim". However, commands "show" and "show version" must have been installed first.
init_command_help	the command help.

Returns: the new child command on success, otherwise NULL.

Add a child CLI command we can "cd" to it.

By default, we can "cd" to this command.

Parameters:

init_command_name	the command name to add. It can include more than one command levels in the middle. E.g., "set pim bsr". However, commands "set" and "set pim" must have been installed first.
init_command_help	the command help.
init_cd_prompt	if not NULL, the CLI prompt when "cd" to this command.

Returns: the enw child command on success, otherwise NULL.

Add a child command with a callback.

Parameters:

init_command_name	the command name to add. It can include more than one command levels in the middle. E.g., "show version pim". However, commands "show" and "show version" must have been installed first.
init_command_help	the command help.
init_cli_process_callback	the callback to call when the command is entered for execution from the command-line.

Returns: the new child command on success, otherwise NULL.

Add a child command with a processing function.

Parameters:

init_command_name	the command name to add. It can include more than one command levels in the middle. E.g., "show version pim". However, commands "show" and "show version" must have been installed first.
init_command_help	the command help.
init_cli_process_func	the processing function to call when the command is entered for execution from the command-line.

Returns: the new child command on success, otherwise NULL.

Add a child command.

Parameters:

child_command

the child command to add.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete a child command and all sub-commands below it.

Parameters:

child_command

the child command to delete.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete a child command and all sub-commands below it.

Parameters:

delete_command_name

the name of the child command to delete. The name can be the full path-name for that command.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Recursively delete all children of this command.

Set whether the output of this command can be piped.

Parameters:

v	if true, then the the output of this command can be piped.

[const]

Get the global name of this command (i.e., the full name starting from the root).

Returns: the global (full) name of this command.

Set the global name for this command.

Parameters:

v	the global name value to set.

[const]

Get the server (i.e., processor) name for this command.

Returns: if valid, the server name for this command, otherwise NULL.

Set the server (i.e., processor) name for this command.

Parameters:

v	the server name value to set.

[const]

[protected]