Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package pattern

    This package is used as a collection point for usage patterns which involve actors, futures, etc.

    Commonly Used Patterns With Akka

    This package is used as a collection point for usage patterns which involve actors, futures, etc. but are loosely enough coupled to (multiple of) them to present them separately from the core implementation. Currently supported are:

    • ask: create a temporary one-off actor for receiving a reply to a message and complete a scala.concurrent.Future with it; returns said Future.
    • pipeTo: feed eventually computed value of a future to an akka.actor.ActorRef as a message.
    • pipeToSelection: feed eventually computed value of a future to an akka.actor.ActorSelection as a message.

    In Scala the recommended usage is to import the pattern from the package object:

    import akka.pattern.ask

ask(actor, message) // use it directly
actor ask message   // use it by implicit conversion

    For Java the patterns are available as static methods of the akka.pattern.Patterns class:

    import static akka.pattern.Patterns.ask;

ask(actor, message);
    Definition Classes
    akka
  • package internal
    Definition Classes
    pattern
  • CircuitBreakerTelemetry
t

akka.pattern.internal

CircuitBreakerTelemetry

trait CircuitBreakerTelemetry extends AnyRef

Service Provider Interface (SPI) for collecting metrics from Circuit Breaker.

Implementations must include a single constructor with two arguments: Circuit Breaker id and ExtendedActorSystem. To setup your implementation, add a setting in your application.conf:

akka.circuit-breaker.telemetry.implementations += com.example.MyMetrics
Annotations
@InternalStableApi()
Source
CircuitBreakerTelemetry.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerTelemetry
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def onCallBreakerOpenFailure(): Unit

    Invoked for each call when the future is completed with akka.pattern.CircuitBreakerOpenException

  2. abstract def onCallFailure(elapsedNanos: Long): Unit

    Invoked for each call when the future is completed with exception, except for scala.concurrent.TimeoutException and akka.pattern.CircuitBreakerOpenException that are handled by separate methods.

    Invoked for each call when the future is completed with exception, except for scala.concurrent.TimeoutException and akka.pattern.CircuitBreakerOpenException that are handled by separate methods.

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  3. abstract def onCallSuccess(elapsedNanos: Long): Unit

    Invoked for each successful call.

    Invoked for each successful call.

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  4. abstract def onCallTimeoutFailure(elapsedNanos: Long): Unit

    Invoked for each call when the future is completed with java.util.concurrent.TimeoutException

    Invoked for each call when the future is completed with java.util.concurrent.TimeoutException

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  5. abstract def onClose(): Unit

    Invoked when the circuit breaker transitions to the close state.

  6. abstract def onHalfOpen(): Unit

    Invoked when the circuit breaker transitions to the half-open state after reset timeout.

  7. abstract def onOpen(): Unit

    Invoked when the circuit breaker transitions to the open state.

  8. abstract def stopped(): Unit

    Called when the circuit breaker is removed, e.g.

    Called when the circuit breaker is removed, e.g. expired due to inactivity. It is also called if the circuit breaker is re-configured, before calling CircuitBreakerTelemetryProvider#start.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toany2stringadd[CircuitBreakerTelemetry] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CircuitBreakerTelemetry, B)
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toArrowAssoc[CircuitBreakerTelemetry] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (CircuitBreakerTelemetry) => Boolean, msg: => Any): CircuitBreakerTelemetry
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toEnsuring[CircuitBreakerTelemetry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (CircuitBreakerTelemetry) => Boolean): CircuitBreakerTelemetry
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toEnsuring[CircuitBreakerTelemetry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): CircuitBreakerTelemetry
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toEnsuring[CircuitBreakerTelemetry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): CircuitBreakerTelemetry
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toEnsuring[CircuitBreakerTelemetry] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toStringFormat[CircuitBreakerTelemetry] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (CircuitBreakerTelemetry, B)
    Implicit
    This member is added by an implicit conversion from CircuitBreakerTelemetry toArrowAssoc[CircuitBreakerTelemetry] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromCircuitBreakerTelemetry to any2stringadd[CircuitBreakerTelemetry]

Inherited by implicit conversion StringFormat fromCircuitBreakerTelemetry to StringFormat[CircuitBreakerTelemetry]

Inherited by implicit conversion Ensuring fromCircuitBreakerTelemetry to Ensuring[CircuitBreakerTelemetry]

Inherited by implicit conversion ArrowAssoc fromCircuitBreakerTelemetry to ArrowAssoc[CircuitBreakerTelemetry]

Ungrouped