Object
[XMMSServer]


Detailed Description

Object representation in XMMS server.

A object can be used to emit signals.


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, gconstpointer data)
 Emit a signal and thus call all the handlers that are connected.
xmms_object_cmd_value_txmms_object_cmd_value_bin_new (GString *bin)
xmms_object_cmd_value_txmms_object_cmd_value_str_new (const gchar *string)
xmms_object_cmd_value_txmms_object_cmd_value_uint_new (guint32 uint)
xmms_object_cmd_value_txmms_object_cmd_value_int_new (gint32 i)
xmms_object_cmd_value_txmms_object_cmd_value_dict_new (GTree *dict)
xmms_object_cmd_value_txmms_object_cmd_value_hash_table_new (GHashTable *hash)
xmms_object_cmd_value_txmms_object_cmd_value_propdict_new (GList *list)
xmms_object_cmd_value_txmms_object_cmd_value_list_new (GList *list)
xmms_object_cmd_value_txmms_object_cmd_value_coll_new (xmmsc_coll_t *coll)
xmms_object_cmd_value_txmms_object_cmd_value_none_new (void)
void xmms_object_cmd_value_unref (xmms_object_cmd_value_t *val)
xmms_object_cmd_value_txmms_object_cmd_value_ref (xmms_object_cmd_value_t *val)
void xmms_object_cmd_arg_init (xmms_object_cmd_arg_t *arg)
 Initialize a command argument.
void xmms_object_emit_f (xmms_object_t *object, guint32 signalid, xmms_object_cmd_arg_type_t type,...)
 Emits a signal on the current object.
void xmms_object_cmd_add (xmms_object_t *object, guint cmdid, xmms_object_cmd_desc_t *desc)
 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.


Function Documentation

void xmms_object_cleanup ( xmms_object_t object  ) 

Cleanup all the resources for the object.

Definition at line 44 of file object.c.

Referenced by __int_xmms_object_unref().

void xmms_object_cmd_add ( xmms_object_t object,
guint  cmdid,
xmms_object_cmd_desc_t desc 
)

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 459 of file object.c.

Referenced by main(), xmms_bindata_init(), xmms_collection_init(), xmms_config_init(), xmms_medialib_init(), xmms_output_new(), xmms_playlist_init(), and xmms_xform_object_init().

void xmms_object_cmd_arg_init ( xmms_object_cmd_arg_t arg  ) 

Initialize a command argument.

Definition at line 369 of file object.c.

Referenced by xmms_object_emit_f().

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 473 of file object.c.

xmms_object_cmd_value_t* xmms_object_cmd_value_bin_new ( GString *  bin  ) 

Definition at line 181 of file object.c.

Referenced by xmms_object_emit_f(), and xmms_xform_auxdata_set_bin().

xmms_object_cmd_value_t* xmms_object_cmd_value_coll_new ( xmmsc_coll_t coll  ) 

Definition at line 270 of file object.c.

Referenced by xmms_object_emit_f().

xmms_object_cmd_value_t* xmms_object_cmd_value_dict_new ( GTree *  dict  ) 

Definition at line 226 of file object.c.

Referenced by xmms_object_emit_f(), and xmms_xform_browse_add_entry().

xmms_object_cmd_value_t* xmms_object_cmd_value_hash_table_new ( GHashTable *  hash  ) 

Definition at line 237 of file object.c.

Referenced by xmms_object_emit_f().

xmms_object_cmd_value_t* xmms_object_cmd_value_int_new ( gint32  i  ) 

xmms_object_cmd_value_t* xmms_object_cmd_value_list_new ( GList *  list  ) 

Definition at line 259 of file object.c.

Referenced by xmms_object_emit_f().

xmms_object_cmd_value_t* xmms_object_cmd_value_none_new ( void   ) 

Definition at line 281 of file object.c.

Referenced by xmms_object_emit_f(), and xmms_xform_auxdata_barrier().

xmms_object_cmd_value_t* xmms_object_cmd_value_propdict_new ( GList *  list  ) 

Definition at line 248 of file object.c.

xmms_object_cmd_value_t* xmms_object_cmd_value_ref ( xmms_object_cmd_value_t val  ) 

Definition at line 355 of file object.c.

xmms_object_cmd_value_t* xmms_object_cmd_value_str_new ( const gchar *  string  ) 

xmms_object_cmd_value_t* xmms_object_cmd_value_uint_new ( guint32  uint  ) 

void xmms_object_cmd_value_unref ( xmms_object_cmd_value_t val  ) 

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 80 of file object.c.

Referenced by xmms_config_property_callback_set(), xmms_ipc_broadcast_register(), xmms_ipc_signal_register(), and xmms_playlist_init().

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

Disconnect from a signal.

Definition at line 111 of file object.c.

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

void xmms_object_emit ( xmms_object_t object,
guint32  signalid,
gconstpointer  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 151 of file object.c.

Referenced by __int_xmms_object_unref(), xmms_config_property_set_data(), and xmms_object_emit_f().

void xmms_object_emit_f ( xmms_object_t object,
guint32  signalid,
xmms_object_cmd_arg_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 389 of file object.c.

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


Generated on Wed Dec 10 18:06:45 2008 for XMMS2 by  doxygen 1.5.6