View Source API Reference spawn_sdk v1.3.1

Modules

Spawn Elixir SDK is the support library for the Spawn Actors System. Spawn is a Stateful Serverless Platform for providing the multi-language Actor Model. For a broader understanding of Spawn, please consult its official repository.

Documentation for Actor.

Subscriber is a helper module to subscribe Phoenix.PubSub channels

The context is responsible for sending the State information as well as its metadata to the Actor and the Proxy and vice versa.

Define actions like a Elixir functions

Actors can also send messages to a group of actors at once as an action callback. This we call Broadcast.

Forward allows the Actor to delegate processing of the incoming message to another Actor. This is done as part of the actor's response flow. Forwards are detached from the Actor that received the input, that is, when you forward a message to another actor, the actor that performs the forwarding is free to process another message and the actor that is receiving the forwarding will respond to the original caller.

Pipe allows the Actor to send its output message directly to another Actor, where the Actor that receives the Pipe will be responsible for following the flow from then on. This is done as part of the actor's response flow. Pipes are detached from the Actor that received the input, that is, when you forward a message to another actor through a Pipe, the actor that performs the Pipe is free to process another message and the actor that is receiving the Pipe is the one who will respond to the original caller.

Actors can also emit side effects to other Actors as part of their response. Side effects do not interfere with an actor's request-response flow. They will "always" be processed asynchronously and any response sent back from the Actor receiving the effect will be ignored by the effector.

Implements the communication protocol between Elixir SDK and Sidecar.

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.

Documentation for System.Supervisor.

Value is a declarative DSL that provides the Domain Driven aspect of the Spawn technology. It is through a Value that the user can configure the proxy to carry out the infrastructure tasks and from which it provides all the Worflows.