Packages

abstract class ServiceKey[T] extends AbstractServiceKey

A service key is an object that implements this trait for a given protocol T, meaning that it signifies that the type T is the entry point into the protocol spoken by that service (think of it as the set of first messages that a client could send).

Not for user extension, see factories in companion object: ServiceKey#create and ServiceKey#apply

Self Type
ServiceKey[T]
Annotations
@DoNotInherit()
Source
Receptionist.scala
Linear Supertypes
AbstractServiceKey, AnyRef, Any
Known Subclasses
DefaultServiceKey
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServiceKey
  2. AbstractServiceKey
  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. Protected

Instance Constructors

  1. new ServiceKey()

Type Members

  1. type Protocol = T
    Definition Classes
    ServiceKey → AbstractServiceKey

Abstract Value Members

  1. abstract def id: String

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 ServiceKey[T] toany2stringadd[ServiceKey[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ServiceKey[T], B)
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toArrowAssoc[ServiceKey[T]] 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 asServiceKey: ServiceKey[T]

    Type-safe down-cast

    Type-safe down-cast

    Definition Classes
    ServiceKey → AbstractServiceKey
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (ServiceKey[T]) => Boolean, msg: => Any): ServiceKey[T]
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toEnsuring[ServiceKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ServiceKey[T]) => Boolean): ServiceKey[T]
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toEnsuring[ServiceKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ServiceKey[T]
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toEnsuring[ServiceKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ServiceKey[T]
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toEnsuring[ServiceKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  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])
  26. object Listing

    Scala API: Provides a type safe pattern match for listings.

    Scala API: Provides a type safe pattern match for listings.

    Using it for pattern match like this will return the reachable service instances:

    case MyServiceKey.Listing(reachable) =>

    In a non-clustered ActorSystem this will always be all registered instances for a service key. For a clustered environment services on nodes that have been observed unreachable are not among these (note that they could have become unreachable between this message being sent and the receiving actor processing it).

  27. object Registered

    Scala API: Provides a type safe pattern match for registration acks

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 ServiceKey[T] toStringFormat[ServiceKey[T]] 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): (ServiceKey[T], B)
    Implicit
    This member is added by an implicit conversion from ServiceKey[T] toArrowAssoc[ServiceKey[T]] 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 AbstractServiceKey

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromServiceKey[T] to any2stringadd[ServiceKey[T]]

Inherited by implicit conversion StringFormat fromServiceKey[T] to StringFormat[ServiceKey[T]]

Inherited by implicit conversion Ensuring fromServiceKey[T] to Ensuring[ServiceKey[T]]

Inherited by implicit conversion ArrowAssoc fromServiceKey[T] to ArrowAssoc[ServiceKey[T]]

Ungrouped