Changeset 87042 in vbox for trunk/include/iprt

Timestamp:

Dec 4, 2020 12:10:36 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

141732

Message:

Shared Clipboard/Transfers: More cleanup / documentation work. bugref:9874

Location:

trunk/include/iprt

Files:

• http-common.h (modified) (1 diff)
• http-server.h (modified) (2 diffs)

trunk/include/iprt/http-common.h

@@ -169 +169 @@
 
 /**
+ * Structure for maintaining a HTTP body.
+ */
+typedef struct RTHTTPBODY
+{
+    /** Body to send, if any. Can be NULL. */
+    void            *pvBody;
+    /** Body allocation size (in bytes). */
+    size_t           cbBodyAlloc;
+    /** How much body data is being used (in bytes). */
+    size_t           cbBodyUsed;
+    /** Current body data read/write offset (in bytes). */
+    size_t           offBody;
+} RTHTTPBODY;
+/** Pointer to a HTTP body. */
+typedef RTHTTPBODY *PRTHTTPBODY;
+
+/**
  * Returns the name of the HTTP method.
  * @returns Read only string.

trunk/include/iprt/http-server.h

@@ -55 +55 @@
 typedef struct RTHTTPSERVERREQ
 {
+    /** Request URL. */
     char            *pszUrl;
+    /** Request method. */
     RTHTTPMETHOD     enmMethod;
+    /** Request header list. */
     RTHTTPHEADERLIST hHdrLst;
-    void            *pvBody;
-    size_t           cbBodyAlloc;
-    size_t           cbBodyUsed;
+    /** Request body data. */
+    RTHTTPBODY       Body;
 } RTHTTPSERVERREQ;
 /** Pointer to a HTTP client request. */
@@ -70 +72 @@
 typedef struct RTHTTPSERVERRESP
 {
+    /** HTTP status to send. */
     RTHTTPSTATUS     enmSts;
+    /** List of headers to send. */
     RTHTTPHEADERLIST hHdrLst;
-    void            *pvBody;
-    size_t           cbBodyAlloc;
-    size_t           cbBodyUsed;
+    /** Body data to send. */
+    RTHTTPBODY       Body;
 } RTHTTPSERVERRESP;
 /** Pointer to a HTTP server response. */