Changeset 99937 in vbox for trunk/include/iprt/http-server.h

Timestamp:

May 23, 2023 3:38:52 PM (19 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added new testcase for the HTTP server in combination with the Shared Clipboard API, various updates and general improvements. bugref:9437

File:

• trunk/include/iprt/http-server.h (modified) (6 diffs)

trunk/include/iprt/http-server.h

@@ -73 +73 @@
     /** Request body data. */
     RTHTTPBODY       Body;
+    /** User-supplied (opaque) pointer.
+     *  Can be used for faster lookups between callbacks. */
+    void            *pvUser;
 } RTHTTPSERVERREQ;
 /** Pointer to a HTTP client request. */
@@ -134 +137 @@
 {
     /**
-     * Called before a given URL will be retrieved by the GET method.
+     * Called before beginning to process a request. Guaranteed.
+     *
+     * @returns VBox status code.
+     * @param   pData           Pointer to HTTP callback data.
+     * @param   pReq            Pointer to request to handle.
+     */
+    DECLCALLBACKMEMBER(int, pfnRequestBegin,(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq));
+    /**
+     * Called after processing a request. Guaranteed.
+     *
+     * @returns VBox status code.
+     * @param   pData           Pointer to HTTP callback data.
+     * @param   pReq            Pointer to request to handle.
+     */
+    DECLCALLBACKMEMBER(int, pfnRequestEnd,(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq));
+    /**
+     * Opens a resource for a GET request.
+     *
+     * Will be called as as a second function for a GET request.
      *
      * Note: High level function, not being called when pfnOnGetRequest is implemented.
@@ -145 +166 @@
     DECLCALLBACKMEMBER(int, pfnOpen,(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq, void **ppvHandle));
     /**
-     * Called when a given URL will be retrieved by the GET method.
+     * Reads a resource for a GET request.
      *
      * Note:  High level function, not being called when pfnOnGetRequest is implemented.
@@ -152 +173 @@
      * @returns VBox status code.
      * @param   pData           Pointer to HTTP callback data.
+     * @param   pReq            Pointer to request to handle.
      * @param   pvHandle        Opaque handle for object identification.
      * @param   pvBuf           Pointer to buffer where to store the read data.
@@ -157 +179 @@
      * @param   pcbRead         Where to return the amount (in bytes) of read data. Optional and can be NULL.
      */
-    DECLCALLBACKMEMBER(int, pfnRead,(PRTHTTPCALLBACKDATA pData, void *pvHandle, void *pvBuf, size_t cbBuf, size_t *pcbRead));
-    /**
-     * Called when a given URL is done retrieving by the GET method.
+    DECLCALLBACKMEMBER(int, pfnRead,(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq, void *pvHandle, void *pvBuf, size_t cbBuf, size_t *pcbRead));
+    /**
+     * Closes a resouce for a GET a request.
      *
      * Note: High level function, not being called when pfnOnGetRequest is implemented.
@@ -165 +187 @@
      * @returns VBox status code.
      * @param   pData           Pointer to HTTP callback data.
-     * @param   pszUrl          URL to handle.
+     * @param   pReq            Pointer to request to handle.
      * @param   pvHandle        Opaque handle for object identification.
      */
-    DECLCALLBACKMEMBER(int, pfnClose,(PRTHTTPCALLBACKDATA pData, void *pvHandle));
+    DECLCALLBACKMEMBER(int, pfnClose,(PRTHTTPCALLBACKDATA pData, PRTHTTPSERVERREQ pReq, void *pvHandle));
     /**
      * Queries information about a given URL.
      *
-     * Will be called with GET or HEAD request.
+     * Will be called as first function for a GET or HEAD request.
+     *
+     * Note: High level function, not being called when pfnOnGetRequest is implemented.*
      *
      * @returns VBox status code.