[glib] Document GOutputVector and GInputVector
- From: Alexander Larsson <alexl src gnome org>
- To: svn-commits-list gnome org
- Subject: [glib] Document GOutputVector and GInputVector
- Date: Tue, 19 May 2009 09:32:03 -0400 (EDT)
commit 03441e724a6b6d0b115fa5b2d9fbeefaa1fd2faa
Author: Alexander Larsson <alexl redhat com>
Date: Tue May 19 11:27:07 2009 +0200
Document GOutputVector and GInputVector
---
docs/reference/gio/gio-sections.txt | 2 ++
gio/giotypes.h | 23 +++++++++++++++++------
2 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index 155a868..f595a2f 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -1632,6 +1632,8 @@ GSocket
GSocketSourceFunc
GSocketType
GSocketMsgFlags
+GInputVector
+GOutputVector
g_socket_new
g_socket_new_from_fd
g_socket_bind
diff --git a/gio/giotypes.h b/gio/giotypes.h
index 7b386e7..a54f52d 100644
--- a/gio/giotypes.h
+++ b/gio/giotypes.h
@@ -290,29 +290,40 @@ typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
/**
* GInputVector:
+ * @buffer: Pointer to a buffer where data will be written.
+ * @size: the availible size in @buffer.
*
* Structure used for scatter/gather data input.
+ * You generally pass in an array of #GInputVector<!-- -->s and the operation
+ * will store the read data starting in the first buffer, switching to
+ * the next as needed.
*
* Since: 2.22
*/
-typedef struct
-{
+typedef struct _GInputVector GInputVector;
+
+struct _GInputVector {
gpointer buffer;
gsize size;
-} GInputVector;
+};
/**
* GOutputVector:
+ * @buffer: Pointer to a buffer of data to read.
+ * @size: the size of @buffer.
*
* Structure used for scatter/gather data output.
+ * You generally pass in an array of #GOutputVector<!-- -->s and the operation
+ * will use all the buffers as if they were one buffer.
*
* Since: 2.22
*/
-typedef struct
-{
+typedef struct _GOutputVector GOutputVector;
+
+struct _GOutputVector {
gconstpointer buffer;
gsize size;
-} GOutputVector;
+};
G_END_DECLS
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]