trunk/libfjme/SharedDataSystem.c File Reference

#include "SharedDataSystem.h"
#include "basic.h"

Include dependency graph for SharedDataSystem.c:

Functions
gboolean	shared_data_add (gchar *name, gpointer data)
	Add a pointer to the data sharing system.
gboolean	shared_data_add_timeout (gchar *name, gchar *data, guint32 timeout)
	Adds a pointer to be shared. The duration of the data in memory.
gboolean	shared_data_add_custom_timeout (gchar *name, gchar *data, iSharedCallable delete_function, guint32 timeout)
	Adds a pointer to be shared. The duration of the data in memory. The function called when you need to delete the data. Indepedent function is called, runs g_free in the end.
gboolean	shared_data_add_custom (gchar *name, gpointer data, iSharedCallable delete_function)
	Add a pointer to the data sharing system.
gboolean	shared_data_delete (gchar *name)
	Delete a pointer from data sharing system.
gpointer	shared_data_get (gchar *name)
	Returns the pointer with that name.
gboolean	shared_data_set_number (gchar *name, guint32 number)
	Prepare the pointer to be obtained by a number.

---

Function Documentation

gboolean shared_data_add	(	gchar *	name,
		gpointer	data
	)

Add a pointer to the data sharing system.

You using this function, you can add one, named pointer. This pointer can be accessed from any part of the program. As also can be accessed through internal and external plugins. It adds, a member, to named pointers list. If you can not add a pointer to the list, or if, there is already a pointer with its name, it returns false. it returns false and does not add. If you can add the pointer to the list, returns true.

Author:

Fabio J. Gonzalez

Precondition:

If you're using from an external plugin, set the variable cmain, to refer to "struct IPlugin::m".

Warning:

If the variable cmain, not configured, your application may crash

Here is the caller graph for this function:

gboolean shared_data_add_custom	(	gchar *	name,
		gpointer	data,
		iSharedCallable	delete_function
	)

Add a pointer to the data sharing system.

Similar function shared_data_add more, delete the parameter sets, the structure iShared. This is done to customize the way that data is deleted. After the function is called g_free.

Author:

Fabio J. Gonzalez

Precondition:

If you're using from an external plugin, set the variable cmain, to refer to "struct IPlugin::m".

Warning:

If the variable cmain, not configured, your application may crash

gboolean shared_data_add_custom_timeout	(	gchar *	name,
		gchar *	data,
		iSharedCallable	delete_function,
		guint32	timeout
	)

Adds a pointer to be shared. The duration of the data in memory. The function called when you need to delete the data. Indepedent function is called, runs g_free in the end.

Author:

Fabio J. Gonzalez

gboolean shared_data_add_timeout	(	gchar *	name,
		gchar *	data,
		guint32	timeout
	)

Adds a pointer to be shared. The duration of the data in memory.

Author:

Fabio J. Gonzalez

gboolean shared_data_delete

(

gchar *

name

)

Delete a pointer from data sharing system.

Search by the pointer in the list, frees the memory used, and removes it. If possible, call the function "delete" in a shared data structure(iShared). The function "delete" is called before attempting to delete the pointer. If it can not delete, why not find anything with that name. Returns false. Otherwise returns true.

Author:

Fabio J. Gonzalez

Precondition:

If you're using from an external plugin, set the variable cmain, to refer to "struct IPlugin::m".

Warning:

If the variable cmain, not configured, your application may crash

Here is the caller graph for this function:

gpointer shared_data_get

(

gchar *

name

)

Returns the pointer with that name.

Search for a pointer, added globally with its name, and returns it. If not find the pointer, returns NULL.

Author:

Fabio J. Gonzalez

Precondition:

If you're using from an external plugin, set the variable cmain, to refer to "struct IPlugin::m".

Warning:

If the variable cmain, not configured, your application may crash

Here is the caller graph for this function:

gboolean shared_data_set_number	(	gchar *	name,
		guint32	number
	)

Prepare the pointer to be obtained by a number.

The advantage of doing this is, as the pointer is placed in a fixed place on the list, and obtained by the number of this place, it is much faster. It is faster, since, as has the place in this list, no need to seek. If it can adjust the pointer to be obtained by a number, returns TRUE. Otherwise, it returns FALSE.

Author:

Fabio J. Gonzalez

Precondition:

If you're using from an external plugin, set the variable cmain, to refer to "struct IPlugin::m".

Warning:

If the variable cmain, not configured, your application may crash

Here is the caller graph for this function: