|
Packit |
4e8bc4 |
#ifndef BIPBUFFER_H
|
|
Packit |
4e8bc4 |
#define BIPBUFFER_H
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
typedef struct
|
|
Packit |
4e8bc4 |
{
|
|
Packit |
4e8bc4 |
unsigned long int size;
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/* region A */
|
|
Packit |
4e8bc4 |
unsigned int a_start, a_end;
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/* region B */
|
|
Packit |
4e8bc4 |
unsigned int b_end;
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/* is B inuse? */
|
|
Packit |
4e8bc4 |
int b_inuse;
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
unsigned char data[];
|
|
Packit |
4e8bc4 |
} bipbuf_t;
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Create a new bip buffer.
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* malloc()s space
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* @param[in] size The size of the buffer */
|
|
Packit |
4e8bc4 |
bipbuf_t *bipbuf_new(const unsigned int size);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Initialise a bip buffer. Use memory provided by user.
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* No malloc()s are performed.
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* @param[in] size The size of the array */
|
|
Packit |
4e8bc4 |
void bipbuf_init(bipbuf_t* me, const unsigned int size);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Free the bip buffer */
|
|
Packit |
4e8bc4 |
void bipbuf_free(bipbuf_t *me);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/* TODO: DOCUMENTATION */
|
|
Packit |
4e8bc4 |
unsigned char *bipbuf_request(bipbuf_t* me, const int size);
|
|
Packit |
4e8bc4 |
int bipbuf_push(bipbuf_t* me, const int size);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* @param[in] data The data to be offered to the buffer
|
|
Packit |
4e8bc4 |
* @param[in] size The size of the data to be offered
|
|
Packit |
4e8bc4 |
* @return number of bytes offered */
|
|
Packit |
4e8bc4 |
int bipbuf_offer(bipbuf_t *me, const unsigned char *data, const int size);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Look at data. Don't move cursor
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* @param[in] len The length of the data to be peeked
|
|
Packit |
4e8bc4 |
* @return data on success, NULL if we can't peek at this much data */
|
|
Packit |
4e8bc4 |
unsigned char *bipbuf_peek(const bipbuf_t* me, const unsigned int len);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Look at data. Don't move cursor
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* @param[in] len The length of the data returned
|
|
Packit |
4e8bc4 |
* @return data on success, NULL if nothing available */
|
|
Packit |
4e8bc4 |
unsigned char *bipbuf_peek_all(const bipbuf_t* me, unsigned int *len);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* Get pointer to data to read. Move the cursor on.
|
|
Packit |
4e8bc4 |
*
|
|
Packit |
4e8bc4 |
* @param[in] len The length of the data to be polled
|
|
Packit |
4e8bc4 |
* @return pointer to data, NULL if we can't poll this much data */
|
|
Packit |
4e8bc4 |
unsigned char *bipbuf_poll(bipbuf_t* me, const unsigned int size);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* @return the size of the bipbuffer */
|
|
Packit |
4e8bc4 |
int bipbuf_size(const bipbuf_t* me);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* @return 1 if buffer is empty; 0 otherwise */
|
|
Packit |
4e8bc4 |
int bipbuf_is_empty(const bipbuf_t* me);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* @return how much space we have assigned */
|
|
Packit |
4e8bc4 |
int bipbuf_used(const bipbuf_t* cb);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
/**
|
|
Packit |
4e8bc4 |
* @return bytes of unused space */
|
|
Packit |
4e8bc4 |
int bipbuf_unused(const bipbuf_t* me);
|
|
Packit |
4e8bc4 |
|
|
Packit |
4e8bc4 |
#endif /* BIPBUFFER_H */
|