d4/dee/tlccirc__buf__inf_8h_source.html

/*

** EPITECH PROJECT, 2023

** MyTeams

** File description:

** circular buffer lib

*/


#ifndef CIRCULAR_BUFFER_INF_H_

    #define CIRCULAR_BUFFER_INF_H_


    #include <stddef.h>

    #include <stdbool.h>

    #include "tlcllists.h"


struct circ_buf_inf_s {

    list_t *buffer;

    const char *end_pattern;

};

typedef struct circ_buf_inf_s circ_buf_inf_t;


circ_buf_inf_t *

circ_buf_inf_create(const char *end_pattern);


void circ_buf_inf_destroy(circ_buf_inf_t *buffer);


void circ_buf_inf_write(circ_buf_inf_t *buffer, const char *str);


char *circ_buf_inf_read(circ_buf_inf_t *buffer);


char *circ_buf_inf_read_multiple(circ_buf_inf_t *buffer);


bool circ_buf_inf_is_empty(circ_buf_inf_t *buffer);


bool circ_buf_inf_is_read_ready(circ_buf_inf_t *buffer);


#endif

circ_buf_inf_s
Definition tlccirc_buf_inf.h:15

circ_buf_inf_s::buffer
list_t * buffer
Definition tlccirc_buf_inf.h:16

circ_buf_inf_s::end_pattern
const char * end_pattern
Definition tlccirc_buf_inf.h:17

circ_buf_inf_read_multiple
char * circ_buf_inf_read_multiple(circ_buf_inf_t *buffer)
read a char* from the circular buffer until last end_pattern

circ_buf_inf_create
circ_buf_inf_t * circ_buf_inf_create(const char *end_pattern)
create a circular buffer

circ_buf_inf_destroy
void circ_buf_inf_destroy(circ_buf_inf_t *buffer)
destroy a circular buffer

circ_buf_inf_write
void circ_buf_inf_write(circ_buf_inf_t *buffer, const char *str)
add a char* to the circular buffer

circ_buf_inf_is_empty
bool circ_buf_inf_is_empty(circ_buf_inf_t *buffer)
check if circular buffer is empty

circ_buf_inf_read
char * circ_buf_inf_read(circ_buf_inf_t *buffer)
read a char* from the circular buffer

circ_buf_inf_is_read_ready
bool circ_buf_inf_is_read_ready(circ_buf_inf_t *buffer)
check if circular buffer is ready to read (=> end_pattern'ed)

tlcllists.h