Skip to content

Commit b53a1da

Browse files
authored
Improve doc content (#5)
* Add more doc content * Remove trailing whitespace * doc: improvements in unit test requirements * Fixes in README
1 parent bc5ce2e commit b53a1da

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1-
## backOffAlgorthm Library
1+
## backOffAlgorithm Library
22

3-
This repository contains the backoffAlgorithm library, a utility library to calculate interval period for network operation retries (like failed network connection with server) using exponential back-off with jitter algorithm. The backoffAlgorithm library is distributed under the [MIT Open Source License](LICENSE).
3+
This repository contains the backoffAlgorithm library, a utility library to calculate backoff period for network operation retries (like failed network connection with server) using an exponential backoff with jitter algorithm. The backoffAlgorithm library is distributed under the [MIT Open Source License](LICENSE).
44

5-
This library supports the "Full Jitter" algorithm for exponential back-off with jitter.
5+
This library uses the "Full Jitter" strategy for the exponential backoff with jitter algorithm.
66
More information about the algorithm can be seen in the [Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) AWS blog.
77

8+
Exponential backoff with jitter is typically used when retrying a failed
9+
connection or network operation with the server. An exponential backoff with jitter helps to
10+
mitigate the server request failure caused from network congestion or high request load on
11+
the server by spreading out retry requests across multiple devices.
12+
Besides, in an environment with poor connectivity, a client can get disconnected at any time.
13+
A backoff strategy helps the client to conserve battery by not repeatedly attempting reconnections when they are
14+
unlikely to succeed.
15+
816
## Reference example
917

1018
The example below shows how to use the backoffAlgorithm library to retry a DNS resolution query for `amazon.com`.
@@ -119,9 +127,8 @@ git submodule update --checkout --init --recursive --test/unit-test/Unity
119127
### Platform Prerequisites
120128

121129
- For running unit tests
122-
- C90 compiler like gcc
130+
- C89 or later compiler like gcc
123131
- CMake 3.13.0 or later
124-
- Ruby 2.0.0 or later is additionally required for the Unity test framework (that we use).
125132
- For running the coverage target, gcov is additionally required.
126133

127134
### Steps to build Unit Tests

docs/doxygen/pages.dox

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ This library uses the "Full Jitter" strategy for the exponential back-off with j
1010
More information about the algorithm can be seen in the [Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) AWS blog.
1111

1212
Exponential backoff with jitter is typically used when retrying a failed
13-
connection to the server. In an environment with poor connectivity, a client
14-
can get disconnected at any time. A backoff strategy helps the client to
15-
conserve battery by not repeatedly attempting reconnections when they are
13+
connection or network operation with the server. An exponential backoff with jitter helps to
14+
mitigate the server request failure caused from network congestion or high request load on
15+
the server by spreading out retry requests across multiple devices.
16+
Besides, in an environment with poor connectivity, a client can get disconnected at any time.
17+
A backoff strategy helps the client to conserve battery by not repeatedly attempting reconnections when they are
1618
unlikely to succeed.
1719

1820
Before retrying the failed communication to the server, there is a delay period.

0 commit comments

Comments
 (0)