xorp

XrlProfilerTargetBase Class Reference

Inheritance diagram for XrlProfilerTargetBase:
XrlProfilerTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlProfilerTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlProfilerTargetBase ()
 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.
 XrlProfilerTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlProfilerTargetBase ()
 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 profile_client_0_1_log (const string &pname, const uint32_t &sec, const uint32_t &usec, const string &comment)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_client_0_1_finished (const string &pname)=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 profile_client_0_1_log (const string &pname, const uint32_t &sec, const uint32_t &usec, const string &comment)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_client_0_1_finished (const string &pname)=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_profile_client_0_1_log (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_client_0_1_finished (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_profile_client_0_1_log (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_client_0_1_finished (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(XrlProfilerTargetBase::handlers) / sizeof(XrlProfilerTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlProfilerTargetBase::XrlProfilerTargetBase ( 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.
XrlProfilerTargetBase::~XrlProfilerTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlProfilerTargetBase::XrlProfilerTargetBase ( 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 XrlProfilerTargetBase::~XrlProfilerTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::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 XrlProfilerTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlProfilerTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlProfilerTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlProfilerTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::profile_client_0_1_finished ( const string &  pname) [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:
pnameprofiling variable.

Implemented in XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::profile_client_0_1_finished ( const string &  pname) [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:
pnameprofiling variable.

Implemented in XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::profile_client_0_1_log ( const string &  pname,
const uint32_t &  sec,
const uint32_t &  usec,
const string &  comment 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

A log entry that is sent from a profile server.

Parameters:
pnameprofiling variable.
secabsolute time in seconds that this entry was created.
usecabsolute time in micro seconds that this entry was created.
commenta comment to be appended to this entry.

Implemented in XrlProfilerTarget.

virtual XrlCmdError XrlProfilerTargetBase::profile_client_0_1_log ( const string &  pname,
const uint32_t &  sec,
const uint32_t &  usec,
const string &  comment 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

A log entry that is sent from a profile server.

Parameters:
pnameprofiling variable.
secabsolute time in seconds that this entry was created.
usecabsolute time in micro seconds that this entry was created.
commenta comment to be appended to this entry.

Implemented in XrlProfilerTarget.

bool XrlProfilerTargetBase::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 XrlProfilerTargetBase::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