|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlFinderTargetBase (XrlCmdMap* cmds = 0)
| XrlFinderTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlFinderTargetBase ()
| ~XrlFinderTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer 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:
| 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:
| 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_0_2_register_finder_client (
const string& instance_name,
const string& class_name,
const bool& singleton,
const string& in_cookie,
string& out_cookie)
| finder_0_2_register_finder_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register client with Finder. Once client has been registered Xrl registrations may proceed. Once Xrl registrations have have been completed the client needs to be enabled for the Finder to respond to queries about the client. Fails if instance_name is already registered, or another instance of the same class is registered as a singleton. The target_name must support the finder_client interface in order to be able to process messages from the finder.
| XrlCmdError finder_0_2_unregister_finder_client (
const string& instance_name)
| finder_0_2_unregister_finder_client |
[protected pure virtual]
| XrlCmdError finder_0_2_set_finder_client_enabled (
const string& instance_name,
const bool& enabled)
| finder_0_2_set_finder_client_enabled |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable resolution of Xrls associated with target. Disabling Xrls at present does not cause clients to flush state associated with target so cached entries in clients are unaffected by this Xrl. Caller must be client that registered Xrl.
| XrlCmdError finder_0_2_finder_client_enabled (
const string& instance_name,
bool& enabled)
| finder_0_2_finder_client_enabled |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get enabled state information associated with finder client.
| XrlCmdError finder_0_2_add_xrl (
const string& xrl,
const string& protocol_name,
const string& protocol_args,
string& resolved_xrl_method_name)
| finder_0_2_add_xrl |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add resolved Xrl into system, fails if xrl is already registered.
| XrlCmdError finder_0_2_remove_xrl (
const string& xrl)
| finder_0_2_remove_xrl |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError finder_0_2_resolve_xrl (
const string& xrl,
XrlAtomList& resolutions)
| finder_0_2_resolve_xrl |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError finder_0_2_get_xrl_targets (
XrlAtomList& target_names)
| finder_0_2_get_xrl_targets |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of registered Xrl targets
| XrlCmdError finder_0_2_get_xrls_registered_by (
const string& target_name,
XrlAtomList& xrls)
| finder_0_2_get_xrls_registered_by |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of Xrls registered by target
| XrlCmdError finder_0_2_get_ipv4_permitted_hosts (
XrlAtomList& ipv4s)
| finder_0_2_get_ipv4_permitted_hosts |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of IPv4 hosts that clients should accept IPC requests from.
| XrlCmdError finder_0_2_get_ipv4_permitted_nets (
XrlAtomList& ipv4nets)
| finder_0_2_get_ipv4_permitted_nets |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of IPv4 nets that clients should accept IPC requests from.
| XrlCmdError finder_0_2_get_ipv6_permitted_hosts (
XrlAtomList& ipv6s)
| finder_0_2_get_ipv6_permitted_hosts |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of IPv6 hosts that clients should accept IPC requests from.
| XrlCmdError finder_0_2_get_ipv6_permitted_nets (
XrlAtomList& ipv6nets)
| finder_0_2_get_ipv6_permitted_nets |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get list of IPv6 nets that clients should accept IPC requests from.
| XrlCmdError finder_event_notifier_0_1_register_class_event_interest (
const string& requester_instance,
const string& class_name)
| finder_event_notifier_0_1_register_class_event_interest |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register interest in events relating to a particular class. Following this call the requester will receive birth event notifications for existing instances within the named class and will receive birth and deatch event notifications as instances are created and destroyed subsequently.
Parameters:
| requester_instance | instance name of Xrl Target interested in receiving event notifications. |
| class_name | class of Xrl Targets to generate event notifications for. |
| XrlCmdError finder_event_notifier_0_1_deregister_class_event_interest (
const string& requester_instance,
const string& class_name)
| finder_event_notifier_0_1_deregister_class_event_interest |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Deregister interest in events relating to a particular class.
Parameters:
| requester_instance | instance name of Xrl Target interested in receiving event notifications. |
| class_name | class of Xrl Targets to stop event notifications for. |
| XrlCmdError finder_event_notifier_0_1_register_instance_event_interest (
const string& requester_instance,
const string& instance_name)
| finder_event_notifier_0_1_register_instance_event_interest |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register interest in events relating to a particular instance. Following this call the requester will receive a birth event notification for the named instance if it exists. When the named instance dies, the requester will receive a death event notification. This method will fail if the named instance does not exist.
Parameters:
| requester_instance | instance name of Xrl Target interested in receiving event notifications. |
| instance_name | name of Xrl Target instance to receive event notifications for. |
| XrlCmdError finder_event_notifier_0_1_deregister_instance_event_interest (
const string& requester_instance,
const string& instance_name)
| finder_event_notifier_0_1_deregister_instance_event_interest |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register interest in events relating to a particular instance.
Parameters:
| requester_instance | instance name of Xrl Target interested in receiving event notifications. |
| instance_name | name of Xrl Target instance to stop event notifications for. |
