Skip to content

Commit 1932e2d

Browse files
committed
Added new sections
1 parent 7500346 commit 1932e2d

File tree

7 files changed

+129
-0
lines changed

7 files changed

+129
-0
lines changed

docs/sdks.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ Spawn currently has or develops SDK for the following languages:
1616
| Rust | 🚧 | https://github.com/eigr/spawn-rust-sdk |
1717
| Spring Boot || https://github.com/eigr/spawn-springboot-sdk |
1818

19+
Full documentation for each language can be found in each of their repositories, but [here](sdks/index.md) we provide a quick introduction to each.
20+
1921
[Back to Index](index.md)
2022

23+
[Jump to language support index](sdks/index.md)
24+
2125
[Next: Custom Resources](crds.md)
2226

2327
[Previous: Getting Started](getting_started.md)

docs/sdks/go/actor_invocation.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Actor Invocation
2+
3+
TODO
4+
5+
[Next: Workflows](workflows.md)
6+
7+
[Previous: Actors](actors.md)

docs/sdks/go/actors.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Go Actors
2+
3+
Spawn defines the following types of Actors:
4+
5+
* **Named Actors**: Named actors are actors whose name is defined at compile time. They also behave slightly differently
6+
Then unnamed actors and pooled actors. Named actors when they are defined with the stateful parameter equal to True are
7+
immediately instantiated when they are registered at the beginning of the program, they can also only be referenced by
8+
the name given to them in their definition.
9+
10+
* **Unnamed Actors**: Unlike named actors, unnamed actors are only created when they are named at runtime, that is,
11+
during program execution. Otherwise, they behave like named actors.
12+
13+
* **Pooled Actors**: Pooled Actors, as the name suggests, are a collection of actors that are grouped under the same name
14+
assigned to them at compile time. Pooled actors are generally used when higher performance is needed and are also
15+
recommended for handling serverless loads.
16+
17+
## Stateless Actors
18+
19+
TODO
20+
21+
## Stateful Actors
22+
23+
TODO
24+
25+
26+
## Considerations about Spawn actors
27+
28+
Another important feature of Spawn Actors is that the lifecycle of each Actor is managed by the platform itself.
29+
This means that an Actor will exist when it is invoked and that it will be deactivated after an idle time in its execution.
30+
This pattern is known as [Virtual Actors](#virtual-actors) but Spawn's implementation differs from some other known
31+
frameworks like [Orleans](https://www.microsoft.com/en-us/research/project/orleans-virtual-actors/) or
32+
[Dapr](https://docs.dapr.io/developing-applications/building-blocks/actors/actors-overview/)
33+
by defining a specific behavior depending on the type of Actor (named, unnamed, pooled, and etc...).
34+
35+
For example, named actors are instantiated the first time as soon as the host application registers them with the Spawn proxy.
36+
Whereas unnamed and pooled actors are instantiated the first time only when they receive their first invocation call.
37+
38+
[Next: Actor Invocation](actor_invocation.md)
39+
40+
[Previous: Getting Started](getting_started.md)

docs/sdks/go/getting_started.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Go Getting Started
2+
3+
TODO
4+
5+
[Next: Actors](actors.md)
6+
7+
[Previous: SDKs](../../sdks.md)

docs/sdks/go/projections.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Go Projections
2+
3+
TODO
4+
5+
[Next: SDKS](../../sdks.md)
6+
7+
[Previous: Workflows](workflows.md)

docs/sdks/go/workflows.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Go Workflows
2+
3+
Spawn has several mechanisms to facilitate integration between your actors or your application with the outside world. Below are some types of integration that Spawn provides:
4+
5+
## Broadcast
6+
7+
TODO
8+
9+
## Side Effects
10+
11+
TODO
12+
13+
## Forward
14+
15+
TODO
16+
17+
## Pipe
18+
19+
TODO
20+
21+
Forwards and pipes do not have an upper thread limit other than the request timeout.
22+
23+
[Next: Projections](projections.md)
24+
25+
[Previous: Actor Invocation](actor_invocation.md)

docs/sdks/index.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Spawn Language Support
2+
3+
# Table of Contents
4+
5+
01. [Dart](dart/getting_started.md)
6+
- 1.2. [Actors](dart/actors.md)
7+
- 1.3. [Actors Invocations](dart/actor_invocation.md)
8+
- 1.4. [Workflows](dart/workflows.md)
9+
- 1.5. [Projections](dart/projections.md)
10+
02. [Elixir](elixir/getting_started.md)
11+
- 2.2. [Actors](elixir/actors.md)
12+
- 2.3. [Actors Invocations](elixir/actor_invocation.md)
13+
- 2.4. [Workflows](elixir/workflows.md)
14+
- 2.5. [Projections](elixir/projections.md)
15+
03. [Go](go/getting_started.md)
16+
- 3.2. [Actors](go/actors.md)
17+
- 3.3. [Actors Invocations](go/actor_invocation.md)
18+
- 3.4. [Workflows](go/workflows.md)
19+
- 3.5. [Projections](go/projections.md)
20+
04. [Java](java/getting_started.md)
21+
- 4.2. [Actors](java/actors.md)
22+
- 4.3. [Actors Invocations](java/actor_invocation.md)
23+
- 4.4. [Workflows](java/workflows.md)
24+
- 4.5. [Projections](java/projections.md)
25+
05. [Node](node/getting_started.md)
26+
- 5.2. [Actors](node/actors.md)
27+
- 5.3. [Actors Invocations](node/actor_invocation.md)
28+
- 5.4. [Workflows](node/workflows.md)
29+
- 5.5. [Projections](node/projections.md)
30+
06. [Python](python/getting_started.md)
31+
- 6.2. [Actors](python/actors.md)
32+
- 6.3. [Actors Invocations](python/actor_invocation.md)
33+
- 6.4. [Workflows](python/workflows.md)
34+
- 6.5. [Projections](python/projections.md)
35+
07. [Rust](rust/getting_started.md)
36+
- 7.2. [Actors](rust/actors.md)
37+
- 7.3. [Actors Invocations](rust/actor_invocation.md)
38+
- 7.4. [Workflows](rust/workflows.md)
39+
- 7.5. [Projections](rust/projections.md)

0 commit comments

Comments
 (0)