Mercurial > pidgin
comparison src/gaim_buffer.h @ 13229:cc84c3a2fe93
[gaim-migrate @ 15594]
Doco!
committer: Tailor Script <tailor@pidgin.im>
| author | Mark Doliner <mark@kingant.net> |
|---|---|
| date | Sat, 11 Feb 2006 18:55:04 +0000 |
| parents | 64bae3cbec8d |
| children | c9f536f771d0 |
comparison
equal
deleted
inserted
replaced
| 13228:dd1996c9f3b6 | 13229:cc84c3a2fe93 |
|---|---|
| 26 #ifdef __cplusplus | 26 #ifdef __cplusplus |
| 27 extern "C" { | 27 extern "C" { |
| 28 #endif | 28 #endif |
| 29 | 29 |
| 30 typedef struct _GaimCircBuffer { | 30 typedef struct _GaimCircBuffer { |
| 31 | |
| 32 /** A pointer to the starting address of our chunk of memory. */ | |
| 31 gchar *buffer; | 33 gchar *buffer; |
| 34 | |
| 35 /** The incremental amount to increase this buffer by when | |
| 36 * the buffer is not big enough to hold incoming data, in bytes. */ | |
| 32 gsize growsize; | 37 gsize growsize; |
| 38 | |
| 39 /** The length of this buffer, in bytes. */ | |
| 33 gsize buflen; | 40 gsize buflen; |
| 41 | |
| 42 /** The number of bytes of this buffer that contain unread data. */ | |
| 34 gsize bufused; | 43 gsize bufused; |
| 44 | |
| 45 /** A pointer to the next byte where new incoming data is | |
| 46 * buffered to. */ | |
| 35 gchar *inptr; | 47 gchar *inptr; |
| 48 | |
| 49 /** A pointer to the next byte of buffered data that should be | |
| 50 * by the consumer. */ | |
| 36 gchar *outptr; | 51 gchar *outptr; |
| 52 | |
| 37 } GaimCircBuffer; | 53 } GaimCircBuffer; |
| 38 | 54 |
| 39 /** | 55 /** |
| 40 * Creates a new circular buffer. This will not allocate any memory for the | 56 * Creates a new circular buffer. This will not allocate any memory for the |
| 41 * actual buffer until data is appended to it. | 57 * actual buffer until data is appended to it. |
