mirror of
https://github.com/urbit/shrub.git
synced 2024-09-11 20:27:19 +03:00
Draft Gall docs skeleton
This commit is contained in:
parent
418d4f3ce1
commit
abd19c4e07
63
pkg/arvo/neo/cod/std/src/fil/gall.md
Normal file
63
pkg/arvo/neo/cod/std/src/fil/gall.md
Normal file
@ -0,0 +1,63 @@
|
||||
# Gall
|
||||
|
||||
Gall is Arvo's userspace software vane. Shrubbery interfaces with Gall by accepting subscription updates, {what else?}.
|
||||
|
||||
## Types
|
||||
|
||||
???
|
||||
|
||||
{peer could be subscription, peek is probably a scry?}
|
||||
|
||||
{what is `=< gall` storing?}
|
||||
|
||||
```
|
||||
++ gall
|
||||
=< gall
|
||||
|%
|
||||
+$ gall
|
||||
$: peer=(jug pith pith)
|
||||
peek=(map pith peek:^^gall)
|
||||
==
|
||||
--
|
||||
```
|
||||
|
||||
The Gall shane takes four requests and only gives one response, a `(pair pith sign)` for subscription updates from agents.
|
||||
|
||||
```
|
||||
++ gall
|
||||
|%
|
||||
+$ req
|
||||
$% [%peek p=@dr]
|
||||
[%keep ~]
|
||||
[%reap ~]
|
||||
[%peer ~]
|
||||
==
|
||||
+$ peek [src=(set pith) refresh=@dr]
|
||||
+$ sign sign:agent:^gall
|
||||
+$ res (pair pith sign)
|
||||
--
|
||||
```
|
||||
|
||||
## Tasks
|
||||
|
||||
### `%peek`
|
||||
|
||||
???
|
||||
|
||||
### `%keep`
|
||||
|
||||
???
|
||||
|
||||
### `%reap`
|
||||
|
||||
???
|
||||
|
||||
### `%peer`
|
||||
|
||||
???
|
||||
|
||||
## Gifts
|
||||
|
||||
### `(pair pith sign)`
|
||||
|
||||
Subscription update from a Gall agent, in practice usually `%facts`. The `pith` corresponds to the [`wire`](https://docs.urbit.org/courses/app-school/types#wire) and the `sign` the [`sign:agent:gall`](https://docs.urbit.org/system/kernel/gall/reference/data-types#signagent).
|
Loading…
Reference in New Issue
Block a user