Class

com.lightbend.lagom.scaladsl.client

CircuitBreakingServiceLocator

Related Doc: package client

Permalink

abstract class CircuitBreakingServiceLocator extends ServiceLocator

Abstract service locator that provides circuit breaking.

Generally, only the ServiceLocator.locate() method needs to be implemented, however doWithServiceImpl() can be overridden if the service locator wants to handle failures in some way.

Source
ServiceLocators.scala
Linear Supertypes
ServiceLocator, AnyRef, Any
Known Subclasses
ConfigurationServiceLocator, RoundRobinServiceLocator, StaticServiceLocator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakingServiceLocator
  2. ServiceLocator
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CircuitBreakingServiceLocator(circuitBreakers: CircuitBreakers)(implicit ec: ExecutionContext)

    Permalink

Abstract Value Members

  1. abstract def locate(name: String, serviceCall: Call[_, _]): Future[Option[URI]]

    Permalink

    Locate a service with the given name.

    Locate a service with the given name.

    name

    The name of the service.

    serviceCall

    The service call descriptor that this lookup is for.

    returns

    The URI for that service, if it exists.

    Definition Classes
    ServiceLocator

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to any2stringadd[CircuitBreakingServiceLocator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (CircuitBreakingServiceLocator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to ArrowAssoc[CircuitBreakingServiceLocator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def doWithService[T](name: String, serviceCall: Call[_, _])(block: (URI) ⇒ Future[T])(implicit ec: ExecutionContext): Future[Option[T]]

    Permalink

    Do the given action with the given service.

    Do the given action with the given service.

    This should be used in preference to #locate when possible as it will allow the service locator to add in things like circuit breakers.

    It is required that the service locator will, based on the service call circuit breaker configuration, wrap the invocation of the passed in block with a circuit breaker.

    name

    The name of the service.

    serviceCall

    The service call descriptor that this lookup is for.

    block

    A block of code that takes the URI for the service, and returns a future of some work done on the service. This will only be executed if the service was found.

    returns

    The result of the executed block, if the service was found.

    Definition Classes
    CircuitBreakingServiceLocator → ServiceLocator

  9. def doWithServiceImpl[T](name: String, serviceCall: Call[_, _])(block: (URI) ⇒ Future[T]): Future[Option[T]]

    Permalink

    Do the given block with the given service looked up.

    Do the given block with the given service looked up.

    This is invoked by doWithService(), after wrapping the passed in block in a circuit breaker if configured to do so.

    The default implementation just delegates to the locate() method, but this method can be overridden if the service locator wants to inject other behaviour after the service call is complete.

    name

    The service name.

    serviceCall

    The service call that needs the service lookup.

    block

    A block of code that will use the looked up service, typically, to make a call on that service.

    returns

    A future of the result of the block, if the service lookup was successful.

    Attributes
    protected

  10. def ensuring(cond: (CircuitBreakingServiceLocator) ⇒ Boolean, msg: ⇒ Any): CircuitBreakingServiceLocator

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to Ensuring[CircuitBreakingServiceLocator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (CircuitBreakingServiceLocator) ⇒ Boolean): CircuitBreakingServiceLocator

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to Ensuring[CircuitBreakingServiceLocator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): CircuitBreakingServiceLocator

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to Ensuring[CircuitBreakingServiceLocator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): CircuitBreakingServiceLocator

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to Ensuring[CircuitBreakingServiceLocator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to StringFormat[CircuitBreakingServiceLocator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. def locate(name: String): Future[Option[URI]]

    Permalink

    Locate a service with the given name.

    Locate a service with the given name.

    name

    The name of the service.

    returns

    The URI for that service, if it exists.

    Definition Classes
    ServiceLocator

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def →[B](y: B): (CircuitBreakingServiceLocator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CircuitBreakingServiceLocator to ArrowAssoc[CircuitBreakingServiceLocator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ServiceLocator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CircuitBreakingServiceLocator to any2stringadd[CircuitBreakingServiceLocator]

Inherited by implicit conversion StringFormat from CircuitBreakingServiceLocator to StringFormat[CircuitBreakingServiceLocator]

Inherited by implicit conversion Ensuring from CircuitBreakingServiceLocator to Ensuring[CircuitBreakingServiceLocator]

Inherited by implicit conversion ArrowAssoc from CircuitBreakingServiceLocator to ArrowAssoc[CircuitBreakingServiceLocator]

Ungrouped