include/razorback/queue_list.h File Reference

A list of queues. More...

#include <razorback/visibility.h>
#include <razorback/queue.h>
#include <razorback/list.h>

Include dependency graph for queue_list.h:

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

Go to the source code of this file.

Data Structures
struct	QueueListEntry
	QueueListEntry an entry in a list of queues. More...
Functions
SO_PUBLIC struct List *	QueueList_Create (void)
	Initializes a queue list.
SO_PUBLIC struct Queue *	QueueList_Find (struct List *p_pList, const uuid_t p_pId)
	finds a queue in a list
SO_PUBLIC bool	QueueList_Add (struct List *p_pList, struct Queue *p_pQ, const uuid_t p_pId)
	adds a queue to a list
SO_PUBLIC bool	QueueList_Remove (struct List *p_pList, const uuid_t p_pId)
	Remove a queue to a list.
SO_PUBLIC struct QueueListEntry *	QueueList_First (const struct List *p_pList)
	first entry in a queue list
SO_PUBLIC struct QueueListEntry *	QueueList_Next (const struct List *p_pList, const struct QueueListEntry *p_pCurrent)
	next entry in a queue list

---

Detailed Description

A list of queues.

---

Function Documentation

SO_PUBLIC bool QueueList_Add	(	struct List *	p_pList,
		struct Queue *	p_pQ,
		const uuid_t	p_pId
	)

adds a queue to a list

Parameters:

	p_pList	the list
	p_pId	the id of the queue to add

Returns:

a pointer to the queue or null if not found

SO_PUBLIC struct List* QueueList_Create

(

void

)

[read]

Initializes a queue list.

Parameters:

p_pList

the list

SO_PUBLIC struct Queue* QueueList_Find	(	struct List *	p_pList,
		const uuid_t	p_pId
	)			[read]

finds a queue in a list

Parameters:

	p_pList	the list
	p_pId	the id of the queue to find

Returns:

a pointer to the queue or null if not found

SO_PUBLIC struct QueueListEntry* QueueList_First

(

const struct List *

p_pList

)

[read]

first entry in a queue list

Parameters:

p_pList

the list

SO_PUBLIC struct QueueListEntry* QueueList_Next	(	const struct List *	p_pList,
		const struct QueueListEntry *	p_pCurrent
	)			[read]

next entry in a queue list

Parameters:

	p_pList	the list
	p_pCurrent	the current entry

SO_PUBLIC bool QueueList_Remove	(	struct List *	p_pList,
		const uuid_t	p_pId
	)

Remove a queue to a list.

Parameters:

	p_pList	the list
	p_pId	the id of the queue to add

Returns:

a pointer to the queue or null if not found