Packages
spawn_sdk
0.5.3
2.0.0-RC9
2.0.0-RC8
2.0.0-RC7
2.0.0-RC6
2.0.0-RC5
2.0.0-RC4
2.0.0-RC3
2.0.0-RC14
2.0.0-RC13
2.0.0-RC12
2.0.0-RC11
2.0.0-RC10
1.4.3
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc3
1.0.0-rc16
1.0.0-rc1
1.0.0-rc.38
1.0.0-rc.37
1.0.0-rc.36
1.0.0-rc.35
1.0.0-rc.34
1.0.0-rc.33
1.0.0-rc.32
1.0.0-rc.31
1.0.0-rc.30
1.0.0-rc.29
1.0.0-rc.28
1.0.0-rc.27
1.0.0-rc.26
1.0.0-rc.25
1.0.0-rc.24
1.0.0-rc.23
1.0.0-rc.22
1.0.0-rc.21
1.0.0-rc.20
1.0.0-rc.19
1.0.0-rc.18
1.0.0-rc.17
1.0.0-rc.2
0.6.3
0.6.2
0.6.1
0.6.0
0.5.5
0.5.4
0.5.3
0.5.1
0.5.0
0.5.0-rc.13
0.5.0-rc.12
0.5.0-rc.11
0.5.0-rc.10
0.5.0-rc.9
0.5.0-rc.8
0.5.0-rc.7
0.5.0-rc.6
0.5.0-rc.5
0.5.0-rc.3
0.5.0-alpha.13
0.5.0-alpha.12
0.5.0-alpha.11
0.5.0-alpha.10
0.5.0-alpha.9
0.5.0-alpha.8
0.5.0-alpha.7
0.5.0-alpha.6
0.5.0-alpha.5
0.5.0-alpha.4
0.5.0-alpha.3
0.5.0-alpha.2
0.5.0-alpha.1
0.1.0
Spawn Elixir SDK is the support library for the Spawn Actors System
Current section
Files
Jump to
Current section
Files
lib/spawn_sdk.ex
defmodule SpawnSdk do
@moduledoc "README.md"
|> File.read!()
|> String.split("<!-- MDOC !-->")
|> Enum.fetch!(1)
@doc """
Invokes a function for a actor_name
## Opts
- `system` this is required
- `ref` attribute attribute will always lookup to see if the referenced actor is already started or not.
- `payload` attribute is optional.
- `command` has default values that you can use to get current actor state
- get, get_state, Get, getState, GetState
## Examples
```elixir
iex> SpawnSdk.invoke(
"actor_name",
ref: SpawnSdkExample.Actors.AbstractActor,
system: "spawn-system",
command: "sum", # "sum" or :sum
payload: %Io.Eigr.Spawn.Example.MyBusinessMessage{value: 5}
)
{:ok, %Io.Eigr.Spawn.Example.MyBusinessMessage{value: 5}}
iex> SpawnSdk.invoke("actor_name", system: "spawn-system", command: "get")
{:ok, %Io.Eigr.Spawn.Example.MyBusinessMessage{value: 5}}
```
"""
defdelegate invoke(actor_name, invoke_opts), to: SpawnSdk.System.SpawnSystem
@doc """
Spawns a abstract actor
A abstract actor means that you can spawn dynamically the same actor for multiple different names.
It is analog to `DynamicSupervisor`
## Opts
- `system` this is required
- `actor` which actor you will register first argument to
## Examples
```elixir
iex> SpawnSdk.spawn_actor(
"actor_name",
system: "spawn-system",
actor: SpawnSdkExample.Actors.AbstractActor
)
```
"""
defdelegate spawn_actor(actor_name, spawn_actor_opts), to: SpawnSdk.System.SpawnSystem
end