🎭
GoAkt
GithubReference
  • 👋Introduction
  • 🏛️Design Principles
  • 🔢Versioning
  • 💡Use Cases
  • 🚀Get Started
  • 📦Binaries and Go versions
  • features
    • Actor System
    • Actor
    • Mailbox
    • Messaging
    • PipeTo
    • Passivation
    • Supervision
    • Behaviors
    • Remoting and APIs
    • TLS
    • Scheduler
    • Stashing
    • Routers
    • Events Stream
    • Coordinated Shutdown
    • Persistence
    • Observability
    • Testkit
    • Cluster
    • Service Discovery
    • Cluster Singleton
    • Cluster Client
  • Cluster PubSub
  • Extensions
  • Dependencies
  • Meta Framework
    • eGo
Powered by GitBook
On this page
  • Balancer strategies
  • Functions
  • Note
  1. features

Cluster Client

PreviousCluster SingletonNextCluster PubSub

Last updated 3 months ago

The GoAkt client facilitates interaction with a specified GoAkt cluster, contingent upon the activation of cluster mode. The client operates without knowledge of the specific node within the cluster that will process the request. This feature is particularly beneficial when interfacing with a GoAkt cluster from an external system. GoAkt client is equipped with a mini load-balancer that helps route requests to the appropriate node.

Balancer strategies

  • - a given node is chosen using the round-robin strategy

  • - a given node is chosen randomly

  • - the node with the least number of actors is chosen

Functions

  • Kinds - to list all the actor kinds in the cluster

  • Spawn - to spawn an actor in the cluster

  • SpawnWithBalancer - to spawn an actor in the cluster with a given balancer strategy

  • Stop - to kill/stop an actor in the cluster

  • Ask - to send a message to a given actor in the cluster and expect a response

  • Tell - to send a fire-forget message to a given actor in the cluster

  • Whereis - to locate and get the address of a given actor

  • ReSpawn - to restart a given actor

Note

It is not possible at the moment to customise the spawning of remote actors. That means that

actors created using the cluster client are created using the default mailbox and supervisor strategy.

Round Robin
Random
Least Load