Packages

trait Listing extends AnyRef

Current listing of all Actors that implement the protocol given by the ServiceKey.

You can use key.Listing for type-safe pattern matching.

Not for user extension.

Annotations
@DoNotInherit()
Source
Receptionist.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Listing
  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 allServiceInstances[T](key: ServiceKey[T]): Set[ActorRef[T]]

    Scala API: Return both the reachable and the unreachable service instances.

    Scala API: Return both the reachable and the unreachable service instances.

    In a non-clustered ActorSystem this will always be the same as #serviceInstances.

    For a clustered ActorSystem this include both services on nodes that are reachable and nodes that are unreachable.

  2. abstract def getAllServiceInstances[T](key: ServiceKey[T]): Set[ActorRef[T]]

    Java API: Return both the reachable and the unreachable service instances.

    Java API: Return both the reachable and the unreachable service instances.

    In a non-clustered ActorSystem this will always be the same as #getServiceInstances.

    For a clustered ActorSystem this include both services on nodes that are reachable and nodes that are unreachable.

  3. abstract def getServiceInstances[T](key: ServiceKey[T]): Set[ActorRef[T]]

    Java API: Return the reachable service instances.

    Java API: Return the reachable service instances.

    In a non-clustered ActorSystem this will always be all registered instances for a service key.

    For a clustered ActorSystem it only contain services on nodes that has are not seen as unreachable (note that they could have still have become unreachable between this message being sent and the receiving actor processing it).

    For a list including both reachable and unreachable instances see #getAllServiceInstances

  4. abstract def isForKey(key: ServiceKey[_]): Boolean
  5. abstract def key: ServiceKey[_]

    Scala API

  6. abstract def serviceInstances[T](key: ServiceKey[T]): Set[ActorRef[T]]

    Scala API: Return the reachable service instances.

    Scala API: Return the reachable service instances.

    In a non-clustered ActorSystem this will always be all registered instances for a service key.

    For a clustered ActorSystem it only contain services on nodes that are not seen as unreachable (note that they could have still have become unreachable between this message being sent and the receiving actor processing it).

    For a list including both reachable and unreachable instances see #allServiceInstances

    Also, see ServiceKey.Listing for more convenient pattern matching

  7. abstract def servicesWereAddedOrRemoved: Boolean

    Returns true only if this Listing was sent triggered by new actors added or removed to the receptionist.

    Returns true only if this Listing was sent triggered by new actors added or removed to the receptionist. When false the event is only about reachability changes - meaning that the full set of actors (#allServiceInstances or #getAllServiceInstances) is the same as the previous Listing.

    knowing this is useful for subscribers only concerned with #allServiceInstances or #getAllServiceInstances that can then ignore Listings related to reachability.

    In a non-clustered ActorSystem this will be true for all listings. For Find queries and the initial listing for a Subscribe this will always be true.

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 Listing toany2stringadd[Listing] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Listing, B)
    Implicit
    This member is added by an implicit conversion from Listing toArrowAssoc[Listing] 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: (Listing) => Boolean, msg: => Any): Listing
    Implicit
    This member is added by an implicit conversion from Listing toEnsuring[Listing] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Listing) => Boolean): Listing
    Implicit
    This member is added by an implicit conversion from Listing toEnsuring[Listing] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Listing
    Implicit
    This member is added by an implicit conversion from Listing toEnsuring[Listing] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Listing
    Implicit
    This member is added by an implicit conversion from Listing toEnsuring[Listing] 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 getKey: ServiceKey[_]

    Java API

  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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 Listing toStringFormat[Listing] 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): (Listing, B)
    Implicit
    This member is added by an implicit conversion from Listing toArrowAssoc[Listing] 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 fromListing to any2stringadd[Listing]

Inherited by implicit conversion StringFormat fromListing to StringFormat[Listing]

Inherited by implicit conversion Ensuring fromListing to Ensuring[Listing]

Inherited by implicit conversion ArrowAssoc fromListing to ArrowAssoc[Listing]

Ungrouped