Skip to content

Commit

Permalink
Adjust in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sleipnir committed Nov 28, 2023
1 parent 8b49b18 commit 9d6ddc0
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions lib/actors/actor/entity/entity.ex
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ defmodule Actors.Actor.Entity do
- `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.
Expand All @@ -51,16 +61,6 @@ defmodule Actors.Actor.Entity do
Note: Ensure proper configuration and integration with the distributed system for seamless actor interactions.
## 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.
"""
use GenServer, restart: :transient
require Logger
Expand Down

0 comments on commit 9d6ddc0

Please sign in to comment.