Skip to content

Commit 8d9adfd

Browse files
authored
Improve documentation and add CHANGELOG file (#12)
* Add changelog file * doc: update text about backoff algorithm in README and doxygen * hygiene: remove trailing whitespaces in CHANGELOG
1 parent 0628d0f commit 8d9adfd

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog for backoffAlgorithm Library
2+
3+
## v1.0.0 December 2020
4+
5+
This is the first release of the backoffAlgorithm library in this repository.
6+
7+
The backoffAlgorithm library is a utility library to calculate backoff period using an exponential backoff with jitter algorithm for retrying network operations (like failed network connection with server).
8+
This library uses the "Full Jitter" strategy for the exponential backoff with jitter algorithm.
9+
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.

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
## backoffAlgorithm Library
22

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).
4-
3+
This repository contains the backoffAlgorithm library, a utility library to calculate backoff period using an exponential backoff with jitter algorithm for retrying network operations (like failed network connection with server).
54
This library uses the "Full Jitter" strategy for the exponential backoff with jitter algorithm.
65
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.
76

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.
7+
The backoffAlgorithm library is distributed under the [MIT Open Source License](LICENSE).
8+
9+
Exponential backoff with jitter is typically used when retrying a failed network
10+
connection or operation request with the server. An exponential backoff with jitter helps to
11+
mitigate failed network operations with servers, that are caused due to network congestion or high request load on
12+
the server, by spreading out retry requests across multiple devices attempting network operations.
1213
Besides, in an environment with poor connectivity, a client can get disconnected at any time.
1314
A backoff strategy helps the client to conserve battery by not repeatedly attempting reconnections when they are
1415
unlikely to succeed.

docs/doxygen/pages.dox

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ This library uses the "Full Jitter" strategy for the exponential back-off with j
99

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

12-
Exponential backoff with jitter is typically used when retrying a failed
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.
12+
Exponential backoff with jitter is typically used when retrying a failed network
13+
connection or operation request with the server. An exponential backoff with jitter helps to
14+
mitigate failed network operations with servers, that are caused due to network congestion or high request load on
15+
the server, by spreading out retry requests across multiple devices attempting network operations.
1616
Besides, in an environment with poor connectivity, a client can get disconnected at any time.
1717
A backoff strategy helps the client to conserve battery by not repeatedly attempting reconnections when they are
1818
unlikely to succeed.

0 commit comments

Comments
 (0)