Class ClusterClientReceptionist

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

Inheritance
object
ClusterClientReceptionist
Implements
Inherited Members
Namespace: Akka.Cluster.Tools.Client
Assembly: Akka.Cluster.Tools.dll
Syntax
public sealed class ClusterClientReceptionist : IExtension

Constructors

| Edit this page View Source

ClusterClientReceptionist(ExtendedActorSystem)

TBD

Declaration
public ClusterClientReceptionist(ExtendedActorSystem system)
Parameters
Type Name Description
ExtendedActorSystem system

TBD

Properties

| Edit this page View Source

IsTerminated

Returns true if this member is not tagged with the role configured for the receptionist.

Declaration
public bool IsTerminated { get; }
Property Value
Type Description
bool
| Edit this page View Source

Underlying

Returns the underlying receptionist actor, particularly so that its events can be observed via subscribe/unsubscribe.

Declaration
public IActorRef Underlying { get; }
Property Value
Type Description
IActorRef

Methods

| Edit this page View Source

DefaultConfig()

TBD

Declaration
public static Config DefaultConfig()
Returns
Type Description
Config

TBD
| Edit this page View Source

Get(ActorSystem)

TBD

Declaration
public static ClusterClientReceptionist Get(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

TBD
Returns
Type Description
ClusterClientReceptionist

TBD
| Edit this page View Source

RegisterService(IActorRef)

Register an actor that should be reachable for the clients. The clients can send messages to this actor with Send or SendToAll using the path elements of the IActorRef, e.g. "/user/myservice".

Declaration
public void RegisterService(IActorRef actorRef)
Parameters
Type Name Description
IActorRef actorRef

TBD
| Edit this page View Source

RegisterSubscriber(string, IActorRef)

Register an actor that should be reachable for the clients to a named topic. Several actors can be registered to the same topic name, and all will receive published messages. The client can publish messages to this topic with Publish.

Declaration
public void RegisterSubscriber(string topic, IActorRef actorRef)
Parameters
Type Name Description
string topic

TBD
IActorRef actorRef

TBD
| Edit this page View Source

UnregisterService(IActorRef)

A registered actor will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Declaration
public void UnregisterService(IActorRef actorRef)
Parameters
Type Name Description
IActorRef actorRef

TBD
| Edit this page View Source

UnregisterSubscriber(string, IActorRef)

A registered subscriber will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Declaration
public void UnregisterSubscriber(string topic, IActorRef actorRef)
Parameters
Type Name Description
string topic

TBD
IActorRef actorRef

TBD

Implements

Extension Methods