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"

Go to the source code of this file.

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_length (const xmms_ipc_msg_t *msg)
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_length (xmms_ipc_msg_t *msg, uint32_t len)
void	xmms_ipc_msg_set_cookie (xmms_ipc_msg_t *msg, uint32_t cookie)
void	xmms_ipc_msg_set_cmd (xmms_ipc_msg_t *msg, uint32_t cmd)
void	xmms_ipc_msg_set_object (xmms_ipc_msg_t *msg, uint32_t object)
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

#define XMMS_IPC_MSG_DEFAULT_SIZE   128 /*32768*/

Definition at line 28 of file xmmsc_ipc_msg.h.

Referenced by xmms_ipc_msg_alloc(), and xmms_ipc_msg_read_transport().

#define XMMS_IPC_MSG_HEAD_LEN   16 /* all but data */

Definition at line 29 of file xmmsc_ipc_msg.h.

Referenced by xmms_ipc_msg_alloc(), xmms_ipc_msg_read_transport(), and xmms_ipc_msg_write_transport().

Typedef Documentation

typedef struct xmms_ipc_msg_St xmms_ipc_msg_t

Definition at line 31 of file xmmsc_ipc_msg.h.

Function Documentation

xmms_ipc_msg_t* xmms_ipc_msg_alloc

(

void

)

Definition at line 96 of file msg.c.

Referenced by xmms_ipc_msg_new().

void xmms_ipc_msg_destroy

(

xmms_ipc_msg_t *

msg

)

Definition at line 122 of file msg.c.

uint32_t xmms_ipc_msg_get_cmd

(

const xmms_ipc_msg_t *

msg

)

Definition at line 163 of file msg.c.

uint32_t xmms_ipc_msg_get_cookie

(

const xmms_ipc_msg_t *

msg

)

Definition at line 185 of file msg.c.

uint32_t xmms_ipc_msg_get_length

(

const xmms_ipc_msg_t *

msg

)

Definition at line 139 of file msg.c.

Referenced by xmms_ipc_msg_put_value(), xmms_ipc_msg_read_transport(), and xmms_ipc_msg_write_transport().

uint32_t xmms_ipc_msg_get_object

(

const xmms_ipc_msg_t *

msg

)

Definition at line 147 of file msg.c.

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

Definition at line 961 of file msg.c.

xmms_ipc_msg_t* xmms_ipc_msg_new	(	uint32_t	object,
		uint32_t	cmd
	)

Definition at line 109 of file msg.c.

Referenced by xmms_ipc_has_pending().

uint32_t xmms_ipc_msg_put_value	(	xmms_ipc_msg_t *	msg,
		xmmsv_t *	v
	)

Definition at line 470 of file msg.c.

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.

Definition at line 246 of file msg.c.

void xmms_ipc_msg_set_cmd	(	xmms_ipc_msg_t *	msg,
		uint32_t	cmd
	)

Definition at line 171 of file msg.c.

Referenced by xmms_ipc_msg_new().

void xmms_ipc_msg_set_cookie	(	xmms_ipc_msg_t *	msg,
		uint32_t	cookie
	)

Definition at line 179 of file msg.c.

Referenced by xmms_ipc_has_pending().

void xmms_ipc_msg_set_length	(	xmms_ipc_msg_t *	msg,
		uint32_t	len
	)

Definition at line 131 of file msg.c.

Referenced by xmms_ipc_msg_read_transport().

void xmms_ipc_msg_set_object	(	xmms_ipc_msg_t *	msg,
		uint32_t	object
	)

Definition at line 155 of file msg.c.

Referenced by xmms_ipc_msg_new().

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

Definition at line 201 of file msg.c.