Lists of message queues

Send messages to multiple message queues. More...

Typedefs
typedef struct bg_msg_queue_list_s	bg_msg_queue_list_t
	Opaque message queue list type. You don't want to know what's inside.
Functions
bg_msg_queue_list_t *	bg_msg_queue_list_create ()
	Create a message queue list.
void	bg_msg_queue_list_destroy (bg_msg_queue_list_t *list)
	Destroy a message queue list.
void	bg_msg_queue_list_send (bg_msg_queue_list_t *list, void(*set_message)(bg_msg_t *message, const void *data), const void *data)
	Send a message to all queues in the list.
void	bg_msg_queue_list_add (bg_msg_queue_list_t *list, bg_msg_queue_t *queue)
	Add a queue to the list.
void	bg_msg_queue_list_remove (bg_msg_queue_list_t *list, bg_msg_queue_t *queue)
	Remove a queue from the list.

---

Detailed Description

Send messages to multiple message queues.

Lists of message queues can be used, if some informations have to be passed to multiple recipients. Each listener adds a message queue to the list and will get all messages, which are broadcasted with bg_msg_queue_list_send from the writing end.

---

Typedef Documentation

typedef struct bg_msg_queue_list_s bg_msg_queue_list_t

Opaque message queue list type. You don't want to know what's inside.

---

Function Documentation

bg_msg_queue_list_t* bg_msg_queue_list_create

(

)

Create a message queue list.

Returns:

A newly allocated message queue list

void bg_msg_queue_list_destroy

(

bg_msg_queue_list_t *

list

)

Destroy a message queue list.

Parameters:

list	A message queue list

void bg_msg_queue_list_send	(	bg_msg_queue_list_t *	list,
		void(*)(bg_msg_t *message, const void *data)	set_message,
		const void *	data
	)

Send a message to all queues in the list.

Parameters:

list	A message queue list
set_message	Function to set ID and arguments of a message
data	Data to pass to set_message

void bg_msg_queue_list_add	(	bg_msg_queue_list_t *	list,
		bg_msg_queue_t *	queue
	)

Add a queue to the list.

Parameters:

list	A message queue list
queue	A message queue

void bg_msg_queue_list_remove	(	bg_msg_queue_list_t *	list,
		bg_msg_queue_t *	queue
	)

Remove a queue from the list.

Parameters:

list	A message queue list
queue	A message queue