class XrlCliNode


Definition#include <xrl_cli_node.hh>
InheritsXrlCliProcessorV0p1Client (unknown) [public ], XrlCliTargetBase (unknown) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

 XrlCliNode (XrlRouter* xrl_router, CliNode& cli_node)

XrlCliNode

 ~XrlCliNode ()

~XrlCliNode

[virtual]

int  enable_cli ()

enable_cli

int  disable_cli ()

disable_cli

int  start_cli ()

start_cli

int  stop_cli ()

stop_cli

XrlCmdError  common_0_1_get_target_name ( string& name)

common_0_1_get_target_name

[protected virtual]

Get name of Xrl Target

XrlCmdError  common_0_1_get_version ( string& version)

common_0_1_get_version

[protected virtual]

Get version string from Xrl Target

XrlCmdError  common_0_1_get_status ( uint32_t& status, string& reason)

common_0_1_get_status

[protected virtual]

Get status from Xrl Target

XrlCmdError  common_0_1_shutdown ()

common_0_1_shutdown

[protected virtual]

shutdown cleanly

XrlCmdError  cli_manager_0_1_enable_cli ()

cli_manager_0_1_enable_cli

[protected virtual]

Enable/disable/start/stop the CLI.

XrlCmdError  cli_manager_0_1_disable_cli ()

cli_manager_0_1_disable_cli

[protected virtual]

XrlCmdError  cli_manager_0_1_start_cli ()

cli_manager_0_1_start_cli

[protected virtual]

XrlCmdError  cli_manager_0_1_stop_cli ()

cli_manager_0_1_stop_cli

[protected virtual]

XrlCmdError  cli_manager_0_1_add_enable_cli_access_from_subnet4 ( const IPv4Net& subnet_addr)

cli_manager_0_1_add_enable_cli_access_from_subnet4

[protected virtual]

Add a subnet address to the list of subnet addresses enabled for CLI access. This method can be called more than once to add a number of subnet addresses.

Parameters:
subnet_addrthe subnet address to add.

XrlCmdError  cli_manager_0_1_add_enable_cli_access_from_subnet6 ( const IPv6Net& subnet_addr)

cli_manager_0_1_add_enable_cli_access_from_subnet6

[protected virtual]

XrlCmdError  cli_manager_0_1_delete_enable_cli_access_from_subnet4 ( const IPv4Net& subnet_addr)

cli_manager_0_1_delete_enable_cli_access_from_subnet4

[protected virtual]

Delete a subnet address from the list of subnet addresses enabled for CLI access.

Parameters:
subnet_addrthe subnet address to delete.

XrlCmdError  cli_manager_0_1_delete_enable_cli_access_from_subnet6 ( const IPv6Net& subnet_addr)

cli_manager_0_1_delete_enable_cli_access_from_subnet6

[protected virtual]

XrlCmdError  cli_manager_0_1_add_disable_cli_access_from_subnet4 ( const IPv4Net& subnet_addr)

cli_manager_0_1_add_disable_cli_access_from_subnet4

[protected virtual]

Add a subnet address to the list of subnet addresses disabled for CLI access. This method can be called more than once to add a number of subnet addresses.

Parameters:
subnet_addrthe subnet address to add.

XrlCmdError  cli_manager_0_1_add_disable_cli_access_from_subnet6 ( const IPv6Net& subnet_addr)

cli_manager_0_1_add_disable_cli_access_from_subnet6

[protected virtual]

XrlCmdError  cli_manager_0_1_delete_disable_cli_access_from_subnet4 ( const IPv4Net& subnet_addr)

cli_manager_0_1_delete_disable_cli_access_from_subnet4

[protected virtual]

Delete a subnet address from the list of subnet addresses disabled for CLI access.

Parameters:
subnet_addrthe subnet address to delete.

XrlCmdError  cli_manager_0_1_delete_disable_cli_access_from_subnet6 ( const IPv6Net& subnet_addr)

cli_manager_0_1_delete_disable_cli_access_from_subnet6

[protected virtual]

XrlCmdError  cli_manager_0_1_add_cli_command ( const string& processor_name, const string& command_name, const string& command_help, const bool& is_command_cd, const string& command_cd_prompt, const bool& is_command_processor)

cli_manager_0_1_add_cli_command

[protected virtual]

Add a CLI command to the CLI manager

Parameters:
processor_namethe name of the module that will process that command.
command_namethe name of the command to add.
command_helpthe help for the command to add.
is_command_cdis true, the string that will replace the CLI prompt after we "cd" to that level of the CLI command-tree.
command_cd_promptif
is_command_processorif true, this is a processing command that would be performed by processor_name.

XrlCmdError  cli_manager_0_1_delete_cli_command ( const string& processor_name, const string& command_name)

cli_manager_0_1_delete_cli_command

[protected virtual]

Delete a CLI command from the CLI manager

Parameters:
processor_namethe name of the module that sends the request.
command_namethe name of the command to delete.

void  send_process_command (const char *target, const string& processor_name, const string& cli_term_name, uint32_t cli_session_id, const string& command_name, const string& command_args)

send_process_command

[protected]

void  recv_process_command_output (const XrlError& xrl_error, const string *processor_name, const string *cli_term_name, const uint32_t *cli_session_id, const string *command_output)

recv_process_command_output

[protected]


Generated by: pavlin on possum.icir.org on Mon Jun 9 13:23:52 2003, using kdoc 2.0a54+XORP.