Packages

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

    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

    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

    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 apply(system: ActorSystem[_]): Receptionist

    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
  2. def createExtension(system: ActorSystem[_]): Receptionist

    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
  3. final def equals(other: Any): Boolean
    Definition Classes
    ExtensionId → AnyRef → Any
  4. def find[T](key: ServiceKey[T], replyTo: ActorRef[Listing]): Command

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

  5. def get(system: ActorSystem[_]): Receptionist
  6. final def hashCode(): Int
    Definition Classes
    ExtensionId → AnyRef → Any
  7. def id: ExtensionId[Receptionist]

    Java API: The identifier of the extension

    Java API: The identifier of the extension

    Definition Classes
    ExtensionId
  8. def listing[T](key: ServiceKey[T], serviceInstances: Set[ActorRef[T]]): Listing

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

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

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

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

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

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

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

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

    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.

  13. object Find

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

  14. object Listing

    Sent by the receptionist, available here for easier testing

  15. object Register

    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.

  16. object Registered

    Sent by the receptionist, available here for easier testing

  17. object Subscribe

    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.