You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: server/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Swim unifies the traditionally disparate roles of database, message broker, job
6
6
7
7
Swim implements a general purpose distributed object model. The "objects" in this model are **Web Agents**.
8
8
9
-
[Creating a class](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L13) that extends `swim.api.agent.AbstractAgent` defines a *template* for Web Agents (though not a useful one until we add some [lanes](#lanes)).
9
+
[Creating a class](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L13) that extends `swim.api.agent.AbstractAgent` defines a *template* for Web Agents (though not a useful one until we add some [lanes](#lanes)).
10
10
11
11
Visit the [documentation](https://developer.swim.ai/concepts/agents/) for further details about Web Agents.
12
12
@@ -16,28 +16,28 @@ If Web Agents are objects, then **lanes** serve as the "fields" of those objects
16
16
17
17
Continuing our analogy, *lane callback* functions serve as the "methods" of Web Agents.
18
18
19
-
Each lane type defines a set of overridable (default no-op) lifecycle callbacks. For example, [sending a command message](#sending-data-do-swim) to any command lane will trigger its [`onCommand` callback](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L51-L54). On the other hand, [setting a value lane](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L53) will trigger its `willSet` callback, then update its value, then trigger its [`didSet` callback](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L40-L47).
19
+
Each lane type defines a set of overridable (default no-op) lifecycle callbacks. For example, [sending a command message](#sending-data-do-swim) to any command lane will trigger its [`onCommand` callback](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L51-L54). On the other hand, [setting a value lane](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L53) will trigger its `willSet` callback, then update its value, then trigger its [`didSet` callback](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L40-L47).
20
20
21
21
Visit the [documentation](https://developer.swim.ai/concepts/lanes/) for further details about lanes.
22
22
23
23
## Standing a Swim Server
24
24
25
25
A Swim server is loaded with a **plane**, which provides the runtime for Web Agents and routes messages to the correct lanes.
26
26
27
-
A plane must [declare an `AgentType` field](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L13-L14) for each Web Agent type.
27
+
A plane must [declare an `AgentType` field](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L13-L14) for each Web Agent type.
28
28
29
-
Use the `ServerLoader` utility class to [load a plane into a Swim server](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L18). Note that your module must [`provide``swim.api.plane.Plane` with your custom plane class](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/module-info.java#L8).
29
+
Use the `ServerLoader` utility class to [load a plane into a Swim server](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L18). Note that your module must [`provide``swim.api.plane.Plane` with your custom plane class](http://github.com/swimos/tutorial/tree/master/server/src/main/java/module-info.java#L8).
30
30
31
31
Visit the [documentation](https://developer.swim.ai/concepts) for further details about these concepts.
32
32
33
33
## Populating a Swim Server With Your Data
34
34
35
-
Every Swim server can be written to and read from by external processes using the Swim API. The simplest way to utilize this API is to use a **Swim client** instance to [send commands to command lanes](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L40).
35
+
Every Swim server can be written to and read from by external processes using the Swim API. The simplest way to utilize this API is to use a **Swim client** instance to [send commands to command lanes](http://github.com/swimos/tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L40).
36
36
37
37
Visit the [documentation](https://developer.swim.ai/concepts) for further details about these concepts.
38
38
39
39
## Subscribing to Swim Server Data
40
40
41
-
Swim client instances use Swim **links** to pull data from a Swim lanes. Like their corresponding lanes, links have overridable callback functions that can be used to [populate UIs](http://github.com/swimos/swim-tutorial/tree/master/ui/index.html#L111-L133).
41
+
Swim client instances use Swim **links** to pull data from a Swim lanes. Like their corresponding lanes, links have overridable callback functions that can be used to [populate UIs](http://github.com/swimos/tutorial/tree/master/ui/index.html#L111-L133).
42
42
43
43
Visit the [documentation](https://developer.swim.ai/concepts/links/) for further details about links.
0 commit comments