Source: ../../xrl/targets/finder_base.hh
|
|
|
|
/*
* Copyright (c) 2001-2007 International Computer Science Institute
* See LICENSE file for licensing, conditions, and warranties on use.
*
* DO NOT EDIT THIS FILE - IT IS PROGRAMMATICALLY GENERATED
*
* Generated by 'tgt-gen'.
*
* $XORP: xorp/xrl/targets/finder_base.hh,v 1.26 2007/02/16 22:47:51 pavlin Exp $
*/
#ifndef __XRL_TARGETS_FINDER_BASE_HH__
#define __XRL_TARGETS_FINDER_BASE_HH__
#undef XORP_LIBRARY_NAME
#define XORP_LIBRARY_NAME "XrlFinderTarget"
#include "libxorp/xlog.h"
#include "libxipc/xrl_cmd_map.hh"
class XrlFinderTargetBase {
protected:
XrlCmdMap* _cmds;
public:
/**
* Constructor.
*
* @param cmds an XrlCmdMap that the commands associated with the target
* should be added to. This is typically the XrlRouter
* associated with the target.
*/
XrlFinderTargetBase(XrlCmdMap* cmds = 0);
/**
* Destructor.
*
* Dissociates instance commands from command map.
*/
virtual ~XrlFinderTargetBase();
/**
* Set command map.
*
* @param cmds pointer to command map to associate commands with. This
* argument is typically a pointer to the XrlRouter associated with the
* target.
*
* @return true on success, false if cmds is null or a command map has
* already been supplied.
*/
bool set_command_map(XrlCmdMap* cmds);
/**
* Get Xrl instance name associated with command map.
*/
inline const string& name() const { return _cmds->name(); }
/**
* Get version string of instance.
*/
inline const char* version() const { return "finder/0.0"; }
protected:
/**
* Pure-virtual function that needs to be implemented to:
*
* Get name of Xrl Target
*/
virtual XrlCmdError common_0_1_get_target_name(
// Output values,
string& name) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get version string from Xrl Target
*/
virtual XrlCmdError common_0_1_get_version(
// Output values,
string& version) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get status of Xrl Target
*/
virtual XrlCmdError common_0_1_get_status(
// Output values,
uint32_t& status,
string& reason) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Request clean shutdown of Xrl Target
*/
virtual XrlCmdError common_0_1_shutdown() = 0;
/**
* 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.
*/
virtual XrlCmdError finder_0_2_register_finder_client(
// Input values,
const string& instance_name,
const string& class_name,
const bool& singleton,
const string& in_cookie,
// Output values,
string& out_cookie) = 0;
virtual XrlCmdError finder_0_2_unregister_finder_client(
// Input values,
const string& instance_name) = 0;
/**
* 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.
*/
virtual XrlCmdError finder_0_2_set_finder_client_enabled(
// Input values,
const string& instance_name,
const bool& enabled) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get enabled state information associated with finder client.
*/
virtual XrlCmdError finder_0_2_finder_client_enabled(
// Input values,
const string& instance_name,
// Output values,
bool& enabled) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Add resolved Xrl into system, fails if xrl is already registered.
*/
virtual XrlCmdError finder_0_2_add_xrl(
// Input values,
const string& xrl,
const string& protocol_name,
const string& protocol_args,
// Output values,
string& resolved_xrl_method_name) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Remove xrl
*/
virtual XrlCmdError finder_0_2_remove_xrl(
// Input values,
const string& xrl) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Resolve Xrl
*/
virtual XrlCmdError finder_0_2_resolve_xrl(
// Input values,
const string& xrl,
// Output values,
XrlAtomList& resolutions) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of registered Xrl targets
*/
virtual XrlCmdError finder_0_2_get_xrl_targets(
// Output values,
XrlAtomList& target_names) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of Xrls registered by target
*/
virtual XrlCmdError finder_0_2_get_xrls_registered_by(
// Input values,
const string& target_name,
// Output values,
XrlAtomList& xrls) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of IPv4 hosts that clients should accept IPC requests from.
*/
virtual XrlCmdError finder_0_2_get_ipv4_permitted_hosts(
// Output values,
XrlAtomList& ipv4s) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of IPv4 nets that clients should accept IPC requests from.
*/
virtual XrlCmdError finder_0_2_get_ipv4_permitted_nets(
// Output values,
XrlAtomList& ipv4nets) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of IPv6 hosts that clients should accept IPC requests from.
*/
virtual XrlCmdError finder_0_2_get_ipv6_permitted_hosts(
// Output values,
XrlAtomList& ipv6s) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Get list of IPv6 nets that clients should accept IPC requests from.
*/
virtual XrlCmdError finder_0_2_get_ipv6_permitted_nets(
// Output values,
XrlAtomList& ipv6nets) = 0;
/**
* 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.
*
* @param requester_instance instance name of Xrl Target interested in
* receiving event notifications.
*
* @param class_name class of Xrl Targets to generate event notifications
* for.
*/
virtual XrlCmdError finder_event_notifier_0_1_register_class_event_interest(
// Input values,
const string& requester_instance,
const string& class_name) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Deregister interest in events relating to a particular class.
*
* @param requester_instance instance name of Xrl Target interested in
* receiving event notifications.
*
* @param class_name class of Xrl Targets to stop event notifications for.
*/
virtual XrlCmdError finder_event_notifier_0_1_deregister_class_event_interest(
// Input values,
const string& requester_instance,
const string& class_name) = 0;
/**
* 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.
*
* @param requester_instance instance name of Xrl Target interested in
* receiving event notifications.
*
* @param instance_name name of Xrl Target instance to receive event
* notifications for.
*/
virtual XrlCmdError finder_event_notifier_0_1_register_instance_event_interest(
// Input values,
const string& requester_instance,
const string& instance_name) = 0;
/**
* Pure-virtual function that needs to be implemented to:
*
* Register interest in events relating to a particular instance.
*
* @param requester_instance instance name of Xrl Target interested in
* receiving event notifications.
*
* @param instance_name name of Xrl Target instance to stop event
* notifications for.
*/
virtual XrlCmdError finder_event_notifier_0_1_deregister_instance_event_interest(
// Input values,
const string& requester_instance,
const string& instance_name) = 0;
private:
const XrlCmdError handle_common_0_1_get_target_name(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_common_0_1_get_version(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_common_0_1_get_status(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_common_0_1_shutdown(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_register_finder_client(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_unregister_finder_client(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_set_finder_client_enabled(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_finder_client_enabled(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_add_xrl(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_remove_xrl(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_resolve_xrl(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_xrl_targets(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_xrls_registered_by(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_ipv4_permitted_hosts(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_ipv4_permitted_nets(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_ipv6_permitted_hosts(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_0_2_get_ipv6_permitted_nets(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_event_notifier_0_1_register_class_event_interest(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_event_notifier_0_1_deregister_class_event_interest(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_event_notifier_0_1_register_instance_event_interest(const XrlArgs& in, XrlArgs* out);
const XrlCmdError handle_finder_event_notifier_0_1_deregister_instance_event_interest(const XrlArgs& in, XrlArgs* out);
void add_handlers();
void remove_handlers();
};
#endif // __XRL_TARGETS_FINDER_BASE_HH__
Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:08 2007, using kdoc $.
