Update the documentation

Accelize · Aug 17, 2020 · 8e13fde · 8e13fde
1 parent ab5467c
commit 8e13fde
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/doc/drm_sw_advanced_description.rst b/doc/drm_sw_advanced_description.rst
@@ -117,14 +117,18 @@ page_mailbox                   string    Read-only     NA                      r
 hw_report                      string    Read-only     NA                      return nothing, print the Algodone HW report
 trigger_async_callback         string    Write-only    No                      only for testing, call the asynchronous error callback with the given message
 log_message                    string    Write-only    No                      only for testing, insert a message with the value as content
+hdk_compatibility              string    Read-only     NA                      only for testing, return the lower version of the HDK it is compatible with
+health_period                  uint32_t  Read-only     >=0                     return the current value of the health period. 0 means the asychronous feature is disabled
+health_retry                   uint32_t  Read-only     >=0                     return the current value of the health retry timeout. 0 means there will be no retry
+health_retry_sleep             uint32_t  Read-only     >=0                     return the current value of the health retry sleep
 =============================  ========  ============  ======================  =============================================
 
 
 Detailed explanation
 --------------------
 
-Retry mechanism
-~~~~~~~~~~~~~~~
+Retry mechanism for the license request
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 There are 2 types of retry mechanisms:
 

diff --git a/source/drm_manager.cpp b/source/drm_manager.cpp
@@ -176,9 +176,9 @@ class DRM_LOCAL DrmManager::Impl {
     Json::Value mHeaderJsonRequest;
 
     // Health/Asynchronous metering parameters
-    uint32_t mHealthPeriod;
-    uint32_t mHealthRetryTimeout;
-    uint32_t mHealthRetrySleep;
+    uint32_t mHealthPeriod;             ///< Time in seconds before performing the next health request
+    uint32_t mHealthRetryTimeout;       ///< Timeout in seconds for the health request
+    uint32_t mHealthRetrySleep;         ///< Time in seconds before perforing a new health retry
 
     // thread to maintain license alive
     uint32_t mLicenseCounter = 0;
@@ -1695,7 +1695,7 @@ class DRM_LOCAL DrmManager::Impl {
                             mHealthPeriod = healthPeriod;
                             mHealthRetryTimeout = healthRetryTimeout;
                             mHealthRetrySleep = healthRetrySleep;
-                            Debug( "Updating Health parameters with new values: healthPeriod={}, healthRetry={}, healthRetrySleep={}",
+                            Debug( "Updating Health parameters with new values: healthPeriod={}s, healthRetry={}s, healthRetrySleep={}s",
                                 mHealthPeriod, mHealthRetryTimeout, mHealthRetrySleep );
                             if ( mHealthPeriod == 0 ) {
                                 Warning( "Health thread is disabled" );
@@ -1711,11 +1711,11 @@ class DRM_LOCAL DrmManager::Impl {
                                 Debug( "Health retry is enabled" );
                             }
                         } else {
-                            Debug( "Keep same Health parameters: healthPeriod={}, healthRetry={}, healthRetrySleep={}",
+                            Debug( "Keep same Health parameters: healthPeriod={}s, healthRetry={}s, healthRetrySleep={}s",
                                 mHealthPeriod, mHealthRetryTimeout, mHealthRetrySleep );
                         }
                     } else {
-                        Debug( "Keep same Health parameters: healthPeriod={}, healthRetry={}, healthRetrySleep={}",
+                        Debug( "Keep same Health parameters: healthPeriod={}s, healthRetry={}s, healthRetrySleep={}s",
                             mHealthPeriod, mHealthRetryTimeout, mHealthRetrySleep );
                     }
                 }