on master help sign in
gall-guide: types - add comments and links about wires in arvo
c9e9907Tinnus Napbus
content/docs/userspace/gall-guide/types.md+12−3
@@ -206,9 +206,18 @@ to the `path` `/some/path` on another agent, you also specify `/some/wire`.
206Then, when that agent sends out updates to subscribers of `/some/path`, your
206Then, when that agent sends out updates to subscribers of `/some/path`, your
207agent receives them on `/some/wire`.
207agent receives them on `/some/wire`.
208
208
209+More formally, `wire`s are used by Arvo to represent an event cause, and
210+therefore return path, in a call stack called a
211+[`duct`](/docs/arvo/overview#duct). Inter-vane communications happen over
212+`duct`s as [`move`](/docs/arvo/overview#moves)s, and Gall converts the `card`s
213+produced by agents into such `move`s behind the scenes. A detailed understanding
214+of this system is not necessary to write Gall agents, but if you're interested
215+it's comprehensively documented in the [Arvo
216+overview](/docs/arvo/overview#move).
217+
209−The `wire` is specified in the second argument of a `%pass` `card`. It's used
218+For agents, the `wire` is specified in the second argument of a `%pass` `card`.
210−for anything you can `%pass`, such as `%poke`s, `%watch`es, and `%arvo` notes.
219+It's used for anything you can `%pass`, such as `%poke`s, `%watch`es, and
211−For example:
220+`%arvo` notes. For example:
212
221
213```hoon
222```hoon
214[%pass /this/is/wire %agent [~zod %foobar] %watch /this/is/path]
223[%pass /this/is/wire %agent [~zod %foobar] %watch /this/is/path]