XrlFinderTargetBase Class Reference

Inheritance diagram for XrlFinderTargetBase:

List of all members.

Classes
struct	handler_table
Public Member Functions
	XrlFinderTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlFinderTargetBase ()
	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.
	XrlFinderTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlFinderTargetBase ()
	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_0_2_register_finder_client (const string &instance_name, const string &class_name, const bool &singleton, const string &in_cookie, string &out_cookie)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_unregister_finder_client (const string &instance_name)=0
virtual XrlCmdError	finder_0_2_set_finder_client_enabled (const string &instance_name, const bool &enabled)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_finder_client_enabled (const string &instance_name, bool &enabled)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_add_xrl (const string &xrl, const string &protocol_name, const string &protocol_args, string &resolved_xrl_method_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_remove_xrl (const string &xrl)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_resolve_xrl (const string &xrl, XrlAtomList &resolutions)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_xrl_targets (XrlAtomList &target_names)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_xrls_registered_by (const string &target_name, XrlAtomList &xrls)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv4_permitted_hosts (XrlAtomList &ipv4s)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv4_permitted_nets (XrlAtomList &ipv4nets)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv6_permitted_hosts (XrlAtomList &ipv6s)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv6_permitted_nets (XrlAtomList &ipv6nets)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_register_class_event_interest (const string &requester_instance, const string &class_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_deregister_class_event_interest (const string &requester_instance, const string &class_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_register_instance_event_interest (const string &requester_instance, const string &instance_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_deregister_instance_event_interest (const string &requester_instance, const string &instance_name)=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_0_2_register_finder_client (const string &instance_name, const string &class_name, const bool &singleton, const string &in_cookie, string &out_cookie)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_unregister_finder_client (const string &instance_name)=0
virtual XrlCmdError	finder_0_2_set_finder_client_enabled (const string &instance_name, const bool &enabled)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_finder_client_enabled (const string &instance_name, bool &enabled)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_add_xrl (const string &xrl, const string &protocol_name, const string &protocol_args, string &resolved_xrl_method_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_remove_xrl (const string &xrl)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_resolve_xrl (const string &xrl, XrlAtomList &resolutions)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_xrl_targets (XrlAtomList &target_names)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_xrls_registered_by (const string &target_name, XrlAtomList &xrls)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv4_permitted_hosts (XrlAtomList &ipv4s)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv4_permitted_nets (XrlAtomList &ipv4nets)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv6_permitted_hosts (XrlAtomList &ipv6s)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_0_2_get_ipv6_permitted_nets (XrlAtomList &ipv6nets)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_register_class_event_interest (const string &requester_instance, const string &class_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_deregister_class_event_interest (const string &requester_instance, const string &class_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_register_instance_event_interest (const string &requester_instance, const string &instance_name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	finder_event_notifier_0_1_deregister_instance_event_interest (const string &requester_instance, const string &instance_name)=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_0_2_register_finder_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_unregister_finder_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_set_finder_client_enabled (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_finder_client_enabled (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_add_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_remove_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_resolve_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_xrl_targets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_xrls_registered_by (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv4_permitted_hosts (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv4_permitted_nets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv6_permitted_hosts (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv6_permitted_nets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_register_class_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_deregister_class_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_register_instance_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_deregister_instance_event_interest (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_0_2_register_finder_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_unregister_finder_client (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_set_finder_client_enabled (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_finder_client_enabled (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_add_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_remove_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_resolve_xrl (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_xrl_targets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_xrls_registered_by (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv4_permitted_hosts (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv4_permitted_nets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv6_permitted_hosts (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_0_2_get_ipv6_permitted_nets (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_register_class_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_deregister_class_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_register_instance_event_interest (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_finder_event_notifier_0_1_deregister_instance_event_interest (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(XrlFinderTargetBase::handlers) / sizeof(XrlFinderTargetBase::handlers[0]))

---

Constructor & Destructor Documentation

XrlFinderTargetBase::XrlFinderTargetBase

(

XrlCmdMap *

cmds = 0

)

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.

XrlFinderTargetBase::XrlFinderTargetBase

(

XrlCmdMap *

cmds = 0

)

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.

virtual XrlFinderTargetBase::~XrlFinderTargetBase

(

)

[virtual]

Destructor.

Dissociates instance commands from command map.

---

Member Function Documentation

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

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

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

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

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

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

virtual XrlCmdError XrlFinderTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_add_xrl	(	const string &	xrl,
		const string &	protocol_name,
		const string &	protocol_args,
		string &	resolved_xrl_method_name
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add resolved Xrl into system, fails if xrl is already registered.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_add_xrl	(	const string &	xrl,
		const string &	protocol_name,
		const string &	protocol_args,
		string &	resolved_xrl_method_name
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add resolved Xrl into system, fails if xrl is already registered.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_finder_client_enabled	(	const string &	instance_name,
		bool &	enabled
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get enabled state information associated with finder client.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_finder_client_enabled	(	const string &	instance_name,
		bool &	enabled
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get enabled state information associated with finder client.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv4_permitted_hosts

(

XrlAtomList &

ipv4s

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv4 hosts that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv4_permitted_hosts

(

XrlAtomList &

ipv4s

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv4 hosts that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv4_permitted_nets

(

XrlAtomList &

ipv4nets

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv4 nets that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv4_permitted_nets

(

XrlAtomList &

ipv4nets

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv4 nets that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv6_permitted_hosts

(

XrlAtomList &

ipv6s

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv6 hosts that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv6_permitted_hosts

(

XrlAtomList &

ipv6s

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv6 hosts that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv6_permitted_nets

(

XrlAtomList &

ipv6nets

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv6 nets that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_ipv6_permitted_nets

(

XrlAtomList &

ipv6nets

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of IPv6 nets that clients should accept IPC requests from.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_xrl_targets

(

XrlAtomList &

target_names

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of registered Xrl targets

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_xrl_targets

(

XrlAtomList &

target_names

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of registered Xrl targets

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_xrls_registered_by	(	const string &	target_name,
		XrlAtomList &	xrls
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of Xrls registered by target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_get_xrls_registered_by	(	const string &	target_name,
		XrlAtomList &	xrls
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get list of Xrls registered by target

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_register_finder_client	(	const string &	instance_name,
		const string &	class_name,
		const bool &	singleton,
		const string &	in_cookie,
		string &	out_cookie
	)		[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 client must support the finder_client interface in order to be able to process messages from the finder.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_register_finder_client	(	const string &	instance_name,
		const string &	class_name,
		const bool &	singleton,
		const string &	in_cookie,
		string &	out_cookie
	)		[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 client must support the finder_client interface in order to be able to process messages from the finder.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_remove_xrl

(

const string &

xrl

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove xrl

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_remove_xrl

(

const string &

xrl

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove xrl

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_resolve_xrl	(	const string &	xrl,
		XrlAtomList &	resolutions
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Resolve Xrl

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_resolve_xrl	(	const string &	xrl,
		XrlAtomList &	resolutions
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Resolve Xrl

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_set_finder_client_enabled	(	const string &	instance_name,
		const bool &	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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_0_2_set_finder_client_enabled	(	const string &	instance_name,
		const bool &	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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_deregister_class_event_interest	(	const string &	requester_instance,
		const string &	class_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_deregister_class_event_interest	(	const string &	requester_instance,
		const string &	class_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_deregister_instance_event_interest	(	const string &	requester_instance,
		const string &	instance_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_deregister_instance_event_interest	(	const string &	requester_instance,
		const string &	instance_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_register_class_event_interest	(	const string &	requester_instance,
		const string &	class_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_register_class_event_interest	(	const string &	requester_instance,
		const string &	class_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_register_instance_event_interest	(	const string &	requester_instance,
		const string &	instance_name
	)		[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.

Implemented in FinderXrlTarget.

virtual XrlCmdError XrlFinderTargetBase::finder_event_notifier_0_1_register_instance_event_interest	(	const string &	requester_instance,
		const string &	instance_name
	)		[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.

Implemented in FinderXrlTarget.

bool XrlFinderTargetBase::set_command_map

(

XrlCmdMap *

cmds

)

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.

bool XrlFinderTargetBase::set_command_map

(

XrlCmdMap *

cmds

)

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.

---

The documentation for this class was generated from the following files:

• /home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/finder_base.cc
• /home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/finder_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/finder_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/finder_base.cc