[PATCH 14/22] gweb: Document 'struct _GWebResult'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <2a78dc5c6e943f96271f4a49f1d0b02120167fbc.1741050622.git.gerickson@nuovations.com> |
Add documentation to the remainder of the 'struct _GWebResult' data
members and to the overall structure.
---
gweb/gweb.c | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index c7af3986df8f..050bb2d3e134 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -54,6 +54,12 @@ enum chunk_state {
CHUNK_DATA,
};
+/**
+ * The opaque structure presented to GWeb clients on received data or
+ * request closures.
+ *
+ * @private
+ */
struct _GWebResult {
/**
* Operating system error, if any, associated with the request.
@@ -62,11 +68,38 @@ struct _GWebResult {
* domain error number).
*/
int err;
+
+ /**
+ * HTTP status code on success.
+ */
guint16 status;
+
+ /**
+ * HTTP body content on success; otherwise, NULL.
+ */
const guint8 *buffer;
+
+ /**
+ * HTTP body length on success; otherwise, 0.
+ */
gsize length;
+
+ /**
+ * Boolean indicating whether the HTTP response uses HTTP/1.1
+ * chunked transfer encoding.
+ */
bool use_chunk;
+
+ /**
+ * An optional pointer to a null-terminated C string containing
+ * the last HTTP header name added as part of a header key/value
+ * pair.
+ */
gchar *last_key;
+
+ /**
+ * HTTP headers, on success, keyed by the header name.
+ */
GHashTable *headers;
};
--
2.45.0