Changeset 74060 in vbox for trunk/include/iprt

Timestamp:

Sep 4, 2018 9:28:28 AM (6 years ago)

Author:

vboxsync

Message:

IPRT/http: s/RTHttpAppend/RTHttpAdd/[Raw]Header, defining FRONT and BACK flags. bugref:9167

File:

• trunk/include/iprt/http.h (modified) (2 diffs)

trunk/include/iprt/http.h

@@ -294 +294 @@
 RTR3DECL(int) RTHttpSetHeaders(RTHTTP hHttp, size_t cHeaders, const char * const *papszHeaders);
 
-/**
- * Appends a raw header.
+/** @name RTHTTPADDHDR_F_XXX - Flags for RTHttpAddRawHeader and RTHttpAddHeader
+ * @{ */
+#define RTHTTPADDHDR_F_BACK     UINT32_C(0) /**< Append the header. */
+#define RTHTTPADDHDR_F_FRONT    UINT32_C(1) /**< Prepend the header. */
+/** @} */
+
+/**
+ * Adds a raw header.
  *
  * @returns IPRT status code.
  * @param   hHttp           The HTTP client handle.
  * @param   pszHeader       Header string on the form "foo: bar".
- */
-RTR3DECL(int) RTHttpAppendRawHeader(RTHTTP hHttp, const char *pszHeader);
-
-/**
- * Appends a header field and value.
+ * @param   fFlags          RTHTTPADDHDR_F_FRONT or RTHTTPADDHDR_F_BACK.
+ */
+RTR3DECL(int) RTHttpAddRawHeader(RTHTTP hHttp, const char *pszHeader, uint32_t fFlags);
+
+/**
+ * Adds a header field and value.
  *
  * @returns IPRT status code.
@@ -310 +317 @@
  * @param   pszField        The header field name.
  * @param   pszValue        The header field value.
- * @param   fFlags          Flags reserved for controlling encoding, MBZ.
- */
-RTR3DECL(int) RTHttpAppendHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags);
+ * @param   fFlags          Only RTHTTPADDHDR_F_FRONT or RTHTTPADDHDR_F_BACK,
+ *                          may be extended with encoding controlling flags if
+ *                          needed later.
+ */
+RTR3DECL(int) RTHttpAddHeader(RTHTTP hHttp, const char *pszField, const char *pszValue, uint32_t fFlags);
 
 /**