View Source Actors.Actor.Entity (spawn v1.4.3)

Manages the lifecycle of the Host Actor through the Entity module.

The Entity module provides a GenServer-based implementation for controlling the lifecycle of actors, handling various actions, and interacting with the underlying actor system.

Behavior

The module implements GenServer behavior with transient restart semantics.

  • Initialization: The module initializes the actor state and handles the loading of persisted states.

  • State Handling: Manages the lifecycle of the actor, including state transitions, initialization actions, and periodic snapshots.

  • Interaction: Exposes client APIs for retrieving actor state, synchronously invoking actions, and asynchronously triggering actions.

  • Terminating: Ensures that the actor's state will be saved and performs all necessary cleanups.

Client APIs

The following client APIs are available for interaction:

  • start_link/1: Starts the entity for a given actor state.
  • get_state/2: Retrieves the actor state directly from memory.
  • invoke/3: Synchronously invokes an action on an actor.
  • invoke_async/3: Asynchronously invokes an action on an actor.

Callbacks

  • init/1: Initializes the actor entity.
  • handle_continue/2: Handles asynchronous events during the actor lifecycle.
  • handle_call/3: Handles synchronous calls to the actor.
  • handle_cast/2: Handles asynchronous casts to the actor.
  • handle_info/2: Handles informational messages.
  • terminate/2: Terminates the actor entity.

Client APIs

start_link/1: Starts the entity for a given actor state.

get_state/2: Retrieves the actor state directly from memory.

invoke/3: Synchronously invokes an action on an actor.

invoke_async/3: Asynchronously invokes an action on an actor.

Usage

To use this module, start the actor by calling start_link/1 with an initial actor state. Interaction with the actor is facilitated through the provided client APIs such as get_state/2, invoke/3, and invoke_async/3.

Example

{:ok, actor} = Actors.Actor.Entity.start_link(%EntityState{actor: %Actor{id: %ActorId{name: "example"}}})
state = Actors.Actor.Entity.get_state(actor)
{:ok, result} = Actors.Actor.Entity.invoke(actor, %InvocationRequest{action: :some_action})

Note: Ensure proper configuration and integration with the distributed system for seamless actor interactions.

Summary

Functions

Returns a specification to start this module under a supervisor.

Retrieve the Actor state direct from memory.

Synchronously invokes an Action on an Actor.

Asynchronously invokes an Action on an Actor.

Retrieve the health check liveness status.

Retrieve the health check readiness status.

Starts the entity for a given actor state.

Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get_state(ref, opts \\ [])

View Source
@spec get_state(any(), any()) :: {:error, term()} | {:ok, term()}

Retrieve the Actor state direct from memory.

Link to this function

invoke(ref, request, opts \\ [])

View Source
@spec invoke(any(), any(), any()) :: any()

Synchronously invokes an Action on an Actor.

Link to this function

invoke_async(ref, request, opts \\ [])

View Source
@spec invoke_async(any(), any(), any()) :: :ok

Asynchronously invokes an Action on an Actor.

Link to this function

liveness(ref, opts \\ [])

View Source

Retrieve the health check liveness status.

Link to this function

readiness(ref, opts \\ [])

View Source
@spec readiness(any(), any()) :: {:error, term()} | {:ok, term()}
@spec readiness(any(), any()) :: {:error, term()} | {:ok, term()}

Retrieve the health check readiness status.

Starts the entity for a given actor state.