XMMS2
Typedefs | Functions

IPC functions for XMMS2 Daemon. More...

Typedefs

typedef struct
xmms_ipc_object_pool_t 
xmms_ipc_object_pool_t
 The IPC object list. More...
 
typedef struct xmms_ipc_client_St xmms_ipc_client_t
 A IPC client representation. More...
 

Functions

void on_config_ipcsocket_change (xmms_object_t *object, xmmsv_t *_data, gpointer udata)
 Gets called when the config property "core.ipcsocket" has changed. More...
 
void xmms_ipc_send_broadcast (guint broadcastid, gint32 clientid, xmmsv_t *arg, xmms_error_t *err)
 Format and send a broadcast to a single client. More...
 
void xmms_ipc_send_message (gint32 clientid, xmms_ipc_msg_t *msg, xmms_error_t *err)
 Send an ipc message to a client. More...
 
gboolean xmms_ipc_has_pending (guint signalid)
 Checks if someone is waiting for signalid. More...
 
xmms_ipc_manager_txmms_ipc_manager_get ()
 Get the ipc_manager object. More...
 
void xmms_ipc_broadcast_register (xmms_object_t *object, xmms_ipc_signal_t signalid)
 Register a broadcast signal. More...
 
void xmms_ipc_broadcast_unregister (xmms_ipc_signal_t signalid)
 Unregister a broadcast signal. More...
 
void xmms_ipc_signal_register (xmms_object_t *object, xmms_ipc_signal_t signalid)
 Register a signal. More...
 
void xmms_ipc_signal_unregister (xmms_ipc_signal_t signalid)
 Unregister a signal. More...
 
void xmms_ipc_object_register (xmms_ipc_object_t objectid, xmms_object_t *object)
 Register a object to the IPC core. More...
 
void xmms_ipc_object_unregister (xmms_ipc_object_t objectid)
 Remove a object from the IPC core. More...
 
xmms_ipc_txmms_ipc_init (void)
 Initialize IPC. More...
 
void xmms_ipc_shutdown (void)
 Disable IPC. More...
 
gboolean xmms_ipc_setup_server (const gchar *path)
 Start the server. More...
 

Detailed Description

IPC functions for XMMS2 Daemon.

Typedef Documentation

typedef struct xmms_ipc_client_St xmms_ipc_client_t

A IPC client representation.

typedef struct xmms_ipc_object_pool_t xmms_ipc_object_pool_t

The IPC object list.

Function Documentation

void on_config_ipcsocket_change ( xmms_object_t object,
xmmsv_t _data,
gpointer  udata 
)

Gets called when the config property "core.ipcsocket" has changed.

Referenced by main().

void xmms_ipc_broadcast_register ( xmms_object_t object,
xmms_ipc_signal_t  signalid 
)

Register a broadcast signal.

void xmms_ipc_broadcast_unregister ( xmms_ipc_signal_t  signalid)

Unregister a broadcast signal.

gboolean xmms_ipc_has_pending ( guint  signalid)

Checks if someone is waiting for signalid.

xmms_ipc_t* xmms_ipc_init ( void  )

Initialize IPC.

Referenced by main().

xmms_ipc_manager_t* xmms_ipc_manager_get ( void  )

Get the ipc_manager object.

Referenced by xmms_courier_init().

void xmms_ipc_object_register ( xmms_ipc_object_t  objectid,
xmms_object_t object 
)

Register a object to the IPC core.

This needs to be done if you want to send commands to that object from the client.

void xmms_ipc_object_unregister ( xmms_ipc_object_t  objectid)

Remove a object from the IPC core.

void xmms_ipc_send_broadcast ( guint  broadcastid,
gint32  clientid,
xmmsv_t arg,
xmms_error_t err 
)

Format and send a broadcast to a single client.

void xmms_ipc_send_message ( gint32  clientid,
xmms_ipc_msg_t msg,
xmms_error_t err 
)

Send an ipc message to a client.

gboolean xmms_ipc_setup_server ( const gchar *  path)

Start the server.

Referenced by main(), and on_config_ipcsocket_change().

void xmms_ipc_shutdown ( void  )

Disable IPC.

Referenced by main().

void xmms_ipc_signal_register ( xmms_object_t object,
xmms_ipc_signal_t  signalid 
)

Register a signal.

void xmms_ipc_signal_unregister ( xmms_ipc_signal_t  signalid)

Unregister a signal.