p

akka.cluster

client

package client

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ClusterClientInteraction extends AnyRef

    Declares a super type for all events emitted by the ClusterReceptionist.

    Declares a super type for all events emitted by the ClusterReceptionist. in relation to cluster clients being interacted with.

  2. sealed trait ClusterClientMessage extends Serializable

    Marker trait for remote messages with special serializer.

  3. final case class ClusterClientUnreachable(clusterClient: ActorRef) extends ClusterClientInteraction with Product with Serializable

    Emitted to the Akka event stream when a cluster client was previously connected but then not seen for some time.

  4. final case class ClusterClientUp(clusterClient: ActorRef) extends ClusterClientInteraction with Product with Serializable

    Emitted to the Akka event stream when a cluster client has interacted with a receptionist.

  5. final case class ClusterClients(clusterClients: Set[ActorRef]) extends Product with Serializable

    The reply to GetClusterClients.

    The reply to GetClusterClients.

    clusterClients

    The presently known list of cluster clients.

  6. final case class ContactPointAdded(contactPoint: ActorPath) extends ContactPointChange with Product with Serializable

    Emitted to a subscriber when contact points have been received by the ClusterClient and a new one has been added.

  7. sealed trait ContactPointChange extends AnyRef

    Declares a super type for all events emitted by the ClusterClient in relation to contact points being added or removed.

  8. final case class ContactPointRemoved(contactPoint: ActorPath) extends ContactPointChange with Product with Serializable

    Emitted to a subscriber when contact points have been received by the ClusterClient and a new one has been added.

  9. final case class ContactPoints(contactPoints: Set[ActorPath]) extends Product with Serializable

    The reply to GetContactPoints.

    The reply to GetContactPoints.

    contactPoints

    The presently known list of contact points.

  10. sealed abstract class GetClusterClients extends AnyRef
  11. sealed abstract class GetContactPoints extends AnyRef
  12. sealed abstract class SubscribeClusterClients extends AnyRef
  13. sealed abstract class SubscribeContactPoints extends AnyRef
  14. sealed abstract class UnsubscribeClusterClients extends AnyRef
  15. sealed abstract class UnsubscribeContactPoints extends AnyRef
  16. 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.

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  17. final 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  18. final class ClusterClientSettings extends NoSerializationVerificationNeeded

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  19. final 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 deadLetters since the client should normally send subsequent messages via the ClusterClient. It is possible to pass the original sender inside the reply messages if the client is supposed to communicate directly to the actor in the cluster.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  20. final class ClusterReceptionistSettings extends NoSerializationVerificationNeeded

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

Value Members

  1. object GetClusterClients extends GetClusterClients with Product with Serializable

    Get the cluster clients known to this receptionist.

    Get the cluster clients known to this receptionist. A ClusterClients message will be replied.

  2. object GetContactPoints extends GetContactPoints with Product with Serializable

    Get the contact points known to this client.

    Get the contact points known to this client. A ContactPoints message will be replied.

  3. object SubscribeClusterClients extends SubscribeClusterClients with Product with Serializable

    Subscribe to a cluster receptionist's client interactions where it is guaranteed that a sender receives the initial state of contact points prior to any events in relation to them changing.

    Subscribe to a cluster receptionist's client interactions where it is guaranteed that a sender receives the initial state of contact points prior to any events in relation to them changing. The sender will automatically become unsubscribed when it terminates.

  4. object SubscribeContactPoints extends SubscribeContactPoints with Product with Serializable

    Subscribe to a cluster client's contact point changes where it is guaranteed that a sender receives the initial state of contact points prior to any events in relation to them changing.

    Subscribe to a cluster client's contact point changes where it is guaranteed that a sender receives the initial state of contact points prior to any events in relation to them changing. The sender will automatically become unsubscribed when it terminates.

  5. object UnsubscribeClusterClients extends UnsubscribeClusterClients with Product with Serializable

    Explicitly unsubscribe from client interaction events.

  6. object UnsubscribeContactPoints extends UnsubscribeContactPoints with Product with Serializable

    Explicitly unsubscribe from contact point change events.

Deprecated Value Members

  1. object ClusterClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  2. object ClusterClientReceptionist extends ExtensionId[ClusterClientReceptionist] with ExtensionIdProvider
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  3. object ClusterClientSettings
    Annotations
    @ccompatUsedUntil213() @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  4. object ClusterReceptionist
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

  5. object ClusterReceptionistSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

Ungrouped