CircuitBreaker Class

Provides circuit breaker functionality to provide stability when working with "dangerous" operations, e.g. calls to remote systems

In *Closed* state, - calls pass through until the maxFailures count is reached. This causes the circuit breaker to open. Both exceptions and calls exceeding callTimeout are considered failures.
In *Open* state, - calls fail-fast with an exception. After resetTimeout, circuit breaker transitions to half-open state.
In *Half-Open* state, - the first call will be allowed through, if it succeeds the circuit breaker will reset to closed state. If it fails, the circuit breaker will re-open to open state. All calls beyond the first that execute while the first is running will fail-fast with an exception.

Inheritance Hierarchy

SystemObject
Akka.PatternCircuitBreaker

Namespace: Akka.Pattern
Assembly: Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)

Syntax

public class CircuitBreaker

type CircuitBreaker =  class end

The CircuitBreaker type exposes the following members.

Constructors

	Name	Description
	CircuitBreaker	Create a new CircuitBreaker

Properties

	Name	Description
	CallTimeout	TBD
	CurrentFailureCount	Retrieves current failure count.
	MaxFailures	TBD
	ResetTimeout	TBD

Methods

	Name	Description
	Create	Create a new CircuitBreaker
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnClose	Adds a callback to execute when circuit breaker state closes
	OnHalfOpen	Adds a callback to execute when circuit breaker transitions to half-open
	OnOpen	Adds a callback to execute when circuit breaker opens
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithCircuitBreaker(FuncTask)	Wraps invocation of asynchronous calls that need to be protected
	WithCircuitBreakerT(FuncTaskT)	Wraps invocation of asynchronous calls that need to be protected
	WithSyncCircuitBreaker(Action)	The failure will be recorded farther down.
	WithSyncCircuitBreakerT(FuncT)	Wraps invocations of asynchronous calls that need to be protected If this does not complete within the time allotted, it should return default(T) Copy Await.result( withCircuitBreaker(try Future.successful(body) catch { case NonFatal(t) ⇒ Future.failed(t) }), callTimeout)

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)