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.
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.
void	xmms_object_disconnect (xmms_object_t *object, guint32 signalid, xmms_object_handler_t handler, gpointer userdata)
	Disconnect from a signal.
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.
void	xmms_object_cmd_arg_init (xmms_object_cmd_arg_t *arg)
	Initialize a command argument.
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.
void	xmms_object_cmd_call (xmms_object_t *object, guint cmdid, xmms_object_cmd_arg_t *arg)
	Call a command with argument.
xmmsv_t *	xmms_convert_and_kill_string (gchar *str)
xmmsv_t *	xmms_convert_and_kill_list (GList *list)
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)

Detailed Description

Object representation in XMMS server.

A object can be used to emit signals.

Function Documentation

dummy_identity()

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

xmms_bin_to_gstring()

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

xmms_convert_and_kill_bin()

xmmsv_t * xmms_convert_and_kill_bin

(

GString *

gs

)

xmms_convert_and_kill_list()

xmmsv_t * xmms_convert_and_kill_list

(

GList *

list

)

xmms_convert_and_kill_string()

xmmsv_t * xmms_convert_and_kill_string

(

gchar *

str

)

xmms_object_cleanup()

void xmms_object_cleanup

(

xmms_object_t *

object

)

Cleanup all the resources for the object.

Referenced by 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.

xmms_object_cmd_arg_init()

void xmms_object_cmd_arg_init

(

xmms_object_cmd_arg_t *

arg

)

Initialize a command argument.

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.

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 address?

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 emitted.
userdata	data to the callback function

Referenced by xmms_coll_sync_init(), xmms_config_property_callback_set(), xmms_courier_init(), xmms_ipc_broadcast_register(), xmms_ipc_signal_register(), xmms_mediainfo_reader_start(), xmms_playlist_init(), and xmms_playlist_updater_init().

xmms_object_disconnect()

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

Disconnect from a signal.

Referenced by xmms_config_property_callback_remove(), xmms_ipc_broadcast_unregister(), and xmms_ipc_signal_unregister().

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.

Referenced by xmms_collection_changed_msg_send(), and xmms_config_property_set_data().