APIs

The API interface helps interact with a GoAkt actor system as kind of client. The following features are available:

  • Tell: to send a message to an actor in a fire-and-forget manner.

  • Ask: to send a message to an actor and expect a response within a given timeout.

  • BatchAsk: to send a batch of requests to an actore remotely and expect responses back for each request.

  • BatchTell: to send a batch of fire-and-forget messages to an actor remotely.

  • Remote APIs: See Remoting

Remoting

Remoting allows remote actors to communicate. The underlying technology is gRPC. To enable remoting just use the WithRemote option when creating the actor system. See actor system options. These are the following remoting features available:

  • RemoteTell: to send a fire-and-forget message to an actor remotely

  • RemoteAsk: to send a request/response type of message to a remote actor

  • RemoteBatchTell: to send a fire-and-forget bulk of messages to a remote actor

  • RemoteBatchAsk: to send a bulk messages to a remote actor with replies

  • RemoteLookup: to lookup for an actor on a remote host

  • RemoteReSpawn: to restarts an actor on a remote machine

  • RemoteStop: to stop an actor on a remote machine

  • RemoteSpawn: to start an actor on a remote machine. The given actor implementation must be registered using the Register method of the actor system on the remote machine for this call to succeed.

  • RemoteForward: to pass a message from one actor to the actor by preserving the initial sender of the message.

These methods can be found as well as on the PID which is the actor reference when an actor is created.

Last updated