pidgin  2.14.10
circbuffer.h
Go to the documentation of this file.
1 
6 /* Purple is the legal property of its developers, whose names are too numerous
7  * to list here. Please refer to the COPYRIGHT file distributed with this
8  * source distribution.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
23  */
24 #ifndef _CIRCBUFFER_H
25 #define _CIRCBUFFER_H
26 
27 #include <glib.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 typedef struct _PurpleCircBuffer {
34 
36  gchar *buffer;
37 
40  gsize growsize;
41 
43  gsize buflen;
44 
46  gsize bufused;
47 
50  gchar *inptr;
51 
54  gchar *outptr;
55 
57 
70 
78 
87 void purple_circ_buffer_append(PurpleCircBuffer *buf, gconstpointer src, gsize len);
88 
102 
113 
114 #ifdef __cplusplus
115 }
116 #endif
117 
118 #endif /* _CIRCBUFFER_H */
PurpleCircBuffer * purple_circ_buffer_new(gsize growsize)
Creates a new circular buffer.
void purple_circ_buffer_append(PurpleCircBuffer *buf, gconstpointer src, gsize len)
Append data to the PurpleCircBuffer.
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...
gboolean purple_circ_buffer_mark_read(PurpleCircBuffer *buf, gsize len)
Mark the number of bytes that have been read from the buffer.
gsize purple_circ_buffer_get_max_read(const PurpleCircBuffer *buf)
Determine the maximum number of contiguous bytes that can be read from the PurpleCircBuffer.
gsize growsize
The incremental amount to increase this buffer by when the buffer is not big enough to hold incoming ...
Definition: circbuffer.h:40
gchar * inptr
A pointer to the next byte where new incoming data is buffered to.
Definition: circbuffer.h:50
gsize buflen
The length of this buffer, in bytes.
Definition: circbuffer.h:43
gchar * buffer
A pointer to the starting address of our chunk of memory.
Definition: circbuffer.h:36
gsize bufused
The number of bytes of this buffer that contain unread data.
Definition: circbuffer.h:46
gchar * outptr
A pointer to the next byte of buffered data that should be read by the consumer.
Definition: circbuffer.h:54