xorp

XrlRtrmgrTargetBase Class Reference

Inheritance diagram for XrlRtrmgrTargetBase:
XrlRtrmgrInterface

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlRtrmgrTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlRtrmgrTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlRtrmgrTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlRtrmgrTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rtrmgr_0_1_get_pid (uint32_t &pid)=0
virtual XrlCmdError rtrmgr_0_1_register_client (const uint32_t &userid, const string &clientname, string &filename, uint32_t &pid, uint32_t &clientid)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rtrmgr_0_1_unregister_client (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_authenticate_client (const uint32_t &userid, const string &clientname, const string &token)=0
virtual XrlCmdError rtrmgr_0_1_enter_config_mode (const string &token, const bool &exclusive)=0
virtual XrlCmdError rtrmgr_0_1_leave_config_mode (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_get_config_users (const string &token, XrlAtomList &users)=0
virtual XrlCmdError rtrmgr_0_1_get_running_config (const string &token, bool &ready, string &config)=0
virtual XrlCmdError rtrmgr_0_1_apply_config_change (const string &token, const string &target, const string &deltas, const string &deletions)=0
virtual XrlCmdError rtrmgr_0_1_lock_config (const string &token, const uint32_t &timeout, bool &success, uint32_t &holder)=0
virtual XrlCmdError rtrmgr_0_1_unlock_config (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_lock_node (const string &token, const string &node, const uint32_t &timeout, bool &success, uint32_t &holder)=0
virtual XrlCmdError rtrmgr_0_1_unlock_node (const string &token, const string &node)=0
virtual XrlCmdError rtrmgr_0_1_save_config (const string &token, const string &target, const string &filename)=0
virtual XrlCmdError rtrmgr_0_1_load_config (const string &token, const string &target, const string &filename)=0
virtual XrlCmdError rtrmgr_0_1_set_config_directory (const string &config_directory)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rtrmgr_0_1_get_pid (uint32_t &pid)=0
virtual XrlCmdError rtrmgr_0_1_register_client (const uint32_t &userid, const string &clientname, string &filename, uint32_t &pid, uint32_t &clientid)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rtrmgr_0_1_unregister_client (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_authenticate_client (const uint32_t &userid, const string &clientname, const string &token)=0
virtual XrlCmdError rtrmgr_0_1_enter_config_mode (const string &token, const bool &exclusive)=0
virtual XrlCmdError rtrmgr_0_1_leave_config_mode (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_get_config_users (const string &token, XrlAtomList &users)=0
virtual XrlCmdError rtrmgr_0_1_get_running_config (const string &token, bool &ready, string &config)=0
virtual XrlCmdError rtrmgr_0_1_apply_config_change (const string &token, const string &target, const string &deltas, const string &deletions)=0
virtual XrlCmdError rtrmgr_0_1_lock_config (const string &token, const uint32_t &timeout, bool &success, uint32_t &holder)=0
virtual XrlCmdError rtrmgr_0_1_unlock_config (const string &token)=0
virtual XrlCmdError rtrmgr_0_1_lock_node (const string &token, const string &node, const uint32_t &timeout, bool &success, uint32_t &holder)=0
virtual XrlCmdError rtrmgr_0_1_unlock_node (const string &token, const string &node)=0
virtual XrlCmdError rtrmgr_0_1_save_config (const string &token, const string &target, const string &filename)=0
virtual XrlCmdError rtrmgr_0_1_load_config (const string &token, const string &target, const string &filename)=0
virtual XrlCmdError rtrmgr_0_1_set_config_directory (const string &config_directory)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_pid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_register_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unregister_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_authenticate_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_enter_config_mode (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_leave_config_mode (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_config_users (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_running_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_apply_config_change (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_lock_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unlock_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_lock_node (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unlock_node (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_save_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_load_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_set_config_directory (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_pid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_register_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unregister_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_authenticate_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_enter_config_mode (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_leave_config_mode (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_config_users (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_get_running_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_apply_config_change (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_lock_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unlock_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_lock_node (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_unlock_node (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_save_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_load_config (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rtrmgr_0_1_set_config_directory (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlRtrmgrTargetBase::handlers) / sizeof(XrlRtrmgrTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlRtrmgrTargetBase::XrlRtrmgrTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan 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.

XrlRtrmgrTargetBase::XrlRtrmgrTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
virtual XrlRtrmgrTargetBase::~XrlRtrmgrTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::rtrmgr_0_1_register_client ( const uint32_t &  userid,
const string &  clientname,
string &  filename,
uint32_t &  pid,
uint32_t &  clientid 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register a user and client process with the rtrmgr.

Parameters:
clientnamename of xrl entity supporting rtrmgr_client.xif methods.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::rtrmgr_0_1_register_client ( const uint32_t &  userid,
const string &  clientname,
string &  filename,
uint32_t &  pid,
uint32_t &  clientid 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register a user and client process with the rtrmgr.

Parameters:
clientnamename of xrl entity supporting rtrmgr_client.xif methods.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::rtrmgr_0_1_set_config_directory ( const string &  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_directorythe name of the directory with the configuration files.

Implemented in XrlRtrmgrInterface.

virtual XrlCmdError XrlRtrmgrTargetBase::rtrmgr_0_1_set_config_directory ( const string &  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_directorythe name of the directory with the configuration files.

Implemented in XrlRtrmgrInterface.

bool XrlRtrmgrTargetBase::set_command_map ( XrlCmdMap cmds)

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.
bool XrlRtrmgrTargetBase::set_command_map ( XrlCmdMap cmds)

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.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations