You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<trclass="memdesc:ae9dc843e520435569f40e8832791ecbe"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Simple exponential backoff and jitter function that provides the delay value for the next retry attempt. After a failure of an operation that needs to be retried, the application should use this function to obtain the backoff delay value for the next retry, and then wait for the backoff time period before retrying the operation. <br/></td></tr>
<trclass="memdesc:ac37ecab230cf5da8f70547ec63776a48"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes the context for using backoff algorithm. The parameters are required for calculating the next retry backoff delay. This function must be called by the application before the first new retry attempt. <br/></td></tr>
<trclass="memdesc:ad418427ae9e59374df8235d5e369bd1c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Simple exponential backoff and jitter function that provides the delay value for the next retry attempt. After a failure of an operation that needs to be retried, the application should use this function to obtain the backoff delay value for the next retry, and then wait for the backoff time period before retrying the operation. <br/></td></tr>
<trclass="memdesc:adf229f6284bae0856b901ec19f10d6bd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes the context for using backoff algorithm. The parameters are required for calculating the next retry backoff delay. This function must be called by the application before the first new retry attempt. <br/></td></tr>
<dlclass="section note"><dt>Note</dt><dd>For generating a random number, it is recommended to use a Random Number Generator that is seeded with a device-specific entropy source so that possibility of collisions between multiple devices retrying the network operations can be mitigated.</dd></dl>
165
+
<dlclass="section note"><dt>Note</dt><dd>For generating a random number, it is recommended to use a random number generator that is seeded with a device-specific entropy source so that possibility of collisions between multiple devices retrying the network operations can be mitigated.</dd></dl>
166
166
<dlclass="section return"><dt>Returns</dt><dd><aclass="el" href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695" title="The function successfully calculated the next back-off value.">BackoffAlgorithmSuccess</a> after a successful sleep; <aclass="el" href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df" title="The function exhausted all retry attempts.">BackoffAlgorithmRetriesExhausted</a> when all attempts are exhausted. </dd></dl>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pContext</td><td>The context to initialize with parameters required for the next backoff delay calculation function. </td></tr>
212
212
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">maxBackOff</td><td>The maximum backoff delay (in milliseconds) between consecutive retry attempts. </td></tr>
213
-
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">backOffBase</td><td>The base value (in milliseconds) of backoff delay to use in the exponential backoff and jitter model. </td></tr>
213
+
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">backOffBase</td><td>The base value (in milliseconds) of backoff delay to use in the exponential backoff and jitter model. Must be non-zero. </td></tr>
214
214
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">maxAttempts</td><td>The maximum number of retry attempts. Set the value to <aclass="el" href="group__backoff__algorithm__constants.html#ga89e511b4edee8a92050802a329753842" title="Constant to represent unlimited number of retry attempts.">BACKOFF_ALGORITHM_RETRY_FOREVER</a> to retry for ever. </td></tr>
<trclass="memdesc:ga7b7f4051eb253599ffedd69285f5a89b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Status for <aclass="el" href="backoff__algorithm_8h.html#ae9dc843e520435569f40e8832791ecbe">BackoffAlgorithm_GetNextBackoff</a>. <ahref="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">More...</a><br/></td></tr>
133
+
<trclass="memdesc:ga7b7f4051eb253599ffedd69285f5a89b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Status for <aclass="el" href="backoff__algorithm_8h.html#ad418427ae9e59374df8235d5e369bd1c">BackoffAlgorithm_GetNextBackoff</a>. <ahref="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">More...</a><br/></td></tr>
<trclass="memdesc:ac37ecab230cf5da8f70547ec63776a48"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes the context for using backoff algorithm. The parameters are required for calculating the next retry backoff delay. This function must be called by the application before the first new retry attempt. <br/></td></tr>
<trclass="memdesc:ae9dc843e520435569f40e8832791ecbe"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Simple exponential backoff and jitter function that provides the delay value for the next retry attempt. After a failure of an operation that needs to be retried, the application should use this function to obtain the backoff delay value for the next retry, and then wait for the backoff time period before retrying the operation. <br/></td></tr>
<trclass="memdesc:adf229f6284bae0856b901ec19f10d6bd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes the context for using backoff algorithm. The parameters are required for calculating the next retry backoff delay. This function must be called by the application before the first new retry attempt. <br/></td></tr>
<trclass="memdesc:ad418427ae9e59374df8235d5e369bd1c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Simple exponential backoff and jitter function that provides the delay value for the next retry attempt. After a failure of an operation that needs to be retried, the application should use this function to obtain the backoff delay value for the next retry, and then wait for the backoff time period before retrying the operation. <br/></td></tr>
<divclass="textblock"><p>API for calculating backoff period for retry attempts using exponential backoff with jitter algorithm. This library represents the "Full Jitter" backoff strategy explained in the following document. <ahref="https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/</a>. </p>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pContext</td><td>The context to initialize with parameters required for the next backoff delay calculation function. </td></tr>
190
190
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">maxBackOff</td><td>The maximum backoff delay (in milliseconds) between consecutive retry attempts. </td></tr>
191
-
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">backOffBase</td><td>The base value (in milliseconds) of backoff delay to use in the exponential backoff and jitter model. </td></tr>
191
+
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">backOffBase</td><td>The base value (in milliseconds) of backoff delay to use in the exponential backoff and jitter model. Must be non-zero. </td></tr>
192
192
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">maxAttempts</td><td>The maximum number of retry attempts. Set the value to <aclass="el" href="group__backoff__algorithm__constants.html#ga89e511b4edee8a92050802a329753842" title="Constant to represent unlimited number of retry attempts.">BACKOFF_ALGORITHM_RETRY_FOREVER</a> to retry for ever. </td></tr>
<dlclass="section note"><dt>Note</dt><dd>For generating a random number, it is recommended to use a Random Number Generator that is seeded with a device-specific entropy source so that possibility of collisions between multiple devices retrying the network operations can be mitigated.</dd></dl>
240
+
<dlclass="section note"><dt>Note</dt><dd>For generating a random number, it is recommended to use a random number generator that is seeded with a device-specific entropy source so that possibility of collisions between multiple devices retrying the network operations can be mitigated.</dd></dl>
241
241
<dlclass="section return"><dt>Returns</dt><dd><aclass="el" href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695" title="The function successfully calculated the next back-off value.">BackoffAlgorithmSuccess</a> after a successful sleep; <aclass="el" href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df" title="The function exhausted all retry attempts.">BackoffAlgorithmRetriesExhausted</a> when all attempts are exhausted. </dd></dl>
0 commit comments