libpurple/queuedoutputstream.c

changeset 41479
3d2e114380f6
parent 40265
03bafaff77dd
child 41685
ca22b00972d4
equal deleted inserted replaced
41478:27d70d93355d 41479:3d2e114380f6
22 */ 22 */
23 23
24 #include "internal.h" 24 #include "internal.h"
25 #include "queuedoutputstream.h" 25 #include "queuedoutputstream.h"
26 26
27 /**
28 * PurpleQueuedOutputStream:
29 *
30 * An implementation of #GFilterOutputStream which allows queuing data for
31 * output. This allows data to be queued while other data is being output.
32 * Therefore, data doesn't have to be manually stored while waiting for
33 * stream operations to finish.
34 *
35 * To create a queued output stream, use #purple_queued_output_stream_new().
36 *
37 * To queue data, use #purple_queued_output_stream_push_bytes_async().
38 *
39 * If there's a fatal stream error, it's suggested to clear the remaining
40 * bytes queued with #purple_queued_output_stream_clear_queue() to avoid
41 * excessive errors returned in
42 * #purple_queued_output_stream_push_bytes_async()'s async callback.
43 */
44 struct _PurpleQueuedOutputStream 27 struct _PurpleQueuedOutputStream
45 { 28 {
46 GFilterOutputStream parent; 29 GFilterOutputStream parent;
47 }; 30 };
48 31

mercurial