libpurple/queuedoutputstream.h

changeset 41479
3d2e114380f6
parent 41199
72afb5d62f12
child 41686
9bcd6ad114eb
--- a/libpurple/queuedoutputstream.h	Tue Aug 02 00:20:10 2022 -0500
+++ b/libpurple/queuedoutputstream.h	Tue Aug 02 02:02:46 2022 -0500
@@ -42,9 +42,19 @@
 /**
  * PurpleQueuedOutputStream:
  *
- * A #PurpleQueuedOutputStream is a #GOutputStream which allows data to be
- * queued for outputting. It differs from a #GBufferedOutputStream in that
- * it allows for data to be queued while other operations are in progress.
+ * An implementation of #GFilterOutputStream which allows queuing data for
+ * output. This allows data to be queued while other data is being output.
+ * Therefore, data doesn't have to be manually stored while waiting for
+ * stream operations to finish.
+ *
+ * To create a queued output stream, use [ctor@QueuedOutputStream.new].
+ *
+ * To queue data, use [method@QueuedOutputStream.push_bytes_async].
+ *
+ * If there's a fatal stream error, it's suggested to clear the remaining bytes
+ * queued with [method@QueuedOutputStream.clear_queue] to avoid excessive
+ * errors returned in [method@QueuedOutputStream.push_bytes_async]'s async
+ * callback.
  */
 G_DECLARE_FINAL_TYPE(PurpleQueuedOutputStream,
 		purple_queued_output_stream, PURPLE,

mercurial