class XrlCoordTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlCoordTargetBase (XrlCmdMap* cmds = 0)

XrlCoordTargetBase

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.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

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.

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:

Get name of Xrl Target

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:

Get status of Xrl Target

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  coord_0_1_command ( const string& command)

coord_0_1_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.
XrlCmdError  coord_0_1_status ( const string& peer, string& status)

coord_0_1_status

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Status, show the state of this peer.

XrlCmdError  coord_0_1_pending ( bool& pending)

coord_0_1_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.

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)

datain_0_1_receive

[protected pure virtual]

XrlCmdError  datain_0_1_error ( const string& peer, const uint32_t& genid, const string& reason)

datain_0_1_error

[protected pure virtual]

XrlCmdError  datain_0_1_closed ( const string& peer, const uint32_t& genid)

datain_0_1_closed

[protected pure virtual]


Generated by: pavlin on possum.icir.org on Wed Aug 2 15:36:11 2006, using kdoc $.