xorp

XrlCoordTargetBase Class Reference

Inheritance diagram for XrlCoordTargetBase:
XrlCoordTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlCoordTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlCoordTargetBase ()
 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.
 XrlCoordTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlCoordTargetBase ()
 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 coord_0_1_command (const string &command)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError coord_0_1_status (const string &peer, string &status)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError coord_0_1_pending (bool &pending)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError datain_0_1_receive (const string &peer, const uint32_t &genid, const bool &status, const uint32_t &secs, const uint32_t &micro, const vector< uint8_t > &data)=0
virtual XrlCmdError datain_0_1_error (const string &peer, const uint32_t &genid, const string &reason)=0
virtual XrlCmdError datain_0_1_closed (const string &peer, const uint32_t &genid)=0
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 coord_0_1_command (const string &command)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError coord_0_1_status (const string &peer, string &status)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError coord_0_1_pending (bool &pending)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError datain_0_1_receive (const string &peer, const uint32_t &genid, const bool &status, const uint32_t &secs, const uint32_t &micro, const vector< uint8_t > &data)=0
virtual XrlCmdError datain_0_1_error (const string &peer, const uint32_t &genid, const string &reason)=0
virtual XrlCmdError datain_0_1_closed (const string &peer, const uint32_t &genid)=0

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_coord_0_1_command (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_coord_0_1_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_coord_0_1_pending (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_receive (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_error (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_closed (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_coord_0_1_command (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_coord_0_1_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_coord_0_1_pending (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_receive (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_error (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_datain_0_1_closed (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(XrlCoordTargetBase::handlers) / sizeof(XrlCoordTargetBase::handlers[0]))

Constructor & Destructor Documentation

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

Destructor.

Dissociates instance commands from command map.

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

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::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 XrlCoordTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlCoordTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlCoordTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlCoordTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_command ( const string &  command) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Command to be executed by the coordinating process.

Parameters:
commandto be sent to the coordinator.

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_command ( const string &  command) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Command to be executed by the coordinating process.

Parameters:
commandto be sent to the coordinator.

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_pending ( bool &  pending) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

If there are still any outstanding commands pending will return true. Can be used to poll the coordinating process to verify that the previous command has completed.

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_pending ( bool &  pending) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

If there are still any outstanding commands pending will return true. Can be used to poll the coordinating process to verify that the previous command has completed.

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_status ( const string &  peer,
string &  status 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Status, show the state of this peer.

Implemented in XrlCoordTarget.

virtual XrlCmdError XrlCoordTargetBase::coord_0_1_status ( const string &  peer,
string &  status 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Status, show the state of this peer.

Implemented in XrlCoordTarget.

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