closing merged branch
16 months ago, Gary Kramlich
closing merged branch
/* 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
* 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
* SECTION:circularbuffer
* @section_id: libpurple-circularbuffer
* @short_description: <filename>circularbuffer.h</filename>
* @title: Buffer Utility Functions
#include <glib.h>
#include <glib-object.h>
#define PURPLE_TYPE_CIRCULAR_BUFFER (purple_circular_buffer_get_type())
G_DECLARE_DERIVABLE_TYPE(PurpleCircularBuffer, purple_circular_buffer, PURPLE,
struct _PurpleCircularBufferClass {
/*< private >*/
GObjectClass parent;
void (*grow)(PurpleCircularBuffer *buffer, gsize len);
void (*append)(PurpleCircularBuffer *buffer, gconstpointer src, gsize len);
gsize (*max_read_size)(PurpleCircularBuffer *buffer);
gboolean (*mark_read)(PurpleCircularBuffer *buffer, gsize len);
void (*purple_reserved1)(void);
void (*purple_reserved2)(void);
void (*purple_reserved3)(void);
void (*purple_reserved4)(void);
* purple_circular_buffer_new:
* @growsize: The amount that the buffer should grow the first time data
* is appended and every time more space is needed. Pass in
* "0" to use the default of 256 bytes.
* Creates a new circular buffer. This will not allocate any memory for the
* actual buffer until data is appended to it.
* Returns: The new PurpleCircularBuffer.
PurpleCircularBuffer *purple_circular_buffer_new(gsize growsize);
* purple_circular_buffer_append:
* @buffer: The PurpleCircularBuffer to which to append the data
* @src: pointer to the data to copy into the buffer
* @len: number of bytes to copy into the buffer
* Append data to the PurpleCircularBuffer. This will grow the internal
* buffer to fit the added data, if needed.
void purple_circular_buffer_append(PurpleCircularBuffer *buffer, gconstpointer src, gsize len);
* purple_circular_buffer_get_max_read:
* @buffer: the PurpleCircularBuffer for which to determine the maximum
* contiguous bytes that can be read.
* Determine the maximum number of contiguous bytes that can be read from the
* PurpleCircularBuffer.
* Note: This may not be the total number of bytes that are buffered - a
* subsequent call after calling purple_circular_buffer_mark_read() may indicate
* more data is available to read.
* Returns: the number of bytes that can be read from the PurpleCircularBuffer
gsize purple_circular_buffer_get_max_read(PurpleCircularBuffer *buffer);
* purple_circular_buffer_mark_read:
* @buffer: The PurpleCircularBuffer to mark bytes read from
* @len: The number of bytes to mark as read
* Mark the number of bytes that have been read from the buffer.
* Returns: TRUE if we successfully marked the bytes as having been read, FALSE
* otherwise.
gboolean purple_circular_buffer_mark_read(PurpleCircularBuffer *buffer, gsize len);
* purple_circular_buffer_grow:
* @buffer: The PurpleCircularBuffer to grow.
* @len: The number of bytes the buffer should be able to hold.
* Increases the buffer size by a multiple of grow size, so that it can hold at
* least 'len' bytes.
void purple_circular_buffer_grow(PurpleCircularBuffer *buffer, gsize len);
* purple_circular_buffer_get_grow_size:
* @buffer: The PurpleCircularBuffer from which to get grow size.
* Returns the number of bytes by which the buffer grows when more space is
* needed.
* Returns: The grow size of the buffer.
gsize purple_circular_buffer_get_grow_size(PurpleCircularBuffer *buffer);
* purple_circular_buffer_get_used:
* @buffer: The PurpleCircularBuffer from which to get used count.
* Returns the number of bytes of this buffer that contain unread data.
* Returns: The number of bytes that contain unread data.
gsize purple_circular_buffer_get_used(PurpleCircularBuffer *buffer);
* purple_circular_buffer_get_output:
* @buffer: The PurpleCircularBuffer from which to get the output pointer.
* Returns the output pointer of the buffer, where unread data is available.
* Use purple_circular_buffer_get_max_read() to determine the number of
* contiguous bytes that can be read from this output. After reading the data,
* call purple_circular_buffer_mark_read() to mark the retrieved data as read.
* Returns: The output pointer for the buffer.
const gchar *purple_circular_buffer_get_output(PurpleCircularBuffer *buffer);
* purple_circular_buffer_reset:
* @buffer: The PurpleCircularBuffer to reset.
* Resets the buffer input and output pointers to the start of the buffer.
void purple_circular_buffer_reset(PurpleCircularBuffer *buffer);