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 akka.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.

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. All

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 to any2stringadd[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 to ArrowAssoc[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
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundPostStop(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  10. def aroundPreStart(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[akka]
    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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  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
    Definition Classes
    Actor
  21. def ensuring(cond: (ClusterClient) ⇒ Boolean, msg: ⇒ Any): ClusterClient
    Implicit
    This member is added by an implicit conversion from ClusterClient to Ensuring[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 to Ensuring[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 to Ensuring[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 to Ensuring[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: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def establishing: actor.Actor.Receive
  28. val failureDetector: DeadlineFailureDetector
  29. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterClient to StringFormat[ClusterClient] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. val heartbeatTask: Cancellable
  33. val initialContactsSel: HashSet[ActorSelection]
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  40. def postStop(): Unit
    Definition Classes
    ClusterClient → Actor
  41. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  42. def preStart(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  43. def publishContactPoints(): Unit
  44. def receive: PartialFunction[Any, Unit]
    Definition Classes
    ClusterClient → Actor
  45. def reestablish(): Unit
  46. var refreshContactsTask: Option[Cancellable]
  47. def scheduleRefreshContactsTick(interval: FiniteDuration): Unit
  48. implicit final val self: ActorRef
    Definition Classes
    Actor
  49. def sendBuffered(receptionist: ActorRef): Unit
  50. def sendGetContacts(): Unit
  51. final def sender(): ActorRef
    Definition Classes
    Actor
  52. var subscribers: Vector[ActorRef]
  53. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def →[B](y: B): (ClusterClient, B)
    Implicit
    This member is added by an implicit conversion from ClusterClient to ArrowAssoc[ClusterClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterClient to any2stringadd[ClusterClient]

Inherited by implicit conversion StringFormat from ClusterClient to StringFormat[ClusterClient]

Inherited by implicit conversion Ensuring from ClusterClient to Ensuring[ClusterClient]

Inherited by implicit conversion ArrowAssoc from ClusterClient to ArrowAssoc[ClusterClient]

Ungrouped