xmmsc_ipc_msg.h File Reference

#include <xmmsc/xmmsc_compiler.h>
#include <xmmsc/xmmsc_stdint.h>
#include <xmmsc/xmmsc_stdbool.h>
#include <xmmsc/xmmsc_util.h>
#include <xmmsc/xmmsc_ipc_transport.h>
#include <xmmsc/xmmsv_coll.h>
#include <xmmsc/xmmsv.h>

Macros
#define	XMMS_IPC_MSG_DEFAULT_SIZE   128 /*32768*/
#define	XMMS_IPC_MSG_HEAD_LEN   16 /* all but data */

Typedefs
typedef struct xmms_ipc_msg_St	xmms_ipc_msg_t

Functions
uint32_t	xmms_ipc_msg_get_object (const xmms_ipc_msg_t *msg)
uint32_t	xmms_ipc_msg_get_cmd (const xmms_ipc_msg_t *msg)
uint32_t	xmms_ipc_msg_get_cookie (const xmms_ipc_msg_t *msg)
void	xmms_ipc_msg_set_cookie (xmms_ipc_msg_t *msg, uint32_t cookie)
xmms_ipc_msg_t *	xmms_ipc_msg_new (uint32_t object, uint32_t cmd)
xmms_ipc_msg_t *	xmms_ipc_msg_alloc (void)
void	xmms_ipc_msg_destroy (xmms_ipc_msg_t *msg)
bool	xmms_ipc_msg_write_transport (xmms_ipc_msg_t *msg, xmms_ipc_transport_t *transport, bool *disconnected)
	Try to write message to transport. More...
bool	xmms_ipc_msg_read_transport (xmms_ipc_msg_t *msg, xmms_ipc_transport_t *transport, bool *disconnected)
	Try to read message from transport into msg. More...
uint32_t	xmms_ipc_msg_put_value (xmms_ipc_msg_t *msg, xmmsv_t *v)
bool	xmms_ipc_msg_get_value (xmms_ipc_msg_t *msg, xmmsv_t **val)

Macro Definition Documentation

XMMS_IPC_MSG_DEFAULT_SIZE

#define XMMS_IPC_MSG_DEFAULT_SIZE   128 /*32768*/

XMMS_IPC_MSG_HEAD_LEN

#define XMMS_IPC_MSG_HEAD_LEN   16 /* all but data */

Typedef Documentation

xmms_ipc_msg_t

typedef struct xmms_ipc_msg_St xmms_ipc_msg_t

Function Documentation

xmms_ipc_msg_alloc()

xmms_ipc_msg_t* xmms_ipc_msg_alloc

(

void

)

Referenced by xmms_ipc_msg_new().

xmms_ipc_msg_destroy()

void xmms_ipc_msg_destroy

(

xmms_ipc_msg_t *

msg

)

xmms_ipc_msg_get_cmd()

uint32_t xmms_ipc_msg_get_cmd

(

const xmms_ipc_msg_t *

msg

)

xmms_ipc_msg_get_cookie()

uint32_t xmms_ipc_msg_get_cookie

(

const xmms_ipc_msg_t *

msg

)

xmms_ipc_msg_get_object()

uint32_t xmms_ipc_msg_get_object

(

const xmms_ipc_msg_t *

msg

)

xmms_ipc_msg_get_value()

bool xmms_ipc_msg_get_value	(	xmms_ipc_msg_t *	msg,
		xmmsv_t **	val
	)

xmms_ipc_msg_new()

xmms_ipc_msg_t* xmms_ipc_msg_new	(	uint32_t	object,
		uint32_t	cmd
	)

xmms_ipc_msg_put_value()

uint32_t xmms_ipc_msg_put_value	(	xmms_ipc_msg_t *	msg,
		xmmsv_t *	v
	)

xmms_ipc_msg_read_transport()

bool xmms_ipc_msg_read_transport	(	xmms_ipc_msg_t *	msg,
		xmms_ipc_transport_t *	transport,
		bool *	disconnected
	)

Try to read message from transport into msg.

Returns

TRUE if message is fully read.

xmms_ipc_msg_set_cookie()

void xmms_ipc_msg_set_cookie	(	xmms_ipc_msg_t *	msg,
		uint32_t	cookie
	)

xmms_ipc_msg_write_transport()

bool xmms_ipc_msg_write_transport	(	xmms_ipc_msg_t *	msg,
		xmms_ipc_transport_t *	transport,
		bool *	disconnected
	)

Try to write message to transport.

If full message isn't written the message will keep track of the amount of data written and not write already written data next time.

Returns

TRUE if full message was written, FALSE otherwise. disconnected is set if transport was disconnected