XrlCmdMap* _cmds | _cmds |
[protected]
XrlProfilerTargetBase (XrlCmdMap* cmds = 0)
| XrlProfilerTargetBase |
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. |
~XrlProfilerTargetBase ()
| ~XrlProfilerTargetBase |
[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 profile_client_0_1_log (
const string& pname,
const uint32_t& sec,
const uint32_t& usec,
const string& comment)
| profile_client_0_1_log |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
A log entry that is sent from a profile server.
Parameters:
pname | profiling variable. |
sec | absolute time in seconds that this entry was created. |
usec | absolute time in micro seconds that this entry was created. |
comment | a comment to be appended to this entry. |
XrlCmdError profile_client_0_1_finished (
const string& pname)
| profile_client_0_1_finished |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Sent to notify the client that all log entries have been sent.
Parameters:
pname | profiling variable. |