Class ClusterClient

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.

Inheritance
object
ActorBase
ClusterClient
Implements
Inherited Members
Namespace: Akka.Cluster.Tools.Client
Assembly: Akka.Cluster.Tools.dll
Syntax
public sealed class ClusterClient : ActorBase, IInternalActor

Constructors

| Edit this page View Source

ClusterClient(ClusterClientSettings)

Initializes a new instance of the ClusterClient class.

Declaration
public ClusterClient(ClusterClientSettings settings)
Parameters
Type Name Description
ClusterClientSettings settings

The settings used to configure the client.
Exceptions
Type Condition
ArgumentException

This exception is thrown when the settings contains no initial contacts.

Methods

| Edit this page View Source

PostStop()

TBD

Declaration
protected override void PostStop()
Overrides
| Edit this page View Source

Props(ClusterClientSettings)

Factory method for ClusterClient Props.

Declaration
public static Props Props(ClusterClientSettings settings)
Parameters
Type Name Description
ClusterClientSettings settings

TBD
Returns
Type Description
Props

TBD
Exceptions
Type Condition
ArgumentNullException

This exception is thrown when the specified settings is undefined.
| Edit this page View Source

Receive(object)

TBD

Declaration
protected override bool Receive(object message)
Parameters
Type Name Description
object message

TBD
Returns
Type Description
bool

TBD
Overrides

Implements

Extension Methods