Changeset 94702 in vbox for trunk/src/VBox/Main

Timestamp:

Apr 25, 2022 8:12:05 AM (3 years ago)

Author:

vboxsync

Message:

Main/Update check: Docs, renaming. ​​bugref:7983

Location:

trunk/src/VBox/Main

Files:

• include/UpdateAgentImpl.h (modified) (2 diffs)
• src-server/UpdateAgentImpl.cpp (modified) (11 diffs)

trunk/src/VBox/Main/include/UpdateAgentImpl.h

@@ -68 +68 @@
      * @{ */
     friend UpdateAgentTask;
-    virtual DECLCALLBACK(HRESULT) i_updateTask(UpdateAgentTask *pTask) = 0;
+    virtual DECLCALLBACK(HRESULT) i_checkForUpdateTask(UpdateAgentTask *pTask) = 0;
     /** @} */
 
@@ -191 +191 @@
     HRESULT checkFor(ComPtr<IProgress> &aProgress);
 
-    DECLCALLBACK(HRESULT) i_updateTask(UpdateAgentTask *pTask);
+    DECLCALLBACK(HRESULT) i_checkForUpdateTask(UpdateAgentTask *pTask);
     /** @}  */
 

trunk/src/VBox/Main/src-server/UpdateAgentImpl.cpp

@@ -50 +50 @@
 *********************************************************************************************************************************/
 
+/**
+ * Base task class for asynchronous update agent tasks.
+ */
 class UpdateAgentTask : public ThreadTask
 {
@@ -77 +80 @@
     AssertPtr(pUpdateAgent);
 
-    HRESULT rc = pUpdateAgent->i_updateTask(this);
+    /** @todo Differentiate tasks once we have more stuff to do (downloading, installing, ++). */
+
+    HRESULT rc = pUpdateAgent->i_checkForUpdateTask(this);
 
     if (!m_pProgress.isNull())
@@ -90 +95 @@
 *********************************************************************************************************************************/
 
+/**
+ * Returns platform information as a string.
+ *
+ * @returns HRESULT
+ */
 /* static */
 Utf8Str UpdateAgentBase::i_getPlatformInfo(void)
@@ -606 +616 @@
 *********************************************************************************************************************************/
 
+/**
+ * Loads the settings of the update agent base class.
+ *
+ * @returns HRESULT
+ * @param   data                Where to load the settings from.
+ */
 HRESULT UpdateAgent::i_loadSettings(const settings::UpdateAgent &data)
 {
@@ -625 +641 @@
 }
 
+/**
+ * Saves the settings of the update agent base class.
+ *
+ * @returns HRESULT
+ * @param   data                Where to save the settings to.
+ */
 HRESULT UpdateAgent::i_saveSettings(settings::UpdateAgent &data)
 {
@@ -637 +659 @@
 }
 
+/**
+ * Sets the update check count.
+ *
+ * @returns HRESULT
+ * @param   aCount              Update check count to set.
+ */
 HRESULT UpdateAgent::i_setCheckCount(ULONG aCount)
 {
@@ -649 +677 @@
 }
 
+/**
+ * Sets the last update check date.
+ *
+ * @returns HRESULT
+ * @param   aDate               Last update check date to set.
+ *                              Must be in ISO 8601 format (e.g. 2020-05-11T21:13:39.348416000Z).
+ */
 HRESULT UpdateAgent::i_setLastCheckDate(const com::Utf8Str &aDate)
 {
@@ -660 +695 @@
     return i_commitSettings(alock);
 }
-
 
 /**
@@ -723 +757 @@
 }
 
-void HostUpdateAgent::uninit()
+void HostUpdateAgent::uninit(void)
 {
     // Enclose the state transition Ready->InUninit->NotReady.
@@ -762 +796 @@
 *********************************************************************************************************************************/
 
-DECLCALLBACK(HRESULT) HostUpdateAgent::i_updateTask(UpdateAgentTask *pTask)
+/**
+ * Task callback to perform an update check for the VirtualBox host (core).
+ *
+ * @returns HRESULT
+ * @param   pTask               Associated update agent task to use.
+ */
+DECLCALLBACK(HRESULT) HostUpdateAgent::i_checkForUpdateTask(UpdateAgentTask *pTask)
 {
     RT_NOREF(pTask);
@@ -862 +902 @@
 }
 
+/**
+ * Inner function of the actual update checking mechanism.
+ *
+ * @returns HRESULT
+ * @param   hHttp               HTTP client instance to use for checking.
+ * @param   strUrl              URL of repository to check.
+ * @param   strUserAgent        HTTP user agent to use for checking.
+ */
 HRESULT HostUpdateAgent::i_checkForUpdateInner(RTHTTP hHttp, Utf8Str const &strUrl, Utf8Str const &strUserAgent)
 {