Changeset 104305 in vbox

Timestamp:

Apr 12, 2024 8:29:33 AM (9 months ago)

Author:

vboxsync

Message:

Shared Clipboard/transfers-http: Docs, made some functions inline. bugref:9437

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers-http.cpp (modified) (8 diffs)

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers-http.cpp

@@ -227 +227 @@
  * @param   idTransfer          Transfer ID to return HTTP server transfer for.
  */
-static PSHCLHTTPSERVERTRANSFER shClTransferHttpServerGetTransferById(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer)
+DECLINLINE(PSHCLHTTPSERVERTRANSFER) shClTransferHttpServerGetTransferById(PSHCLHTTPSERVER pSrv, SHCLTRANSFERID idTransfer)
 {
     PSHCLHTTPSERVERTRANSFER pSrvTx;
@@ -527 +527 @@
                                          pEntry->pszName, pEntry->fInfo, pEntry->cbInfo));
                         }
+                        /* Note: Directories are not supported here (yet) -- would require using WebDAV. */
                     }
 
@@ -721 +722 @@
 
 /**
- * Translates a Shared Clipboard HTTP server status to a string.
- *
- * @returns Status as a string.
- * @param   uMsg                Status to translate.
- */
-static const char *shClTransferHttpServerStatusToStr(SHCLHTTPSERVERSTATUS enmStatus)
+ * Returns a Shared Clipboard HTTP server status as a string.
+ *
+ * @returns Status as a string, or "Unknown" if invalid / unknown.
+ * @param   enmStatus           HTTP server status to return as a string.
+ */
+DECLINLINE(const char *) shClTransferHttpServerStatusToStr(SHCLHTTPSERVERSTATUS enmStatus)
 {
     switch (enmStatus)
@@ -890 +891 @@
  * @returns VBox status code.
  * @param   pSrv                HTTP server instance to unregister transfer from.
- * @param   pTransfer           Server transfer to destroy
+ * @param   pSrvTx              HTTP server transfer to destroy.
  *                              The pointer will be invalid on success.
  *
@@ -1249 +1250 @@
  *
  * @returns VBox status code.
- * @param   pHttpSrv            HTTP server that contains the transfer.
+ * @param   pSrv                HTTP server that contains the transfer.
  * @param   pTransfer           Transfer to convert data from.
  * @param   pszSep              Separator to use for the transfer entries.
@@ -1302 +1303 @@
  *
  * @returns VBox status code.
- * @param   pHttpSrv            HTTP server that contains the transfer.
+ * @param   pSrv                HTTP server that contains the transfer.
  * @param   pTransfer           Transfer to convert data from.
  * @param   ppszData            Where to store the string list on success.
@@ -1342 +1343 @@
 
 /**
- * Waits for a status change.
+ * Waits for a server status change.
  *
  * @returns VBox status code.
@@ -1444 +1445 @@
     return rc;
 }
-