message_queue.h File Reference

#include <stddef.h>
#include <retro_common_api.h>

Include dependency graph for message_queue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef typedefRETRO_BEGIN_DECLS struct msg_queue	msg_queue_t

Functions
msg_queue_t *	msg_queue_new (size_t size)
void	msg_queue_push (msg_queue_t *queue, const char *msg, unsigned prio, unsigned duration)
const char *	msg_queue_pull (msg_queue_t *queue)
void	msg_queue_clear (msg_queue_t *queue)
void	msg_queue_free (msg_queue_t *queue)

Typedef Documentation

msg_queue_t

typedef typedefRETRO_BEGIN_DECLS struct msg_queue msg_queue_t

Function Documentation

msg_queue_clear()

void msg_queue_clear

(

msg_queue_t *

queue

)

msg_queue_clear: : pointer to queue object

Clears out everything in the queue.

Here is the call graph for this function:

Here is the caller graph for this function:

msg_queue_free()

void msg_queue_free

(

msg_queue_t *

queue

)

msg_queue_free: : pointer to queue object

Frees message queue..

Here is the call graph for this function:

Here is the caller graph for this function:

msg_queue_new()

msg_queue_t* msg_queue_new

(

size_t

size

)

msg_queue_new: : maximum size of message

Creates a message queue with maximum size different messages.

Returns: NULL if allocation error, pointer to a message queue if successful. Has to be freed manually.

Here is the call graph for this function:

Here is the caller graph for this function:

msg_queue_pull()

const char* msg_queue_pull

(

msg_queue_t *

queue

)

msg_queue_pull: : pointer to queue object

Pulls highest priority message in queue.

Returns: NULL if no message in queue, otherwise a string containing the message.

Here is the call graph for this function:

Here is the caller graph for this function:

msg_queue_push()

void msg_queue_push	(	msg_queue_t *	queue,
		const char *	msg,
		unsigned	prio,
		unsigned	duration
	)

msg_queue_push: : pointer to queue object : message to add to the queue : priority level of the message : how many times the message can be pulled before it vanishes (E.g. show a message for 3 seconds @ 60fps = 180 duration).

Push a new message onto the queue.

Here is the caller graph for this function: