Apache Pekko
1.2.1
API
Generated with
Apache Pekko/org.apache.pekko.cluster/org.apache.pekko.cluster.client/ClusterClient

ClusterClient

org.apache.pekko.cluster.client.ClusterClient
See theClusterClient companion object
final class ClusterClient(settings: ClusterClientSettings) extends Actor, 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.

Attributes

Companion
object
Deprecated
[Since version Akka 2.6.0]
Source
ClusterClient.scala
Graph
Supertypes
trait ActorLogging
trait Actor
class Object
trait Matchable
class Any

Members list

Type members

Inherited types

type Receive = Receive

Attributes

Inherited from:
Actor
Source
Actor.scala

Value members

Concrete methods

def active(receptionist: ActorRef): Receive

Attributes

Source
ClusterClient.scala
def buffer(msg: Any): Unit

Attributes

Source
ClusterClient.scala
def establishing: Receive

Attributes

Source
ClusterClient.scala
override def postStop(): Unit

User overridable callback.

User overridable callback.

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

Attributes

Definition Classes
Source
ClusterClient.scala
def publishContactPoints(): Unit

Attributes

Source
ClusterClient.scala
def receive: Receive

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.

Attributes

Source
ClusterClient.scala
def reestablish(): Unit

Attributes

Source
ClusterClient.scala
def sendBuffered(receptionist: ActorRef): Unit

Attributes

Source
ClusterClient.scala
def sendGetContacts(): Unit

Attributes

Source
ClusterClient.scala

Inherited methods

def log: LoggingAdapter

Attributes

Inherited from:
ActorLogging
Source
Actor.scala
def postRestart(reason: Throwable): Unit

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

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

Value parameters

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
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().'''

Value parameters

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.

reason

the Throwable that caused the restart to happen

Attributes

Inherited from:
Actor
Source
Actor.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala
final def sender(): ActorRef

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.

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!

Attributes

Inherited from:
Actor
Source
Actor.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala
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

Attributes

Inherited from:
Actor
Source
Actor.scala

Concrete fields

var buffer: MessageBuffer

Attributes

Source
ClusterClient.scala

Implicits

Inherited implicits

implicit val context: ActorContext

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

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit 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

Attributes

Inherited from:
Actor
Source
Actor.scala
Generated with