class XrlCliTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlCliTargetBase (XrlCmdMap* cmds = 0)

XrlCliTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlCliTargetBase ()

~XrlCliTargetBase

[virtual]

Destructor.

Dissociates instance commands from command map.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

Set command map.

Parameters:

cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.

Returns: true on success, false if cmds is null or a command map has already been supplied.

const string&  name ()

name

[const]

Get Xrl instance name associated with command map.

const char*  version ()

version

[const]

Get version string of instance.

XrlCmdError  common_0_1_get_target_name ( string& name)

common_0_1_get_target_name

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

XrlCmdError  common_0_1_get_version ( string& version)

common_0_1_get_version

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

XrlCmdError  common_0_1_get_status ( uint32_t& status, string& reason)

common_0_1_get_status

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

XrlCmdError  common_0_1_shutdown ()

common_0_1_shutdown

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

XrlCmdError  cli_manager_0_1_enable_cli ( const bool& enable)

cli_manager_0_1_enable_cli

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the CLI.

Parameters:

enableif true, then enable the CLI, otherwise disable it.
XrlCmdError  cli_manager_0_1_start_cli ()

cli_manager_0_1_start_cli

[protected pure virtual]

XrlCmdError  cli_manager_0_1_stop_cli ()

cli_manager_0_1_stop_cli

[protected pure 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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure 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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure 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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure 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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure 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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure virtual]

Pure-virtual function that needs to be implemented to:

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.

Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:10:51 2009, using kdoc 2.0a54+XORP.