class XrlFinderclientTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlFinderclientTargetBase (XrlCmdMap* cmds = 0)

XrlFinderclientTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlFinderclientTargetBase ()

~XrlFinderclientTargetBase

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

const string&  name ()

name

[const]

Get Xrl instance name associated with command map.

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  finder_client_0_2_hello ()

finder_client_0_2_hello

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

No op method used by finder to poll for liveness.

XrlCmdError  finder_client_0_2_remove_xrl_from_cache ( const string& xrl)

finder_client_0_2_remove_xrl_from_cache

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Remove Xrl from cache. The client should remove currently cached value for Xrl from it's cached. On the next invocation of Xrl, the client will need to consult the Finder for updated information, though implementations may consult the Finder for updated information before.

XrlCmdError  finder_client_0_2_remove_xrls_for_target_from_cache ( const string& target_name)

finder_client_0_2_remove_xrls_for_target_from_cache

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Remove all Xrls relating to target from cache.

XrlCmdError  finder_client_0_2_dispatch_tunneled_xrl ( const string& xrl, uint32_t& xrl_error, string& xrl_error_note)

finder_client_0_2_dispatch_tunneled_xrl

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Execute tunneled Xrl. Permits finder to call methods on clients through FinderClient.


Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:10:51 2009, using kdoc 2.0a54+XORP.