7f514a9 · urbit.org · git.iko.soy

reference/vane-apis/airlock.md+8−2

compare with master

unifiedsplit

@@ -1,3 +1,9 @@

1++++

2+title = "Airlock"

3+weight = 1

4+template = "doc.html"

5++++

6+

1# Airlock

7# Airlock

2

8

3Airlock is the term to describe the set of APIs for interacting with a running Urbit ship from outside of the Urbit network.

9Airlock is the term to describe the set of APIs for interacting with a running Urbit ship from outside of the Urbit network.

@@ -35,7 +41,7 @@ It consists of a single class `Urlock`. Methods are below.

35

41

36`ack(eventId)`

42`ack(eventId)`

37

43

38− Send an acknowledgment of receipt of a message so it's cleared from the ship's queue

44+ Send an acknowledgment of receipt of a message so it's cleared from the ship's queue

39

45

40 `eventId` - id of the event to acknowledge

46 `eventId` - id of the event to acknowledge

41

47

@@ -56,7 +62,7 @@ It consists of a single class `Urlock`. Methods are below.

56

62

57Below is a simple script to send a message and subscribe to a chat channel. The specifics require an understanding of the `chat-store` and `chat-hook` interfaces.

63Below is a simple script to send a message and subscribe to a chat channel. The specifics require an understanding of the `chat-store` and `chat-hook` interfaces.

58

64

59−Even without experience with python this should be pretty readable.

65+Even without experience with python this should be pretty readable.

60

66

61```

67```

62#!/usr/bin/python3

68#!/usr/bin/python3

reference/vane-apis/ames.md+7−7

@@ -1,6 +1,6 @@

1+++

2title = "Ames Public API"

3−weight = 1

3+weight = 2

4template = "doc.html"

5+++

6

@@ -31,7 +31,7 @@ There are multiple `+on-hear` arms in `ames.hoon`. Here we refer to

31primarily for ack and nack processing, or receiving message fragments.

32

33#### Accepts

34−

34+

35```hoon

36[=lane =blob]

37```

@@ -44,7 +44,7 @@ message (typically an IP address).

44

45`%hear` can trigger a number of possible returns. It can trigger the release of

46zero or more additional packets via `%send` `gift`s. It may also trigger a `%boon`

47−or `%plea` `gift` (collectively referred to as a `%memo` within Ames) to a local vane in the case of a completed message.

47+or `%plea` `gift` (collectively referred to as a `%memo` within Ames) to a local vane in the case of a completed message.

48

49

50### %heed

@@ -79,7 +79,7 @@ unresponsive peer's urbit address.

79that it passes an incoming raw packet to `+decode-packet` to be deserialized,

80and then passes that data along with the source of the packet to

81`+on-hear-packet` along with a `?` set to `%.n` denoting that there is something wrong with

82−the packet.

82+the packet.

83

84#### Accepts

85

@@ -157,7 +157,7 @@ Each time you start your Urbit, the Arvo kernel calls the `%born` task for Ames.

157#### Returns

158

159In response to a `%born` `task`, Ames `%give`s Jael a `%turf` `gift`.

160−

160+

161

162### %crud

163

@@ -175,7 +175,7 @@ A `$error` is a `[tag=@tas =tang]`.

175#### Returns

176

177Ames 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`.

178+`%pass` Dill a `%flog` `task` instructing it to print `error`.

179

180

181## %init

@@ -194,7 +194,7 @@ contained by Jael.

194our=ship

195```

196

197−`%init` takes in the name of our ship, which is a `@p`.

197+`%init` takes in the name of our ship, which is a `@p`.

198

199#### Returns

200

reference/vane-apis/behn.md+5−5

@@ -1,6 +1,6 @@

1+++

2title = "Behn"

3−weight = 2

3+weight = 3

4template = "doc.html"

5+++

6

@@ -60,7 +60,7 @@ The most common error that occurs is when Behn tries to `%wake` up a program tha

60the entire event (i.e. sequence of `move`s) that led up to the `%wake` is thrown

61away, and Vere then causes the kernel to `pass` Behn a `%crud` `task` containing

