XrlXorpshTargetBase Class Reference

List of all members.

Classes
struct	handler_table
Public Member Functions
	XrlXorpshTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlXorpshTargetBase ()
	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.
	XrlXorpshTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlXorpshTargetBase ()
	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	rtrmgr_client_0_2_new_config_user (const uint32_t &userid)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_saved_done (const bool &success, const string &errmsg)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_change_done (const bool &success, const string &errmsg)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_changed (const uint32_t &userid, const string &deltas, const string &deletions)=0
virtual XrlCmdError	rtrmgr_client_0_2_module_status (const string &modname, const uint32_t &status)=0
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	rtrmgr_client_0_2_new_config_user (const uint32_t &userid)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_saved_done (const bool &success, const string &errmsg)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_change_done (const bool &success, const string &errmsg)=0
virtual XrlCmdError	rtrmgr_client_0_2_config_changed (const uint32_t &userid, const string &deltas, const string &deletions)=0
virtual XrlCmdError	rtrmgr_client_0_2_module_status (const string &modname, const uint32_t &status)=0
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_rtrmgr_client_0_2_new_config_user (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_saved_done (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_change_done (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_changed (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_module_status (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_rtrmgr_client_0_2_new_config_user (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_saved_done (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_change_done (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_config_changed (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_rtrmgr_client_0_2_module_status (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(XrlXorpshTargetBase::handlers) / sizeof(XrlXorpshTargetBase::handlers[0]))

---

Constructor & Destructor Documentation

XrlXorpshTargetBase::XrlXorpshTargetBase

(

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.

XrlXorpshTargetBase::~XrlXorpshTargetBase

(

)

[virtual]

Destructor.

Dissociates instance commands from command map.

XrlXorpshTargetBase::XrlXorpshTargetBase

(

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 XrlXorpshTargetBase::~XrlXorpshTargetBase

(

)

[virtual]

Destructor.

Dissociates instance commands from command map.

---

Member Function Documentation

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::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

virtual XrlCmdError XrlXorpshTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

virtual XrlCmdError XrlXorpshTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

virtual XrlCmdError XrlXorpshTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

virtual XrlCmdError XrlXorpshTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

bool XrlXorpshTargetBase::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 XrlXorpshTargetBase::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/xorpsh_base.cc
• /home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/xorpsh_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/xorpsh_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/xorpsh_base.cc