Skip to content

Commit 4a4ad2a

Browse files
committed
Tided up docs for the agent module.
1 parent e0c2c2c commit 4a4ad2a

File tree

9 files changed

+163
-141
lines changed

9 files changed

+163
-141
lines changed

docs/downlink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ the agent at `"/node"` on the host `"swim://example.remote:8080"`. Here `OpenVal
7777
a `HandlerAction` that results in a value of type:
7878

7979
```rust
80-
swimos::agent::agent_model::downlink::hosted::ValueDownlinkHandle
80+
swimos::agent::agent_model::downlink::ValueDownlinkHandle
8181
```
8282

8383
This handle can be used to set the value of the remote lane, through the downlink.

example_apps/event_downlink/src/consumer/agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use swimos::agent::{
1616
agent_lifecycle::HandlerContext,
17-
agent_model::downlink::hosted::EventDownlinkHandle,
17+
agent_model::downlink::EventDownlinkHandle,
1818
event_handler::{EventHandler, HandlerAction, HandlerActionExt},
1919
lanes::{CommandLane, ValueLane},
2020
lifecycle, projections,

example_apps/local_downlink/src/consumer/agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use swimos::agent::{
1616
agent_lifecycle::HandlerContext,
17-
agent_model::downlink::hosted::ValueDownlinkHandle,
17+
agent_model::downlink::ValueDownlinkHandle,
1818
event_handler::{EventHandler, HandlerAction, HandlerActionExt},
1919
lanes::{CommandLane, ValueLane},
2020
lifecycle, projections,

example_apps/map_downlink/src/consumer/agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use example_util::format_map;
1616
use swimos::agent::{
1717
agent_lifecycle::HandlerContext,
18-
agent_model::downlink::hosted::MapDownlinkHandle,
18+
agent_model::downlink::MapDownlinkHandle,
1919
event_handler::{EventHandler, HandlerAction, HandlerActionExt},
2020
lanes::{CommandLane, ValueLane},
2121
lifecycle, projections,

example_apps/value_downlink/src/consumer/agent.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
use swimos::agent::{
1616
agent_lifecycle::HandlerContext,
17-
agent_model::downlink::hosted::ValueDownlinkHandle,
17+
agent_model::downlink::ValueDownlinkHandle,
1818
event_handler::{EventHandler, HandlerAction, HandlerActionExt},
1919
lanes::{CommandLane, ValueLane},
2020
lifecycle, projections,

server/swimos_agent/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pub mod agent_lifecycle;
3838
/// and stores.
3939
pub mod agent_model;
4040

41-
/// Configuration types for downlinks started from agent lifecycles.
41+
/// Configuration types for downlinks that are started from agent lifecycles.
4242
pub mod config;
4343

4444
/// Traits and builders for constructing downlink lifecycles for downlinks started from agent lifecycles.

swimos/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ swimos_server_app = { path = "../server/swimos_server_app", optional = true }
2020
swimos_agent = { path = "../server/swimos_agent", optional = true }
2121
swimos_agent_derive = { path = "../server/swimos_agent_derive", optional = true }
2222
swimos_remote = { path = "../runtime/swimos_remote", optional = true}
23+
swimos_form = { path = "../api/swimos_form" }
2324

2425
[dev-dependencies]
2526
parking_lot = { workspace = true }

0 commit comments

Comments
 (0)