circbuffer.h
Go to the documentation of this file.
/* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _CIRCBUFFER_H
#define _CIRCBUFFER_H
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct _PurpleCircBuffer {
gchar *buffer;
gsize growsize;
gsize buflen;
gsize bufused;
gchar *inptr;
gchar *outptr;
} PurpleCircBuffer;
PurpleCircBuffer *purple_circ_buffer_new(gsize growsize);
void purple_circ_buffer_destroy(PurpleCircBuffer *buf);
void purple_circ_buffer_append(PurpleCircBuffer *buf, gconstpointer src, gsize len);
gsize purple_circ_buffer_get_max_read(const PurpleCircBuffer *buf);
gboolean purple_circ_buffer_mark_read(PurpleCircBuffer *buf, gsize len);
#ifdef __cplusplus
}
#endif
#endif /* _CIRCBUFFER_H */
purple_circ_buffer_new
PurpleCircBuffer * purple_circ_buffer_new(gsize growsize)
Creates a new circular buffer.
purple_circ_buffer_append
void purple_circ_buffer_append(PurpleCircBuffer *buf, gconstpointer src, gsize len)
Append data to the PurpleCircBuffer.
purple_circ_buffer_destroy
void purple_circ_buffer_destroy(PurpleCircBuffer *buf)
Dispose of the PurpleCircBuffer and free any memory used by it (including any memory used by the inte...
purple_circ_buffer_mark_read
gboolean purple_circ_buffer_mark_read(PurpleCircBuffer *buf, gsize len)
Mark the number of bytes that have been read from the buffer.
purple_circ_buffer_get_max_read
gsize purple_circ_buffer_get_max_read(const PurpleCircBuffer *buf)
Determine the maximum number of contiguous bytes that can be read from the PurpleCircBuffer.
_PurpleCircBuffer
Definition: circbuffer.h:33
_PurpleCircBuffer::growsize
gsize growsize
The incremental amount to increase this buffer by when the buffer is not big enough to hold incoming ...
Definition: circbuffer.h:40
_PurpleCircBuffer::inptr
gchar * inptr
A pointer to the next byte where new incoming data is buffered to.
Definition: circbuffer.h:50
_PurpleCircBuffer::buflen
gsize buflen
The length of this buffer, in bytes.
Definition: circbuffer.h:43
_PurpleCircBuffer::buffer
gchar * buffer
A pointer to the starting address of our chunk of memory.
Definition: circbuffer.h:36
_PurpleCircBuffer::bufused
gsize bufused
The number of bytes of this buffer that contain unread data.
Definition: circbuffer.h:46
_PurpleCircBuffer::outptr
gchar * outptr
A pointer to the next byte of buffered data that should be read by the consumer.
Definition: circbuffer.h:54