Skip to content

Commit

Permalink
Updates to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
lpryor committed Sep 9, 2014
1 parent 507027e commit 03c822a
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,15 @@ In addition to making retry behavior easy to understand, atmos provides the abil

## Getting Started

<a name="getting-started"></a>

Prerequisites:

- [Scala](http://scala-lang.org/) 2.10.x

<!---
- [SBT](http://www.scala-sbt.org/) or a similar build tool.
<!---
To use atmos in your project simply add one line to your SBT configuration:
```scala
Expand All @@ -99,15 +101,17 @@ libraryDependencies += "io.zman" %% "atmos" % "2.0"

## Using the Library

<a name="using-the-library"></a>

The atmos library divides the definition of a retry policy into four parts:

- Termination policies enforce an upper bound on the number of retry attempts that are made.
- [Termination policies](#termination-policies) enforce an upper bound on the number of retry attempts that are made.

- Backoff policies calculate the delay that is inserted before subsequent retry attempts.
- [Backoff policies](#backoff-policies) calculate the delay that is inserted before subsequent retry attempts.

- Error classifiers define the strategy used to determine if an error prevents further attempts.
- [Error classifiers](#error-classifiers) define the strategy used to determine if an error prevents further attempts.

- Event monitors are notified of events that occur while performing a retry operation.
- [Event monitors](#event-monitors) are notified of events that occur while performing a retry operation.

Using the naive retry loop from above, we can classify its behavior according to the four elements of a retry policy:

Expand Down Expand Up @@ -139,16 +143,32 @@ Atmos decomposes the traditional retry loop into these four, independent strateg

### Termination Policies

<a name="termination-policies"></a>

### Backoff Policies

<a name="backoff-policies"></a>

### Error Classifiers

<a name="error-classifiers"></a>

### Event Monitors

<a name="event-monitors"></a>

### Retrying Synchronously

<a name="retrying-synchronously"></a>

### Retrying Asynchronously

<a name="retrying-asynchronously"></a>

### Example Retry Policies

## Building and Testing
<a name="example-retry-policies"></a>

## Building and Testing

<a name="building-and-testing"></a>

0 comments on commit 03c822a

Please sign in to comment.