Référence du fichier character_queue.h

File (FIFO) contenant des valeurs de type char Plus de détails...

#include <stdlib.h>
#include "character_list.h"

Aller au code source de ce fichier.

Définitions de type
typedef character_list_t	character_queue_t
	Type de données pour représenter une file contenant des valeurs de type char

Fonctions
void	character_queue_init (character_queue_t *queue)
	Initialisation d'une nouvelle file contenant des valeurs de type char
void	character_queue_destroy (character_queue_t *queue)
	Destruction d'une file.
int	character_queue_size (character_queue_t *queue)
	Accesseur sur la taille d'une file.
int	character_queue_enqueue (character_queue_t *queue, char data)
	Ajouter un élément de type char dans la file.
int	character_queue_dequeue (character_queue_t *queue, char *data)
	Supprime un élément de type char dans la file.
char	character_queue_peek (character_queue_t *queue)
	Récupère la valeur de type char le plus ancien de la file.

Description détaillée

File (FIFO) contenant des valeurs de type char

Documentation des définitions de type

character_queue_t

typedef character_list_t character_queue_t

Type de données pour représenter une file contenant des valeurs de type char

Une file est une liste chaînée gérée de manière adéquate: insertion en tête et suppression en queue.

Documentation des fonctions

character_queue_dequeue()

int character_queue_dequeue	(	character_queue_t *	queue,
		char *	data )

Supprime un élément de type char dans la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), supprime l'élément le plus ancien de la file.

Paramètres

queue

est un pointeur vers la structure de données character_queue_t @pram data un pointeur sur type char qui permet de récupérer la valeur de l'élément supprimer de la file

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

character_queue_destroy()

void character_queue_destroy

(

character_queue_t *

queue

)

Destruction d'une file.

Utilise la fonction de destruction des listes chaînées pour parcourir la liste et détruire tous les éléments de la file.

Paramètres

queue

est un pointeur vers la structure de données des piles character_queue_t

character_queue_enqueue()

int character_queue_enqueue	(	character_queue_t *	queue,
		char	data )

Ajouter un élément de type char dans la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée) et une valeur de type char, ajoute un nouvel élément à la file avec cette valeur.

Paramètres

queue

est un pointeur vers la structure de données character_queue_t @pram data une valeur de type char à ajouter à la file

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

character_queue_init()

void character_queue_init

(

character_queue_t *

queue

)

Initialisation d'une nouvelle file contenant des valeurs de type char

Utilise la fonction d'initalisation des listes chaînée pour mettre à zéro la taille et à NULL les pointeurs vers le premier et le dernier élément de la liste, i.e., de la file.

Paramètres

queue

est un pointeur vers la structure de données des files character_queue_t

character_queue_peek()

char character_queue_peek

(

character_queue_t *

queue

)

Récupère la valeur de type char le plus ancien de la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), récupère la valeur de l'élément le plus ancien de la file sans le supprimer.

Paramètres

queue

est un pointeur vers la structure de données character_queue_t

Renvoie

une valeur de char de l'élément le plus ancien de la file

character_queue_size()

int character_queue_size

(

character_queue_t *

queue

)

Accesseur sur la taille d'une file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), retourne la valeur du champ size

Paramètres

queue

est un pointeur vers la structure de données character_queue_t

Renvoie

un entier indiquant la taille de la file