62the stack trace.

63−

63+

64

65### `%drip`

66

@@ -155,7 +155,7 @@ This `task` is sent by the interpreter in order to free up memory.

155

156#### Accepts

157

158−This `task` has no arguments.

158+This `task` has no arguments.

159

160#### Returns

161

@@ -185,7 +185,7 @@ This `task` takes in a `@da` which Behn then adds to `timers.state`, the list of

185```hoon

186@da

187```

188−

188+

189#### Returns

190

191This `task` returns a `%wake` `gift` once the timer has fired.

@@ -196,7 +196,7 @@ This `task` returns a `%wake` `gift` once the timer has fired.

196This `task` is sent by the kernel when the Unix timer tells the kernel that it

197is time for Behn to wake up. This is often caused by a `%doze` `gift` that

198Behn originally sent to the kernel that is then forwarded to Unix, which is

199−where the real timekeeping occurs.

199+where the real timekeeping occurs.

200

201Upon receiving this `task`, Behn processes the elapsed timer and then sets

202`:next-wake`.

reference/vane-apis/dill.md+9−9

@@ -1,6 +1,6 @@

1+++

2title = "Dill"

3−weight = 3

3+weight = 4

4template = "doc.html"

5+++

6

@@ -21,7 +21,7 @@ tasks](#dill-tasks) section and an [Arvo tasks](#arvo-tasks) section.

21### `%belt`

22

23Every keystroke entered into the console triggers a `%belt` `task` for Dill which contains information about the keystroke, such as which key was pressed

24−and from which terminal.

24+and from which terminal.

25

26#### Accepts

27

@@ -73,7 +73,7 @@ This `task` is used only once, when Arvo first enters the [adult

73stage](@/docs/tutorials/arvo/arvo.md#structural-interface-core). Dill is

74technically the first vane to be activated, via the `%boot` `task`, which then

75send Jael (considered the the "true" first vane) an `%init` `task`, which then goes on to

76−call `%init` `task`s for other vanes (including Dill).

76+call `%init` `task`s for other vanes (including Dill).

77

78#### Accepts

79

@@ -103,7 +103,7 @@ error message is set by `$log-level`, which is either `%hush`, `%soft`, or `%lou

103

104#### Returns

105

106−`%crud` does not return a `gift`.

106+`%crud` does not return a `gift`.

107

108

109### `%flog`

@@ -151,7 +151,7 @@ causing the terminal to redraw itself (?)

151### `%heft`

152

153`%heft` causes Dill to `pass` a `%wegh` `task` to all other vanes (but not to

154−itself), thus obtaining a complete digest of Arvo's memory usage.

154+itself), thus obtaining a complete digest of Arvo's memory usage.

155

156#### Accepts

157

@@ -172,7 +172,7 @@ This task is not used.

172

173### `%harm`

174

175−This `task` is not used.

175+This `task` is not used.

176

177

178### `%init`

@@ -277,7 +277,7 @@ This `task` returns no `gift`s.

277### `%vega`

278

279This is a common vane `task` used to inform the vane that the kernel has been

280−upgraded. Dill does not do anything in response to this.

280+upgraded. Dill does not do anything in response to this.

281

282#### Accepts

283

@@ -310,7 +310,7 @@ This `task` updates the kernel.

310

311#### Returns

312

313−This `task` returns no `gift`s.

313+This `task` returns no `gift`s.

314

315

316### `%pack`

@@ -333,7 +333,7 @@ This `task` returns no `gift`s.

333### `%veer`

334

335This `task` is used to install `zuse` and vanes. It is handled by `+veer` in

336−`arvo.hoon`.

336+`arvo.hoon`.

337

338#### Accepts

339

reference/vane-apis/gall.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Gall"

3−weight = 4

3+weight = 5

4template = "doc.html"

5+++

6

reference/vane-apis/iris.md+6−6

@@ -1,6 +1,6 @@

1+++

2title = "Iris Public API"

3−weight = 5

3+weight = 6

4template = "doc.html"

5+++

6

@@ -45,7 +45,7 @@ to each outstanding connection.

45This `task` cancels a previous fetch. Iris knows which request is meant based on the

46`duct` that the `task` comes on.

47

48− We note that `%cancel-request` is also a `gift` that Iris can `%give`.

48+ We note that `%cancel-request` is also a `gift` that Iris can `%give`.

49

50#### Accepts

51

@@ -62,7 +62,7 @@ Receiving this `task` causes Iris to `%give`s a `%cancel-request` `gift` to Unix

62which then cancels the request in the runtime. See [Returns to Unix](#returns-to-unix).

63

64`id` is obtained via a `(map duct @ud)`, with the `duct` corresponding to one along

65−which the `%cancel-request` `task` came with.

65+which the `%cancel-request` `task` came with.

66

67

68### `%crud`

@@ -128,9 +128,9 @@ A `$request` consists of the following:

128 - `=method`, the http method, which is one of `CONNECT`, `DELETE`, `GET`,

129 `HEAD`, `OPTIONS`, `POST`, `PUT`, and `TRACE`.

130 - `url=@t`, the URL being requested

131− - `=header-list`, a list of headers to pass with the request,

131+ - `=header-list`, a list of headers to pass with the request,

132 - `body=(unit octs)`, optional data to include in the request.

133−

133+

134 A `$outbound-config` contains the number of redirects and retries that Iris

135 will attempt. By default this is 5 redirects (the recommended limit for the

136 http standard) and 3 retries.

@@ -143,7 +143,7 @@ A `$request` consists of the following:

143Iris will `%give` a `%request` `gift` to Unix in response to a `%request`

144`task`. See [Returns to Unix](#returns-to-unix). This `gift`

145contains the `request` in the original `task` as well as the ID number assigned

146−by Iris for that particular http connection, which is extracted from the input `task`.

146+by Iris for that particular http connection, which is extracted from the input `task`.

147

148

149### `%trim`

tutorials/arvo/arvo.md+1−1

@@ -261,7 +261,7 @@ which applies many of the concepts covered below.

261 + Larval stage core

262 + Formal interface

263

264−See [Section 1.7](@/docs/tutorials/hoon/arms-and-cores.md#core-nesting) of the Hoon tutorial for further explanation of what is meant here by "nesting". We now describe the functionality of each of these components.

264+See [Section 1.7](@/docs/tutorials/hoon/arms-and-cores.md) of the Hoon tutorial for further explanation of what is meant here by "nesting". We now describe the functionality of each of these components.

265

266### Formal interface

267

tutorials/hoon/arms-and-cores.md+3−3

@@ -181,7 +181,7 @@ To reinforce your newfound understanding of arms and cores, let's go over the va

181

182### Address-Based Wings

183

184−In the [previous lesson](@/docs/tutorials/hoon/the-subject-and-its-legs), you saw how the following expressions return legs based on an address in the subject: `+n`, `.`, `-`, `+`, `+>`, `+<`, `->`, `-<`, `&`, `|` etc. When these resolve to the part of the subject containing an arm, they **don't** evaluate the arm. They simply return the indicated noun fragment of the subject, as if it were a leg.

184+In the [previous lesson](@/docs/tutorials/hoon/the-subject-and-its-legs.md), you saw how the following expressions return legs based on an address in the subject: `+n`, `.`, `-`, `+`, `+>`, `+<`, `->`, `-<`, `&`, `|` etc. When these resolve to the part of the subject containing an arm, they **don't** evaluate the arm. They simply return the indicated noun fragment of the subject, as if it were a leg.

185

186Let's use `-.c` to look at the head of `c`, i.e., the battery of the core:

187

@@ -485,7 +485,7 @@ This core has one arm `dec` which implements decrement. If we look at the head o

485 1

486]

487```

488−

488+

489Again, being able to read Nock is not essential to understanding Hoon.

490

491### Cores and Contexts

@@ -513,7 +513,7 @@ context of other cores.

513++ foo

514 |= a=@

515 (mul a 2)

516−--

516+--

517|%

518++ bar

519 |= a=@