final class CircuitBreakerProxy extends Actor with ActorLogging with FSM[CircuitBreakerState, CircuitBreakerStateData]
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.0) Use akka.pattern.CircuitBreaker + ask instead
- Source
- CircuitBreakerProxy.scala
- Alphabetic
- By Inheritance
- CircuitBreakerProxy
- FSM
- Listeners
- ActorLogging
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new CircuitBreakerProxy(target: ActorRef, maxFailures: Int, callTimeout: util.Timeout, resetTimeout: util.Timeout, circuitEventListener: Option[ActorRef], failureDetector: (Any) ⇒ Boolean, failureMap: (CircuitOpenFailure) ⇒ Any)
Type Members
-
final
class
TransformHelper extends AnyRef
- Definition Classes
- FSM
-
type
Event = actor.FSM.Event[CircuitBreakerStateData]
- Definition Classes
- FSM
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
-
type
State = actor.FSM.State[CircuitBreakerState, CircuitBreakerStateData]
- Definition Classes
- FSM
-
type
StateFunction = PartialFunction[Event, State]
- Definition Classes
- FSM
-
type
StopEvent = actor.FSM.StopEvent[CircuitBreakerState, CircuitBreakerStateData]
- Definition Classes
- FSM
-
type
Timeout = Option[FiniteDuration]
- Definition Classes
- FSM
-
type
TransitionHandler = PartialFunction[(CircuitBreakerState, CircuitBreakerState), Unit]
- Definition Classes
- FSM
Value Members
-
val
->: actor.FSM.->.type
This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
- Definition Classes
- FSM
-
val
Event: actor.FSM.Event.type
- Definition Classes
- FSM
-
val
StateTimeout: actor.FSM.StateTimeout.type
This case object is received in case of a state timeout.
This case object is received in case of a state timeout.
- Definition Classes
- FSM
-
val
StopEvent: actor.FSM.StopEvent.type
- Definition Classes
- FSM
- def callSucceededHandling: StateFunction
-
final
def
cancelTimer(name: String): Unit
Cancel named timer, ensuring that the message is not subsequently delivered (no race).
Cancel named timer, ensuring that the message is not subsequently delivered (no race).
- name
of the timer to cancel
- Definition Classes
- FSM
- def commonStateHandling: StateFunction
-
implicit
val
context: ActorContext
Scala API: Stores the context for this actor, including self, and sender.
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as
forward.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
akka.actor.ActorContext is the Scala API.
getContextreturns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- def forwardRequest(message: Any, currentSender: ActorRef, state: CircuitBreakerStateData, log: LoggingAdapter): Unit
-
final
def
goto(nextStateName: CircuitBreakerState): State
Produce transition to other state.
Produce transition to other state. Return this from a state function in order to effect the transition.
This method always triggers transition events, even for
A -> Atransitions. If you want to stay in the same state without triggering an state transition event use #stay instead.- nextStateName
state designator for the next state
- returns
state transition descriptor
- Definition Classes
- FSM
-
final
def
initialize(): Unit
Verify existence of initial state and setup timers.
Verify existence of initial state and setup timers. This should be the last call within the constructor, or akka.actor.Actor#preStart and akka.actor.Actor#postRestart
An initial
currentState -> currentStatenotification will be triggered by calling this method.- Definition Classes
- FSM
- See also
-
final
def
isTimerActive(name: String): Boolean
Inquire whether the named timer is still active.
Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.
- Definition Classes
- FSM
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
-
final
def
nextStateData: CircuitBreakerStateData
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
- Definition Classes
- FSM
-
final
def
onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit
Set handler which is called upon termination of this FSM actor.
Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
- Definition Classes
- FSM
-
final
def
onTransition(transitionHandler: TransitionHandler): Unit
Set handler which is called upon each state transition, i.e.
Set handler which is called upon each state transition, i.e. not when staying in the same state. This may use the pair extractor defined in the FSM companion object like so:
onTransition { case Old -> New => doSomething }It is also possible to supply a 2-ary function object:
onTransition(handler _) private def handler(from: S, to: S) { ... }The underscore is unfortunately necessary to enable the nicer syntax shown above (it uses the implicit conversion total2pf under the hood).
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
- Definition Classes
- FSM
- def passthroughHandling: StateFunction
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart().User overridable callback: By default it calls
preStart().- reason
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
postStop(): Unit
Call
onTerminationhook; if you want to retain this behavior when overriding make sure to callsuper.postStop(). -
def
preRestart(reason: Throwable, message: Option[Any]): Unit
Scala API: User overridable callback: By default it disposes of all children and then calls
postStop().Scala API: User overridable callback: By default it disposes of all children and then calls
postStop().- reason
the Throwable that caused the restart to happen
- message
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preStart(): Unit
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
receive: Receive
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
-
implicit final
val
self: ActorRef
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
The reference sender Actor of the last received message.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else
deadLettersin akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
-
final
def
setStateTimeout(state: CircuitBreakerState, timeout: Timeout): Unit
Set state timeout explicitly.
Set state timeout explicitly. This method can safely be used from within a state handler.
- Definition Classes
- FSM
-
final
def
setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean = false): Unit
Schedule named timer to deliver message after given delay, possibly repeating.
Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
- name
identifier to be used with cancelTimer()
- msg
message to be delivered
- timeout
delay of first message delivery and between subsequent messages
- repeat
send once if false, scheduleAtFixedRate if true
- Definition Classes
- FSM
-
final
def
startWith(stateName: CircuitBreakerState, stateData: CircuitBreakerStateData, timeout: Timeout = None): Unit
Set initial state.
Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
- stateName
initial state designator
- stateData
initial state data
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Definition Classes
- FSM
-
final
def
stateData: CircuitBreakerStateData
Return current state data (i.e.
Return current state data (i.e. object of type D)
- Definition Classes
- FSM
-
final
def
stateName: CircuitBreakerState
Return current state name (i.e.
Return current state name (i.e. object of type S)
- Definition Classes
- FSM
-
final
def
stay(): State
Produce "empty" transition descriptor.
Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.
No transition event will be triggered by #stay. If you want to trigger an event like
S -> SforonTransitionto handle usegotoinstead.- returns
descriptor for staying in current state
- Definition Classes
- FSM
-
final
def
stop(reason: Reason, stateData: CircuitBreakerStateData): State
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Definition Classes
- FSM
-
final
def
stop(reason: Reason): State
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Definition Classes
- FSM
-
final
def
stop(): State
Produce change descriptor to stop this FSM actor with reason "Normal".
Produce change descriptor to stop this FSM actor with reason "Normal".
- Definition Classes
- FSM
-
def
supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- Actor
- def targetTerminationHandling: StateFunction
-
implicit final
def
total2pf(transitionHandler: (CircuitBreakerState, CircuitBreakerState) ⇒ Unit): TransitionHandler
Convenience wrapper for using a total function instead of a partial function literal.
Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.
- Definition Classes
- FSM
-
final
def
transform(func: StateFunction): TransformHelper
- Definition Classes
- FSM
-
def
unhandled(message: Any): Unit
User overridable callback.
User overridable callback.
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream
- Definition Classes
- Actor
-
final
def
when(stateName: CircuitBreakerState, stateTimeout: FiniteDuration = null)(stateFunction: StateFunction): Unit
Insert a new StateFunction at the end of the processing chain for the given state.
Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.
- stateName
designator for the state
- stateTimeout
default state timeout for this state
- stateFunction
partial function describing response to input
- Definition Classes
- FSM
-
final
def
whenUnhandled(stateFunction: StateFunction): Unit
Set handler which is called upon reception of unhandled messages.
Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.
The current state may be queried using
stateName- Definition Classes
- FSM