final class ClusterClient extends Actor with ActorLogging

This actor is intended to be used on an external node that is not member of the cluster. It acts like a gateway for sending messages to actors somewhere in the cluster. From the initial contact points it will establish a connection to a ClusterReceptionist somewhere in the cluster. It will monitor the connection to the receptionist and establish a new connection if the link goes down. When looking for a new receptionist it uses fresh contact points retrieved from previous establishment, or periodically refreshed contacts, i.e. not necessarily the initial contact points.

You can send messages via the ClusterClient to any actor in the cluster that is registered in the ClusterReceptionist. Messages are wrapped in ClusterClient.Send, ClusterClient.SendToAll or ClusterClient.Publish.

1. ClusterClient.Send - The message will be delivered to one recipient with a matching path, if any such exists. If several entries match the path the message will be delivered to one random destination. The sender of the message can specify that local affinity is preferred, i.e. the message is sent to an actor in the same local actor system as the used receptionist actor, if any such exists, otherwise random to any other matching entry.

2. ClusterClient.SendToAll - The message will be delivered to all recipients with a matching path.

3. ClusterClient.Publish - The message will be delivered to all recipients Actors that have been registered as subscribers to to the named topic.

Use the factory method ClusterClient#props) to create the pekko.actor.Props for the actor.

If the receptionist is not currently available, the client will buffer the messages and then deliver them when the connection to the receptionist has been established. The size of the buffer is configurable and it can be disabled by using a buffer size of 0. When the buffer is full old messages will be dropped when new messages are sent via the client.

Note that this is a best effort implementation: messages can always be lost due to the distributed nature of the actors involved.

Annotations
@deprecated
Deprecated

(Since version Akka 2.6.0) Use Apache Pekko gRPC instead, see https://pekko.apache.org/docs/pekko/current/cluster-client.html#migration-to-pekko-grpc

Source
ClusterClient.scala
Linear Supertypes
ActorLogging, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterClient
  2. ActorLogging
  3. Actor
  4. AnyRef
  5. 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 ClusterClient(settings: ClusterClientSettings)

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

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 ClusterClient toany2stringadd[ClusterClient] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterClient, B)
    Implicit
    This member is added by an implicit conversion from ClusterClient toArrowAssoc[ClusterClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def active(receptionist: ActorRef): actor.Actor.Receive
  7. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  10. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def buffer(msg: Any): Unit
  14. var buffer: MessageBuffer
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  16. var contactPaths: HashSet[ActorPath]
  17. var contactPathsPublished: HashSet[ActorPath]
  18. def contactPointMessages: actor.Actor.Receive
  19. var contacts: HashSet[ActorSelection]
  20. implicit val context: ActorContext

    Scala API: Stores the context for this actor, including self, and sender.

    Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  21. def ensuring(cond: (ClusterClient) => Boolean, msg: => Any): ClusterClient
    Implicit
    This member is added by an implicit conversion from ClusterClient toEnsuring[ClusterClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (ClusterClient) => Boolean): ClusterClient
    Implicit
    This member is added by an implicit conversion from ClusterClient toEnsuring[ClusterClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: => Any): ClusterClient
    Implicit
    This member is added by an implicit conversion from ClusterClient toEnsuring[ClusterClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): ClusterClient
    Implicit
    This member is added by an implicit conversion from ClusterClient toEnsuring[ClusterClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. def establishing: actor.Actor.Receive
  28. val failureDetector: DeadlineFailureDetector
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. val heartbeatTask: Cancellable
  32. val initialContactsSel: HashSet[ActorSelection]
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  38. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  39. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    ClusterClient → Actor
  40. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  41. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  42. def publishContactPoints(): Unit
  43. def receive: PartialFunction[Any, Unit]

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    ClusterClient → Actor
  44. def reestablish(): Unit
  45. var refreshContactsTask: Option[Cancellable]
  46. def scheduleRefreshContactsTick(interval: FiniteDuration): Unit
  47. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself: 

    self ! message

    Definition Classes
    Actor
  48. def sendBuffered(receptionist: ActorRef): Unit
  49. def sendGetContacts(): Unit
  50. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  51. var subscribers: Vector[ActorRef]
  52. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    Actor
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

    Definition Classes
    Actor
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  58. 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 ClusterClient toStringFormat[ClusterClient] 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): (ClusterClient, B)
    Implicit
    This member is added by an implicit conversion from ClusterClient toArrowAssoc[ClusterClient] 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 ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterClient to any2stringadd[ClusterClient]

Inherited by implicit conversion StringFormat fromClusterClient to StringFormat[ClusterClient]

Inherited by implicit conversion Ensuring fromClusterClient to Ensuring[ClusterClient]

Inherited by implicit conversion ArrowAssoc fromClusterClient to ArrowAssoc[ClusterClient]

Ungrouped