Skip to content

Commit 848eac8

Browse files
jasonpcarrolljasonpcarroll
committed
Doxygen for 554884b 
1 parent 0ea29f2 commit 848eac8

132 files changed

Lines changed: 8723 additions & 83 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_data/doc_config.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "backOffAlgorithm Library",
33
"releases": [
4+
"v1.4.2",
45
"v1.4.1",
56
"v1.4.0",
67
"v1.3.0",

‎latest/annotated.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>

‎latest/backoff__algorithm_8c.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>

‎latest/backoff__algorithm_8h.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>

‎latest/backoff__algorithm_8h_source.html‎

Lines changed: 49 additions & 48 deletions
Large diffs are not rendered by default.

‎latest/backoff_algorithm_example.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>
@@ -188,10 +188,10 @@
188188
<div class="ttc" id="abackoff__algorithm_8h_html"><div class="ttname"><a href="backoff__algorithm_8h.html">backoff_algorithm.h</a></div><div class="ttdoc">API for calculating backoff period for retry attempts using exponential backoff with jitter algorithm...</div></div>
189189
<div class="ttc" id="abackoff__algorithm_8h_html_ac37ecab230cf5da8f70547ec63776a48"><div class="ttname"><a href="backoff__algorithm_8h.html#ac37ecab230cf5da8f70547ec63776a48">BackoffAlgorithm_InitializeParams</a></div><div class="ttdeci">void BackoffAlgorithm_InitializeParams(BackoffAlgorithmContext_t *pContext, uint16_t backOffBase, uint16_t maxBackOff, uint32_t maxAttempts)</div><div class="ttdoc">Initializes the context for using backoff algorithm. The parameters are required for calculating the ...</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.c:86</div></div>
190190
<div class="ttc" id="abackoff__algorithm_8h_html_ae9dc843e520435569f40e8832791ecbe"><div class="ttname"><a href="backoff__algorithm_8h.html#ae9dc843e520435569f40e8832791ecbe">BackoffAlgorithm_GetNextBackoff</a></div><div class="ttdeci">BackoffAlgorithmStatus_t BackoffAlgorithm_GetNextBackoff(BackoffAlgorithmContext_t *pRetryContext, uint32_t randomValue, uint16_t *pNextBackOff)</div><div class="ttdoc">Simple exponential backoff and jitter function that provides the delay value for the next retry attem...</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.c:40</div></div>
191-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_ga7b7f4051eb253599ffedd69285f5a89b"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">BackoffAlgorithmStatus_t</a></div><div class="ttdeci">BackoffAlgorithmStatus_t</div><div class="ttdoc">Status for BackoffAlgorithm_GetNextBackoff.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:58</div></div>
192-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df">BackoffAlgorithmRetriesExhausted</a></div><div class="ttdeci">@ BackoffAlgorithmRetriesExhausted</div><div class="ttdoc">The function exhausted all retry attempts.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:60</div></div>
193-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695">BackoffAlgorithmSuccess</a></div><div class="ttdeci">@ BackoffAlgorithmSuccess</div><div class="ttdoc">The function successfully calculated the next back-off value.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:59</div></div>
194-
<div class="ttc" id="astruct_backoff_algorithm_context__t_html"><div class="ttname"><a href="struct_backoff_algorithm_context__t.html">BackoffAlgorithmContext_t</a></div><div class="ttdoc">Represents parameters required for calculating the back-off delay for the next retry attempt.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:69</div></div>
191+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_ga7b7f4051eb253599ffedd69285f5a89b"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">BackoffAlgorithmStatus_t</a></div><div class="ttdeci">BackoffAlgorithmStatus_t</div><div class="ttdoc">Status for BackoffAlgorithm_GetNextBackoff.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:68</div></div>
192+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df">BackoffAlgorithmRetriesExhausted</a></div><div class="ttdeci">@ BackoffAlgorithmRetriesExhausted</div><div class="ttdoc">The function exhausted all retry attempts.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:70</div></div>
193+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695">BackoffAlgorithmSuccess</a></div><div class="ttdeci">@ BackoffAlgorithmSuccess</div><div class="ttdoc">The function successfully calculated the next back-off value.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:69</div></div>
194+
<div class="ttc" id="astruct_backoff_algorithm_context__t_html"><div class="ttname"><a href="struct_backoff_algorithm_context__t.html">BackoffAlgorithmContext_t</a></div><div class="ttdoc">Represents parameters required for calculating the back-off delay for the next retry attempt.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:79</div></div>
195195
</div><!-- fragment --> </div></div><!-- contents -->
196196
</div><!-- PageDoc -->
197197
</div><!-- doc-content -->

‎latest/backoff_algorithm_functions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>

‎latest/classes.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>

‎latest/define_backoffalgorithm_getnextbackoff.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>
@@ -145,7 +145,7 @@
145145
<div class="line"> } <span class="keywordflow">while</span>( ( dnsStatus != 0 ) &amp;&amp; ( retryStatus != <a class="code hl_enumvalue" href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df">BackoffAlgorithmRetriesExhausted</a> ) );</div>
146146
<div class="line"> </div>
147147
<div class="ttc" id="abackoff__algorithm_8h_html_ae9dc843e520435569f40e8832791ecbe"><div class="ttname"><a href="backoff__algorithm_8h.html#ae9dc843e520435569f40e8832791ecbe">BackoffAlgorithm_GetNextBackoff</a></div><div class="ttdeci">BackoffAlgorithmStatus_t BackoffAlgorithm_GetNextBackoff(BackoffAlgorithmContext_t *pRetryContext, uint32_t randomValue, uint16_t *pNextBackOff)</div><div class="ttdoc">Simple exponential backoff and jitter function that provides the delay value for the next retry attem...</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.c:40</div></div>
148-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df">BackoffAlgorithmRetriesExhausted</a></div><div class="ttdeci">@ BackoffAlgorithmRetriesExhausted</div><div class="ttdoc">The function exhausted all retry attempts.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:60</div></div>
148+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89ba4dd72a4822e0f93b5b98309453b774df">BackoffAlgorithmRetriesExhausted</a></div><div class="ttdeci">@ BackoffAlgorithmRetriesExhausted</div><div class="ttdoc">The function exhausted all retry attempts.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:70</div></div>
149149
</div><!-- fragment --> </div></div><!-- contents -->
150150
</div><!-- PageDoc -->
151151
</div><!-- doc-content -->

‎latest/define_backoffalgorithm_initializeparams.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<tbody>
3232
<tr id="projectrow">
3333
<td id="projectalign">
34-
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.1</span>
34+
<div id="projectname">backoffAlgorithm<span id="projectnumber">&#160;v1.4.2</span>
3535
</div>
3636
<div id="projectbrief">Algorithmic library for calculating retry intervals using exponential backoff and jitter.</div>
3737
</td>
@@ -105,7 +105,7 @@
105105
<div class="line"> uint16_t maxBackOff,</div>
106106
<div class="line"> uint32_t maxAttempts );</div>
107107
<div class="ttc" id="abackoff__algorithm_8h_html_ac37ecab230cf5da8f70547ec63776a48"><div class="ttname"><a href="backoff__algorithm_8h.html#ac37ecab230cf5da8f70547ec63776a48">BackoffAlgorithm_InitializeParams</a></div><div class="ttdeci">void BackoffAlgorithm_InitializeParams(BackoffAlgorithmContext_t *pContext, uint16_t backOffBase, uint16_t maxBackOff, uint32_t maxAttempts)</div><div class="ttdoc">Initializes the context for using backoff algorithm. The parameters are required for calculating the ...</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.c:86</div></div>
108-
<div class="ttc" id="astruct_backoff_algorithm_context__t_html"><div class="ttname"><a href="struct_backoff_algorithm_context__t.html">BackoffAlgorithmContext_t</a></div><div class="ttdoc">Represents parameters required for calculating the back-off delay for the next retry attempt.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:69</div></div>
108+
<div class="ttc" id="astruct_backoff_algorithm_context__t_html"><div class="ttname"><a href="struct_backoff_algorithm_context__t.html">BackoffAlgorithmContext_t</a></div><div class="ttdoc">Represents parameters required for calculating the back-off delay for the next retry attempt.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:79</div></div>
109109
</div><!-- fragment --><p>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. </p>
110110
<dl class="params"><dt>Parameters</dt><dd>
111111
<table class="params">
@@ -127,8 +127,8 @@
127127
<div class="line"> RETRY_BACKOFF_BASE_MS,</div>
128128
<div class="line"> RETRY_MAX_BACKOFF_DELAY_MS,</div>
129129
<div class="line"> RETRY_MAX_ATTEMPTS );</div>
130-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_ga7b7f4051eb253599ffedd69285f5a89b"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">BackoffAlgorithmStatus_t</a></div><div class="ttdeci">BackoffAlgorithmStatus_t</div><div class="ttdoc">Status for BackoffAlgorithm_GetNextBackoff.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:58</div></div>
131-
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695">BackoffAlgorithmSuccess</a></div><div class="ttdeci">@ BackoffAlgorithmSuccess</div><div class="ttdoc">The function successfully calculated the next back-off value.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:59</div></div>
130+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_ga7b7f4051eb253599ffedd69285f5a89b"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#ga7b7f4051eb253599ffedd69285f5a89b">BackoffAlgorithmStatus_t</a></div><div class="ttdeci">BackoffAlgorithmStatus_t</div><div class="ttdoc">Status for BackoffAlgorithm_GetNextBackoff.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:68</div></div>
131+
<div class="ttc" id="agroup__backoff__algorithm__enum__types_html_gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695"><div class="ttname"><a href="group__backoff__algorithm__enum__types.html#gga7b7f4051eb253599ffedd69285f5a89baecf422ba6b1201d8ffbfd61e5712d695">BackoffAlgorithmSuccess</a></div><div class="ttdeci">@ BackoffAlgorithmSuccess</div><div class="ttdoc">The function successfully calculated the next back-off value.</div><div class="ttdef"><b>Definition:</b> backoff_algorithm.h:69</div></div>
132132
</div><!-- fragment --> </div></div><!-- contents -->
133133
</div><!-- PageDoc -->
134134
</div><!-- doc-content -->

0 commit comments

Comments
 (0)