xorp

XrlFinderclientTargetBase Class Reference

Inheritance diagram for XrlFinderclientTargetBase:
FinderClientXrlTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlFinderclientTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlFinderclientTargetBase ()
 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.
 XrlFinderclientTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlFinderclientTargetBase ()
 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 finder_client_0_2_hello ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_remove_xrl_from_cache (const string &xrl)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_remove_xrls_for_target_from_cache (const string &target_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_dispatch_tunneled_xrl (const string &xrl, uint32_t &xrl_error, string &xrl_error_note)=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 finder_client_0_2_hello ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_remove_xrl_from_cache (const string &xrl)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_remove_xrls_for_target_from_cache (const string &target_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_client_0_2_dispatch_tunneled_xrl (const string &xrl, uint32_t &xrl_error, string &xrl_error_note)=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_finder_client_0_2_hello (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_remove_xrl_from_cache (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_remove_xrls_for_target_from_cache (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_dispatch_tunneled_xrl (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_finder_client_0_2_hello (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_remove_xrl_from_cache (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_remove_xrls_for_target_from_cache (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_client_0_2_dispatch_tunneled_xrl (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(XrlFinderclientTargetBase::handlers) / sizeof(XrlFinderclientTargetBase::handlers[0]))

Constructor & Destructor Documentation

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

Destructor.

Dissociates instance commands from command map.

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

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::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 FinderClientXrlTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in FinderClientXrlTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in FinderClientXrlTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in FinderClientXrlTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_dispatch_tunneled_xrl ( const string &  xrl,
uint32_t &  xrl_error,
string &  xrl_error_note 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_dispatch_tunneled_xrl ( const string &  xrl,
uint32_t &  xrl_error,
string &  xrl_error_note 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Implemented in FinderClientXrlTarget.

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

Implemented in FinderClientXrlTarget.

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

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_remove_xrl_from_cache ( const string &  xrl) [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.

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_remove_xrl_from_cache ( const string &  xrl) [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.

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_remove_xrls_for_target_from_cache ( const string &  target_name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove all Xrls relating to target from cache.

Implemented in FinderClientXrlTarget.

virtual XrlCmdError XrlFinderclientTargetBase::finder_client_0_2_remove_xrls_for_target_from_cache ( const string &  target_name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove all Xrls relating to target from cache.

Implemented in FinderClientXrlTarget.

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