pekko/akka-docs/rst/common/index.rst

Common utilities
==========================

.. toctree::
   :maxdepth: 2

   duration
   circuitbreaker
Adding a Common section to the docs and fixing the Scheduler docs 2011-05-02 18:22:13 +02:00			`Common utilities`
			`==========================`

			`.. toctree::`
			`:maxdepth: 2`

move Duration docs below common/ next to Scheduler 2011-05-02 21:40:35 +02:00			`duration`
* Add Circuit Breaker to akka.pattern for general use. Circuit breaker implementation as described by Michael T. Nygard in Release It!. Fixes #1734 * Uses finite state machine for three states: Closed, Open, Half-Open * Closed state allows calls through, and on sequential failures exceeding the max# set - transitions to Open state. Intervening successes cause the failure count to reset to 0 * Open state throws a CircuitOpenException on every call until the reset timeout is reached which causes a transition to Half-Open state * Half-Open state will allow the next single call through, if it succeeds - transition to Closed state, if it fails - transition back to Open state, starting the reset timer again * Allow configuration for the call and reset timeouts, as well as the maximum number of sequential failures before opening * Supports async or synchronous call protection * Callbacks are supported for state entry into Closed, Open, Half-Open. These are run in the supplied execution context * Both thrown exceptions and calls exceeding max call time are considered failures * Uses akka scheduler for timer events * Integrated into File-Based durable mailbox * Sample documented for other durable mailboxes 2012-06-01 08:24:47 -04:00			`circuitbreaker`