client

Type Members

1. class ClusterClient extends Actor with Stash with ActorLogging

   

   This actor is intended to be used on an external node that is not member of the cluster.

   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.

2. class ClusterClientReceptionist extends Extension

   

   Extension that starts ClusterReceptionist and accompanying akka.cluster.pubsub.DistributedPubSubMediator with settings defined in config section akka.cluster.client.receptionist.

   Extension that starts ClusterReceptionist and accompanying akka.cluster.pubsub.DistributedPubSubMediator with settings defined in config section akka.cluster.client.receptionist. The akka.cluster.pubsub.DistributedPubSubMediator is started by the akka.cluster.pubsub.DistributedPubSub extension.

3. final class ClusterClientSettings extends NoSerializationVerificationNeeded

   

4. class ClusterReceptionist extends Actor with ActorLogging

   

   ClusterClient connects to this actor to retrieve.

   ClusterClient connects to this actor to retrieve. The ClusterReceptionist is supposed to be started on all nodes, or all nodes with specified role, in the cluster. The receptionist can be started with the ClusterClientReceptionist or as an ordinary actor (use the factory method ClusterReceptionist#props).

   The receptionist forwards messages from the client to the associated akka.cluster.pubsub.DistributedPubSubMediator, i.e. the client can send messages to any actor in the cluster that is registered in the DistributedPubSubMediator. Messages from the client are wrapped in akka.cluster.pubsub.DistributedPubSubMediator.Send, akka.cluster.pubsub.DistributedPubSubMediator.SendToAll or akka.cluster.pubsub.DistributedPubSubMediator.Publish with the semantics described in akka.cluster.pubsub.DistributedPubSubMediator.

   Response messages from the destination actor are tunneled via the receptionist to avoid inbound connections from other cluster nodes to the client, i.e. the sender, as seen by the destination actor, is not the client itself. The sender of the response messages, as seen by the client, is preserved as the original sender, so the client can choose to send subsequent messages directly to the actor in the cluster.

5. final class ClusterReceptionistSettings extends NoSerializationVerificationNeeded