ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2025-01-02 03:52:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

conn: describe +fyrd interface to %khan

Browse Source
This commit is contained in:
Jōshin 2022-01-26 21:48:56 -08:00
parent 507ab561aa
commit 997544eb11
No known key found for this signature in database
GPG Key ID: A8BE5A9A521639D0
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
pkg/urbit/vere/io/conn.c
View File

@ -15,15 +15,29 @@
** **
** request-id is a client-supplied atomic identifier that will ** request-id is a client-supplied atomic identifier that will
** be returned along with the response, to allow correlating ** be returned along with the response, to allow correlating
** responses with requests. it may be reused; e.g. 0 could be ** responses with requests.
** supplied every time for a client that doesn't care about
** responses.
** **
** %fyrd is a request to run a thread. its arguments are ** %fyrd is a request to run a thread. its arguments are
** described in the %khan vane, which handles these. it produces ** described in the ++khan section of sys/lull.hoon. to
** either %avow (on success) or %fail (on failure.) ** summarize:
** **
** %peek is a namespace read request (aka scry). they are ** +$ task $%(... [%fyrd p=fyrd]) ::
** +$ fyrd [=bear name=term =mark data=(cask)] :: thread request
** +$ bear $@(desk [desk case]) :: partial +beak
**
** the passed mark is applied to the output. the cask (short for
** (cask *)) at data contains the input mark. e.g. to run -code
** with ~ as input, receiving output as a +tape, with request-id
** set to 32, send the +jam of this noun over the socket with
** newt framing:
**
** [32 %fyrd [%base %code %tape [%noun ~]]]
**
** responses to %fyrd are either %fail if something went wrong
** in the driver, or %avow to indicate success or failure from
** %khan. +avow is: (each (cask) goof).
**
** %peek is a namespace read request (aka scry), and will be
** forwarded directly to arvo. its arguments are the nom of the ** forwarded directly to arvo. its arguments are the nom of the
** external peek interface in arvo, at arm 22. (lyc is always ** external peek interface in arvo, at arm 22. (lyc is always
** `~, i.e. request from self.) that is: ** `~, i.e. request from self.) that is: