Packages

spawn_sdk

0.6.2
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

HexDocs

Current section

Files

Jump to
Readme
85 Versions
2 Dependencies
Dependants
Files
Activity
spawn_sdk lib system.ex
Raw

lib/system.ex 

defmodule SpawnSdk.System do

  @moduledoc """

  `System` defines the general behavior of the Spawn actor system.

  It is through System implementations that the user can register, invoke,

  and perform other activities with their Actors.

  """

  @type actor_name :: String.t()



  @type actor_mod :: module()



  @type actors :: list(actor_mod())



  @type system :: String.t()



  @type command :: String.t()



  @type payload :: struct()



  @type invoke_opts :: [

          command: command(),

          ref: actor_mod(),

          payload: payload(),

          system: system(),

          async: boolean()

        ]



  @type spawn_actor_opts :: [

          actor: actor_mod(),

          system: system()

        ]



  @callback register(system(), actors()) :: :ok | {:error, term()}



  @callback spawn_actor(actor_name(), spawn_actor_opts()) :: {:ok, term()} | {:error, term()}



  @callback invoke(actor_name(), invoke_opts()) ::

              {:ok, term()} | {:error, term()}

end