|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlRtrmgrTargetBase (XrlCmdMap* cmds = 0)
| XrlRtrmgrTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlRtrmgrTargetBase ()
| ~XrlRtrmgrTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer 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.
| inline const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| inline 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:
| 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:
| 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 rtrmgr_0_1_get_pid (
uint32_t& pid)
| rtrmgr_0_1_get_pid |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_register_client (
const uint32_t& userid,
const string& clientname,
string& filename,
uint32_t& pid,
uint32_t& clientid)
| rtrmgr_0_1_register_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register a user and client process with the rtrmgr.
Parameters:
| clientname | name of xrl entity supporting rtrmgr_client.xif methods. |
| XrlCmdError rtrmgr_0_1_unregister_client (
const string& token)
| rtrmgr_0_1_unregister_client |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_authenticate_client (
const uint32_t& userid,
const string& clientname,
const string& token)
| rtrmgr_0_1_authenticate_client |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_enter_config_mode (
const string& token,
const bool& exclusive)
| rtrmgr_0_1_enter_config_mode |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_leave_config_mode (
const string& token)
| rtrmgr_0_1_leave_config_mode |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_get_config_users (
const string& token,
XrlAtomList& users)
| rtrmgr_0_1_get_config_users |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_get_running_config (
const string& token,
bool& ready,
string& config)
| rtrmgr_0_1_get_running_config |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_apply_config_change (
const string& token,
const string& target,
const string& deltas,
const string& deletions)
| rtrmgr_0_1_apply_config_change |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_lock_config (
const string& token,
const uint32_t& timeout,
bool& success,
uint32_t& holder)
| rtrmgr_0_1_lock_config |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_unlock_config (
const string& token)
| rtrmgr_0_1_unlock_config |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_lock_node (
const string& token,
const string& node,
const uint32_t& timeout,
bool& success,
uint32_t& holder)
| rtrmgr_0_1_lock_node |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_unlock_node (
const string& token,
const string& node)
| rtrmgr_0_1_unlock_node |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_save_config (
const string& token,
const string& target,
const string& filename)
| rtrmgr_0_1_save_config |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_load_config (
const string& token,
const string& target,
const string& filename)
| rtrmgr_0_1_load_config |
[protected pure virtual]
| XrlCmdError rtrmgr_0_1_set_config_directory (
const string& config_directory)
| rtrmgr_0_1_set_config_directory |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the name of the directory with the configuration files.
Parameters:
| config_directory | the name of the directory with the configuration files. |
| XrlCmdError finder_event_observer_0_1_xrl_target_birth (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_birth |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target birth to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError finder_event_observer_0_1_xrl_target_death (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_death |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target death to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
