@@ -1,5 +1,5 @@
2−title = "Ames Public API"
2+title = "Ames"
4template = "doc.html"
4template = "doc.html"
@@ -18,7 +18,7 @@ system/lifecycle tasks.
19## Messaging Tasks
19## Messaging Tasks
21−### %hear
21+### `%hear`
23`%hear` handles raw packet receipt. This `task` only ever originates from Unix.
23`%hear` handles raw packet receipt. This `task` only ever originates from Unix.
24It does the initial processing of a packet, namely by passing the raw packet
24It does the initial processing of a packet, namely by passing the raw packet
@@ -47,7 +47,7 @@ zero or more additional packets via `%send` `gift`s. It may also trigger a `%boo
47or `%plea` `gift` (collectively referred to as a `%memo` within Ames) to a local vane in the case of a completed message.
47or `%plea` `gift` (collectively referred to as a `%memo` within Ames) to a local vane in the case of a completed message.
50−### %heed
50+### `%heed`
52A vane can pass Ames a `%heed` `task` to request Ames track a peer's
52A vane can pass Ames a `%heed` `task` to request Ames track a peer's
53responsiveness. If our `%boon`s to it start backing up locally,
53responsiveness. If our `%boon`s to it start backing up locally,
@@ -73,7 +73,7 @@ Ames will `give` a `%clog` `gift` to the requesting vane containing the
73unresponsive peer's urbit address.
73unresponsive peer's urbit address.
76−### %hole
76+### `%hole`
78`%hole` handles packet crash notification. `%hole` works much like `%hear`, in
78`%hole` handles packet crash notification. `%hole` works much like `%hear`, in
79that it passes an incoming raw packet to `+decode-packet` to be deserialized,
79that it passes an incoming raw packet to `+decode-packet` to be deserialized,
@@ -95,7 +95,8 @@ message (typically an IP address).
95Like `%hear`, `%hole` can trigger additional packets in the form of `%send`
95Like `%hear`, `%hole` can trigger additional packets in the form of `%send`
96`gift`s, and may also yield a `%boon` or `%plea` `gift` to a local vane.
96`gift`s, and may also yield a `%boon` or `%plea` `gift` to a local vane.
98−### %jilt
99+### `%jilt`
100`%jilt` stops tracking a potentially unresponsive peer that was previously being
101`%jilt` stops tracking a potentially unresponsive peer that was previously being
101tracked as a result of the `%heed` `task`.
102tracked as a result of the `%heed` `task`.
@@ -114,7 +115,8 @@ The `ship` we no longer wish to track.
115This `task` returns no `gift`s.
116This `task` returns no `gift`s.
117−### %plea
119+### `%plea`
119`%plea` is the `task` used to send messages over Ames. It extends the
121`%plea` is the `task` used to send messages over Ames. It extends the
120`%pass`/`%give` semantics across the network. As such, it is the most
122`%pass`/`%give` semantics across the network. As such, it is the most
@@ -146,7 +148,7 @@ This `task` returns no `gift`s.
147## System and Lifecycle Tasks
149## System and Lifecycle Tasks
149−### %born
151+### `%born`
151Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.
153Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.
@@ -159,7 +161,7 @@ Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.
159In response to a `%born` `task`, Ames `%give`s Jael a `%turf` `gift`.
161In response to a `%born` `task`, Ames `%give`s Jael a `%turf` `gift`.
162−### %crud
164+### `%crud`
164`%crud` is called whenever an error involving Ames occurs. It produces a crash
166`%crud` is called whenever an error involving Ames occurs. It produces a crash
165report in response.
167report in response.
@@ -178,7 +180,7 @@ Ames does not `give` a `gift` in response to a `%crud` `task`, but it does
178`%pass` Dill a `%flog` `task` instructing it to print `error`.
180`%pass` Dill a `%flog` `task` instructing it to print `error`.
181−## %init
183+## `%init`
183`%init` is called a single time during the very first boot process, immediately
185`%init` is called a single time during the very first boot process, immediately
184after the [larval stage](@/docs/tutorials/arvo/arvo.md#larval-stage-core)
186after the [larval stage](@/docs/tutorials/arvo/arvo.md#larval-stage-core)
@@ -206,7 +208,7 @@ our=ship
206`%init` sends two moves that subscribe to `%turf` and `%private-keys` in Jael.
208`%init` sends two moves that subscribe to `%turf` and `%private-keys` in Jael.
209−### %sift
211+### `%sift`
211This `task` filters debug output by ship.
213This `task` filters debug output by ship.
@@ -223,7 +225,7 @@ The list of ships for which debug output is desired.
223This `task` returns no `gift`s.
225This `task` returns no `gift`s.
226−### %spew
228+### `%spew`
228Sets verbosity toggles on debug output. These toggles are as follows.
230Sets verbosity toggles on debug output. These toggles are as follows.
@@ -256,7 +258,7 @@ verbs=(list verb)
256This `task` returns no `gift`s.
258This `task` returns no `gift`s.
259−### %vega
261+### `%vega`
261`%vega` is called whenever the kernel is updated. Ames currently does not do
263`%vega` is called whenever the kernel is updated. Ames currently does not do
262anything in response to this.
264anything in response to this.
@@ -270,7 +272,7 @@ anything in response to this.
270This `task` returns no `gift`s.
272This `task` returns no `gift`s.
273−### %wegh
275+### `%wegh`
275This `task` is a request to Ames to produce a memory usage report.
277This `task` is a request to Ames to produce a memory usage report.