Object/Class

akka.actor.typed.receptionist

Receptionist

Related Docs: class Receptionist | package receptionist

Permalink

object Receptionist extends ExtensionId[Receptionist]

A Receptionist is an entry point into an Actor hierarchy where select Actors publish their identity together with the protocols that they implement. Other Actors need only know the Receptionist’s identity in order to be able to use the services of the registered Actors.

These are the messages (and the extension) for interacting with the receptionist. The receptionist is easiest accessed through the system: ActorSystem.receptionist

Source
Receptionist.scala
Linear Supertypes
ExtensionId[Receptionist], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Receptionist
  2. ExtensionId
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract class Command extends AnyRef

    Permalink

    The set of commands accepted by a Receptionist.

    The set of commands accepted by a Receptionist.

    Not for user Extension

    Annotations
    @DoNotInherit()

  2. trait Listing extends AnyRef

    Permalink

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

    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()

  3. trait Registered extends AnyRef

    Permalink

    Confirmation that the given akka.actor.typed.ActorRef has been associated with the ServiceKey.

    Confirmation that the given akka.actor.typed.ActorRef has been associated with the ServiceKey.

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

    Not for user extension

    Annotations
    @DoNotInherit()

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. object Find

    Permalink

    Query the Receptionist for a list of all Actors implementing the given protocol at one point in time.

  5. object Listing

    Permalink

    Sent by the receptionist, available here for easier testing

  6. object Register

    Permalink

    Associate the given akka.actor.typed.ActorRef with the given ServiceKey.

    Associate the given akka.actor.typed.ActorRef with the given ServiceKey. Multiple registrations can be made for the same key. De-registration is implied by the end of the referenced Actor’s lifecycle.

    Registration will be acknowledged with the Registered message to the given replyTo actor if there is one.

  7. object Registered

    Permalink

    Sent by the receptionist, available here for easier testing

  8. object Subscribe

    Permalink

    Subscribe the given actor to service updates.

    Subscribe the given actor to service updates. When new instances are registered or unregistered to the given key the given subscriber will be sent a Listing with the new set of instances for that service.

    The subscription will be acknowledged by sending out a first Listing. The subscription automatically ends with the termination of the subscriber.

  9. final def apply(system: ActorSystem[_]): Receptionist

    Permalink

    Lookup or create an instance of the extension identified by this id.

    Lookup or create an instance of the extension identified by this id.

    Definition Classes
    ExtensionId

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  11. def clone(): AnyRef

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

  12. def createExtension(system: ActorSystem[_]): Receptionist

    Permalink

    Create the extension, will be invoked at most one time per actor system where the extension is registered.

    Create the extension, will be invoked at most one time per actor system where the extension is registered.

    Definition Classes
    Receptionist → ExtensionId

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

    Permalink
    Definition Classes
    AnyRef

  14. final def equals(other: Any): Boolean

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any

  15. def finalize(): Unit

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

  16. def find[T](key: ServiceKey[T], replyTo: ActorRef[Listing]): Command

    Permalink

    Java API: Query the Receptionist for a list of all Actors implementing the given protocol at one point in time.

  17. def get(system: ActorSystem[_]): Receptionist

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def hashCode(): Int

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any

  20. def id: ExtensionId[Receptionist]

    Permalink

    Java API: The identifier of the extension

    Java API: The identifier of the extension

    Definition Classes
    ExtensionId

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def listing[T](key: ServiceKey[T], serviceInstances: Set[ActorRef[T]]): Listing

    Permalink

    Java API: Sent by the receptionist, available here for easier testing

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

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. def register[T](key: ServiceKey[T], service: ActorRef[T], replyTo: ActorRef[Registered]): Command

    Permalink

    Java API: A Register message with Ack that the service was registered

  27. def register[T](key: ServiceKey[T], service: ActorRef[T]): Command

    Permalink

    Java API: A Register message without Ack that the service was registered

  28. def registered[T](key: ServiceKey[T], serviceInstance: ActorRef[T]): Registered

    Permalink

    Java API: Sent by the receptionist, available here for easier testing

  29. def subscribe[T](key: ServiceKey[T], subscriber: ActorRef[Listing]): Command

    Permalink

    Java API: Subscribe the given actor to service updates.

    Java API: Subscribe the given actor to service updates. When new instances are registered or unregistered to the given key the given subscriber will be sent a Listing with the new set of instances for that service.

    The subscription will be acknowledged by sending out a first Listing. The subscription automatically ends with the termination of the subscriber.

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

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

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

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

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

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

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

Inherited from ExtensionId[Receptionist]

Inherited from AnyRef

Inherited from Any

Ungrouped