Changeset 74077 in vbox for trunk

Timestamp:

Sep 5, 2018 9:05:45 AM (6 years ago)

Author:

vboxsync

Message:

IPRT/http: document download progress callback. bugref:9167

Location:

trunk

Files:

• include/iprt/http.h (modified) (2 diffs)
• src/VBox/Runtime/generic/http-curl.cpp (modified) (1 diff)

trunk/include/iprt/http.h

@@ -44 +44 @@
 /** Nil HTTP/HTTPS client handle. */
 #define NIL_RTHTTP                              ((RTHTTP)0)
-/** Callback function to be called during RTHttpGet*(). Register it using RTHttpSetDownloadProgressCallback(). */
-typedef DECLCALLBACK(void) FNRTHTTPDOWNLDPROGRCALLBACK(RTHTTP hHttp, void *pvUser, uint64_t cbDownloadTotal, uint64_t cbDownloaded);
-typedef FNRTHTTPDOWNLDPROGRCALLBACK *PFNRTHTTPDOWNLDPROGRCALLBACK;
-
 
 
@@ -413 +409 @@
 
 /**
+ * Callback function to be called during RTHttpGet*().
+ *
+ * Register it using RTHttpSetDownloadProgressCallback().
+ *
+ * @param   hHttp           The HTTP client handle.
+ * @param   pvUser          The user parameter specified when registering the callback.
+ * @param   cbDowloadTotal  The content-length value, if available.
+ *                          Warning! Not entirely clear what it will be if
+ *                                   unavailable, probably 0.
+ * @param   cbDowloaded     How much was downloaded thus far.
+ */
+typedef DECLCALLBACK(void) FNRTHTTPDOWNLDPROGRCALLBACK(RTHTTP hHttp, void *pvUser, uint64_t cbDownloadTotal, uint64_t cbDownloaded);
+/** Pointer to a download progress callback. */
+typedef FNRTHTTPDOWNLDPROGRCALLBACK *PFNRTHTTPDOWNLDPROGRCALLBACK;
+
+/**
  * Set a callback function which is called during RTHttpGet*()
  *
  * @returns IPRT status code.
  * @param   hHttp           The HTTP client handle.
- * @param   pfnDownloadProgress Progress function to be called. Set it to
+ * @param   pfnCallback     Progress function to be called. Set it to
  *                          NULL to disable the callback.
  * @param   pvUser          Convenience pointer for the callback function.
  */
-RTR3DECL(int) RTHttpSetDownloadProgressCallback(RTHTTP hHttp, PFNRTHTTPDOWNLDPROGRCALLBACK pfnDownloadProgress, void *pvUser);
+RTR3DECL(int) RTHttpSetDownloadProgressCallback(RTHTTP hHttp, PFNRTHTTPDOWNLDPROGRCALLBACK pfnCallback, void *pvUser);
 
 

trunk/src/VBox/Runtime/generic/http-curl.cpp

@@ -3355 +3355 @@
 *********************************************************************************************************************************/
 
-RTR3DECL(int) RTHttpSetDownloadProgressCallback(RTHTTP hHttp, PFNRTHTTPDOWNLDPROGRCALLBACK pfnDownloadProgress, void *pvUser)
+RTR3DECL(int) RTHttpSetDownloadProgressCallback(RTHTTP hHttp, PFNRTHTTPDOWNLDPROGRCALLBACK pfnCallback, void *pvUser)
 {
     PRTHTTPINTERNAL pThis = hHttp;
     RTHTTP_VALID_RETURN(pThis);
 
-    pThis->pfnDownloadProgress = pfnDownloadProgress;
+    pThis->pfnDownloadProgress    = pfnCallback;
     pThis->pvDownloadProgressUser = pvUser;
     return VINF_SUCCESS;
 }
-