Object

Object representation in XMMS server. More...

Data Structures
struct	xmms_object_St

Functions
void	xmms_object_cleanup (xmms_object_t *object)
	Cleanup all the resources for the object. More...
void	xmms_object_connect (xmms_object_t *object, guint32 signalid, xmms_object_handler_t handler, gpointer userdata)
	Connect to a signal that is emitted by this object. More...
void	xmms_object_disconnect (xmms_object_t *object, guint32 signalid, xmms_object_handler_t handler, gpointer userdata)
	Disconnect from a signal. More...
void	xmms_object_emit (xmms_object_t *object, guint32 signalid, xmmsv_t *data)
	Emit a signal and thus call all the handlers that are connected. More...
void	xmms_object_cmd_arg_init (xmms_object_cmd_arg_t *arg)
	Initialize a command argument. More...
void	xmms_object_emit_f (xmms_object_t *object, guint32 signalid, xmmsv_type_t type,...)
	Emits a signal on the current object. More...
void	xmms_object_cmd_add (xmms_object_t *object, guint cmdid, const xmms_object_cmd_func_t func)
	Add a command that could be called from the client API to a object. More...
void	xmms_object_cmd_call (xmms_object_t *object, guint cmdid, xmms_object_cmd_arg_t *arg)
	Call a command with argument. More...
xmmsv_t *	xmms_convert_and_kill_list (GList *list)
xmmsv_t *	xmms_convert_and_kill_dict (GTree *dict)
xmmsv_t *	xmms_convert_and_kill_string (gchar *str)
xmmsv_t *	xmms_convert_and_kill_bin (GString *gs)
int	xmms_bin_to_gstring (xmmsv_t *value, GString **gs)
int	dummy_identity (xmmsv_t *value, xmmsv_t **arg)
gboolean	check_string_list (xmmsv_t *list)
	Checks that the list only contains string values. More...

Detailed Description

Object representation in XMMS server.

A object can be used to emit signals.

Function Documentation

check_string_list()

gboolean check_string_list

(

xmmsv_t *

list

)

Checks that the list only contains string values.

Definition at line 469 of file object.c.

dummy_identity()

int dummy_identity	(	xmmsv_t *	value,
		xmmsv_t **	arg
	)

Definition at line 459 of file object.c.

xmms_bin_to_gstring()

int xmms_bin_to_gstring	(	xmmsv_t *	value,
		GString **	gs
	)

Definition at line 447 of file object.c.

xmms_convert_and_kill_bin()

xmmsv_t* xmms_convert_and_kill_bin

(

GString *

gs

)

xmms_convert_and_kill_dict()

xmmsv_t * xmms_convert_and_kill_dict

(

GTree *

dict

)

Definition at line 394 of file object.c.

xmms_convert_and_kill_list()

xmmsv_t * xmms_convert_and_kill_list

(

GList *

list

)

Definition at line 367 of file object.c.

xmms_convert_and_kill_string()

xmmsv_t * xmms_convert_and_kill_string

(

gchar *

str

)

Definition at line 408 of file object.c.

xmms_object_cleanup()

void xmms_object_cleanup

(

xmms_object_t *

object

)

Cleanup all the resources for the object.

Definition at line 62 of file object.c.

Referenced by __int_xmms_object_unref().

xmms_object_cmd_add()

void xmms_object_cmd_add	(	xmms_object_t *	object,
		guint	cmdid,
		const xmms_object_cmd_func_t	func
	)

Add a command that could be called from the client API to a object.

Parameters

object	The object that should have the method.
cmdid	A command id.
desc	A command description.

Definition at line 320 of file object.c.

xmms_object_cmd_arg_init()

void xmms_object_cmd_arg_init

(

xmms_object_cmd_arg_t *

arg

)

Initialize a command argument.

Definition at line 236 of file object.c.

xmms_object_cmd_call()

void xmms_object_cmd_call	(	xmms_object_t *	object,
		guint	cmdid,
		xmms_object_cmd_arg_t *	arg
	)

Call a command with argument.

Definition at line 338 of file object.c.

xmms_object_connect()

void xmms_object_connect	(	xmms_object_t *	object,
		guint32	signalid,
		xmms_object_handler_t	handler,
		gpointer	userdata
	)

Connect to a signal that is emitted by this object.

You can connect many handlers to the same signal as long as the handler address is unique.

Todo:

fix the need for a unique handler adress?

Parameters

object	the object that will emit the signal
signalid	the signalid to connect to

See also

signal_xmms.h

Parameters

handler	the Callback function to be called when signal is emited.
userdata	data to the callback function

Definition at line 115 of file object.c.

Referenced by xmms_config_property_callback_set().

xmms_object_disconnect()

void xmms_object_disconnect	(	xmms_object_t *	object,
		guint32	signalid,
		xmms_object_handler_t	handler,
		gpointer	userdata
	)

Disconnect from a signal.

Definition at line 146 of file object.c.

Referenced by xmms_config_property_callback_remove().

xmms_object_emit()

void xmms_object_emit	(	xmms_object_t *	object,
		guint32	signalid,
		xmmsv_t *	data
	)

Emit a signal and thus call all the handlers that are connected.

Parameters

object	the object to signal on.
signalid	the signalid to emit
data	the data that should be sent to the handler.

Definition at line 195 of file object.c.

Referenced by xmms_config_property_set_data().

xmms_object_emit_f()

void xmms_object_emit_f	(	xmms_object_t *	object,
		guint32	signalid,
		xmmsv_type_t	type,
			...
	)

Emits a signal on the current object.

This is like xmms_object_emit but you don't have to create the xmms_object_cmd_arg_t yourself. Use this when you creating non-complex signal arguments.

Parameters

object	Object to signal on.
signalid	Signal to emit.
type	the argument type to emit followed by the argument data.

Definition at line 256 of file object.c.

Referenced by xmms_collection_changed_msg_send(), xmms_medialib_entry_send_added(), xmms_medialib_entry_send_update(), and xmms_playlist_changed_msg_send().