git.iko.soy/urbit.org
on master help sign in
fix remaining arvo headers
9c68bd0tinnus-napbus
content/docs/arvo/eyre/tasks.md+15−15
compare with master
unifiedsplit
@@ -20,7 +20,7 @@ This `task` notifies Eyre of the listening HTTPS and HTTP ports. It is automatic
20
20
21The `insecure` field is the HTTP port and `secure` is the optional HTTPS port.
21The `insecure` field is the HTTP port and `secure` is the optional HTTPS port.
22
22
23−### Returns
23+#### Returns
24
24
25Eyre returns no `gift` in response to a `%live` `task`.
25Eyre returns no `gift` in response to a `%live` `task`.
26
26
@@ -34,7 +34,7 @@ This `task` either configures HTTPS with a certificate and keypair, or configure
34
34
35The [$http-rule](/docs/arvo/eyre/data-types#http-rule) is either tagged with `%cert` or `%turf`. A `%cert` `http-rule` sets an HTTPS certificate and keypair or removes it if null. A `%turf` `http-rule` either adds or removes a DNS binding depending on whether the `action` is `%put` or `%del`. Note that using `%turf` will automatically cause the system to try and obtain a certificate and keypair via Letsencrypt.
35The [$http-rule](/docs/arvo/eyre/data-types#http-rule) is either tagged with `%cert` or `%turf`. A `%cert` `http-rule` sets an HTTPS certificate and keypair or removes it if null. A `%turf` `http-rule` either adds or removes a DNS binding depending on whether the `action` is `%put` or `%del`. Note that using `%turf` will automatically cause the system to try and obtain a certificate and keypair via Letsencrypt.
36
36
37−### Returns
37+#### Returns
38
38
39Eyre returns no `gift` in response to a `%rule` `task`.
39Eyre returns no `gift` in response to a `%rule` `task`.
40
40
@@ -48,7 +48,7 @@ This `task` is how Eyre receives an inbound HTTP request. It will ordinarily be
48
48
49The `secure` field says whether it's over HTTPS. The `address` is the IP address from which the request originated. The [$request:http](/docs/arvo/eyre/data-types#requesthttp) is the HTTP request itself containing the method, URL, headers, and body.
49The `secure` field says whether it's over HTTPS. The `address` is the IP address from which the request originated. The [$request:http](/docs/arvo/eyre/data-types#requesthttp) is the HTTP request itself containing the method, URL, headers, and body.
50
50
51−### Returns
51+#### Returns
52
52
53Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
53Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
54
54
@@ -60,7 +60,7 @@ Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the
60
60
61This `task` is how Eyre receives an inbound HTTP request over the local loopback port. It behaves the same and takes the same arguments as in the [%request](#request) example except it skips any normally required authentication. Just like for a [%request](#request) `task`, you'd not normally use this manually.
61This `task` is how Eyre receives an inbound HTTP request over the local loopback port. It behaves the same and takes the same arguments as in the [%request](#request) example except it skips any normally required authentication. Just like for a [%request](#request) `task`, you'd not normally use this manually.
62
62
63−### Returns
63+#### Returns
64
64
65Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
65Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the contents of the `%request`, state of the connection, and other factors.
66
66
@@ -74,7 +74,7 @@ This `task` is sent to Eyre by the runtime when an HTTP client closes its previo
74
74
75This `task` takes no arguments.
75This `task` takes no arguments.
76
76
77−### Returns
77+#### Returns
78
78
79Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the state of the connection and other factors.
79Eyre may `pass` a `%response` `gift` on the appropriate `duct` depending on the state of the connection and other factors.
80
80
@@ -98,7 +98,7 @@ The `cage` of the second and subsequent `fact`s must have a `mark` of `%http-res
98
98
99Finally, once you've sent all the `fact`s you want, you can `kick` Eyre's subscription and it will complete the response and close the connection to the HTTP client.
99Finally, once you've sent all the `fact`s you want, you can `kick` Eyre's subscription and it will complete the response and close the connection to the HTTP client.
100
100
101−### Returns
101+#### Returns
102
102
103Eyre will respond with a `%bound` `gift` which says whether the binding was successful and looks like:
103Eyre will respond with a `%bound` `gift` which says whether the binding was successful and looks like:
104
104
@@ -108,7 +108,7 @@ Eyre will respond with a `%bound` `gift` which says whether the binding was succ
108
108
109The `accepted` field says whether the binding succeeded and the `binding` is the requested binding described above.
109The `accepted` field says whether the binding succeeded and the `binding` is the requested binding described above.
110
110
111−### Example
111+#### Example
112
112
113See the [Direct HTTP Handling With Gall Agents](/docs/arvo/eyre/examples#direct-http-handling-with-gall-agents) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
113See the [Direct HTTP Handling With Gall Agents](/docs/arvo/eyre/examples#direct-http-handling-with-gall-agents) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
114
114
@@ -140,11 +140,11 @@ The `?` says whether the HTTP request contained a valid session cookie and the [
140
140
141The `simple-payload:http` returned by the generator is similar to the response described in the [%connect](#connect) section except the HTTP headers and body are all contained in the one response rather than staggered across several.
141The `simple-payload:http` returned by the generator is similar to the response described in the [%connect](#connect) section except the HTTP headers and body are all contained in the one response rather than staggered across several.
142
142
143−### Returns
143+#### Returns
144
144
145Eyre will return a `%bound` `gift` as described at the end of the [%connect](#connect) section.
145Eyre will return a `%bound` `gift` as described at the end of the [%connect](#connect) section.
146
146
147−### Example
147+#### Example
148
148
149See the [Generators](/docs/arvo/eyre/examples#generators) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
149See the [Generators](/docs/arvo/eyre/examples#generators) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
150
150
@@ -158,7 +158,7 @@ This `task` deletes a URL binding previously set by a `%connect` or `%serve` `ta
158
158
159The [$binding](/docs/arvo/eyre/data-types#binding) is the URL path and domain of the binding you want to delete.
159The [$binding](/docs/arvo/eyre/data-types#binding) is the URL path and domain of the binding you want to delete.
160
160
161−### Returns
161+#### Returns
162
162
163Eyre returns no `gift` in response to a `%disconnect` `task`.
163Eyre returns no `gift` in response to a `%disconnect` `task`.
164
164
@@ -172,7 +172,7 @@ This `task` tells Eyre that the web login code has changed, causing Eyre to thro
172
172
173This `task` takes no arguments.
173This `task` takes no arguments.
174
174
175−### Returns
175+#### Returns
176
176
177Eyre returns no `gift` in response to a `%code-changed` `task`.
177Eyre returns no `gift` in response to a `%code-changed` `task`.
178
178
@@ -186,11 +186,11 @@ This `task` tells Eyre to start responding positively to CORS requests for the s
186
186
187The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want to approve.
187The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want to approve.
188
188
189−### Returns
189+#### Returns
190
190
191Eyre returns no `gift` in response to a `%approve-origin` `task`.
191Eyre returns no `gift` in response to a `%approve-origin` `task`.
192
192
193−### Example
193+#### Example
194
194
195See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
195See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
196
196
@@ -204,10 +204,10 @@ This `task` tells Eyre to start responding negatively to CORS requests for the s
204
204
205The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want want to reject.
205The [$origin](/docs/arvo/eyre/data-types#origin) is a CORS origin like `http://foo.example` you want want to reject.
206
206
207−### Returns
207+#### Returns
208
208
209Eyre returns no `gift` in response to a `%reject-origin` `task`.
209Eyre returns no `gift` in response to a `%reject-origin` `task`.
210
210
211−### Example
211+#### Example
212
212
213See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
213See the [Managing CORS Origins](/docs/arvo/eyre/examples#managing-cors-origins) section of the [Examples](/docs/arvo/eyre/examples) document for an example.
content/docs/arvo/iris/tasks.md+3−3
@@ -18,7 +18,7 @@ The [$request:http](/docs/arvo/eyre/data-types#requesthttp) is the request itsel
18
18
19The [$outbound-config](/docs/arvo/iris/data-types#outbound-config) specifies the number of redirects to follow before failing and the number of retries to attempt before giving up. The default values are `5` and `3` respectively. As of writing, **retries and auto-following redirects are not implemented**, so what you specify here is irrelevant and you can just use the bunt value of `outbound-config`.
19The [$outbound-config](/docs/arvo/iris/data-types#outbound-config) specifies the number of redirects to follow before failing and the number of retries to attempt before giving up. The default values are `5` and `3` respectively. As of writing, **retries and auto-following redirects are not implemented**, so what you specify here is irrelevant and you can just use the bunt value of `outbound-config`.
20
20
21−### Returns
21+#### Returns
22
22
23Iris returns a `%http-response` `gift` in response to a `%request` task. A `%response` `gift` looks like:
23Iris returns a `%http-response` `gift` in response to a `%request` task. A `%response` `gift` looks like:
24
24
@@ -32,7 +32,7 @@ The `client-response` structure specifies three kinds of responses - `%progress`
32
32
33Note that neither `%progress` partial messages nor `%cancel` responses have been implemented in Vere at the time of writing, so **you will only ever receive a single `%http-response` `gift` with a `%finished` `client-response`**. If the request fails for some reason, you'll still get an empty `%finished` `client-response` with a `504` status code.
33Note that neither `%progress` partial messages nor `%cancel` responses have been implemented in Vere at the time of writing, so **you will only ever receive a single `%http-response` `gift` with a `%finished` `client-response`**. If the request fails for some reason, you'll still get an empty `%finished` `client-response` with a `504` status code.
34
34
35−### Example
35+#### Example
36
36
37See the [Example](/docs/arvo/iris/example) document.
37See the [Example](/docs/arvo/iris/example) document.
38
38
@@ -46,7 +46,7 @@ Cancel a previous request to fetch a remote HTTP resource.
46
46
47A `%cancel-request` `task` does not take any arguments, the [request](#request) to cancel is determined implicitly.
47A `%cancel-request` `task` does not take any arguments, the [request](#request) to cancel is determined implicitly.
48
48
49−### Returns
49+#### Returns
50
50
51Iris does not return any `gift` in response to a `%cancel-request` `task`. You will also not receive any `gift` back from the original `%request` `task` you've cancelled.
51Iris does not return any `gift` in response to a `%cancel-request` `task`. You will also not receive any `gift` back from the original `%request` `task` you've cancelled.
52
52