Y2PluginComponent Class Reference

#include <Y2PluginComponent.h>

Inheritance diagram for Y2PluginComponent:

List of all members.

Public Member Functions
	Y2PluginComponent (bool is_server, string filename, const char *creator_name, const char *component_name, int level)
	Y2PluginComponent (string filename, const char *creator_name, const char *component_name, const char *name_space)
	~Y2PluginComponent ()
string	name () const
YCPValue	evaluate (const YCPValue &command)
SCRAgent *	getSCRAgent ()
void	result (const YCPValue &result)
void	setServerOptions (int argc, char **argv)
YCPValue	doActualWork (const YCPList &arglist, Y2Component *user_interface)
Y2Component *	component ()
Private Member Functions
bool	loadPlugin (const char *name_space=NULL)
Y2ComponentCreator *	locateSym (int num)
Private Attributes
const bool	is_server
string	filename
string	creator_name
string	component_name
int	argc
char **	argv
int	level
void *	handle
Y2Component *	comp

---

Constructor & Destructor Documentation

Y2PluginComponent::Y2PluginComponent	(	bool	is_server,
		string	filename,
		const char *	creator_name,
		const char *	component_name,
		int	level
	)

Y2PluginComponent::Y2PluginComponent	(	string	filename,
		const char *	creator_name,
		const char *	component_name,
		const char *	name_space
	)

Y2PluginComponent::~Y2PluginComponent

(

)

Frees internal data.

---

Member Function Documentation

string Y2PluginComponent::name

(

)

const [virtual]

Returns the name of this component.

Implements Y2Component.

YCPValue Y2PluginComponent::evaluate

(

const YCPValue &

command

)

[virtual]

Let the server evaluate a command.

This method is only valid, if the component is a server.

Reimplemented from Y2Component.

SCRAgent * Y2PluginComponent::getSCRAgent

(

)

[virtual]

Returns the SCRAgent of the Y2Component or NULL if it doesn't have one.

Reimplemented from Y2Component.

void Y2PluginComponent::result

(

const YCPValue &

result

)

[virtual]

Tells this server, that the client doesn't need it's services any longer and that the exit code of the client is result.

This method is only valid, if the component is a server.

Reimplemented from Y2Component.

void Y2PluginComponent::setServerOptions	(	int	argc,
		char **	argv
	)			[virtual]

Sets the commandline options of the server.

This method is only valid, if the component is a server.

Reimplemented from Y2Component.

YCPValue Y2PluginComponent::doActualWork	(	const YCPList &	arglist,
		Y2Component *	user_interface
	)			[virtual]

Launches the plugin with the previously set parameters.

Reimplemented from Y2Component.

Y2Component* Y2PluginComponent::component

(

)

[inline]

Return the already allocated component. It could be NULL, if there was a problem loading the component.

bool Y2PluginComponent::loadPlugin

(

const char *

name_space = NULL

)

[private]

Does actually load the plugin.

Y2ComponentCreator * Y2PluginComponent::locateSym

(

int

num

)

[private]

Tries to locate the global componentcreator via dlsym.

---

Member Data Documentation

const bool Y2PluginComponent::is_server [private]

It this component a server or a client?

string Y2PluginComponent::filename [private]

The name of the plugin library.

string Y2PluginComponent::creator_name [private]

Name of the global component creator.

string Y2PluginComponent::component_name [private]

Name of the component that is implemented by the plugin.

int Y2PluginComponent::argc [private]

Stores options for a server plugin.

char** Y2PluginComponent::argv [private]

Stores options for a server plugin.

int Y2PluginComponent::level [private]

The component level the plugin was started in.

void* Y2PluginComponent::handle [private]

Handle of the dynamic loaded library.

Y2Component* Y2PluginComponent::comp [private]

The created Y2Component.

---

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

• Y2PluginComponent.h
• Y2PluginComponent.cc

---