summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6e0d488..a474147 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,15 @@ Submit `.version` first. Drain `output()` through your transport and report the
number sent with `wrote()`. Feed received bytes using `push()` and collect tagged
results with `take()`. All base requests are available through `Client.Request`.
+`Fsys` is that client on a socket, blocking, one call at a time (plan9port's
+lib9pclient): `dial(io, env, "pardes/main", user)` takes a name posted in the
+registry, `unix!PATH` or `tcp!HOST!PORT`; then `open`, `create`, `remove`,
+`stat`, `read`, `write` and `clunk` by path and fid, and `readFile`,
+`writeFile` and `ask` (write, then read the answer on that open from 0) for
+the common shapes, streaming into a `std.Io.Writer`. A refusal is
+`error.Refused` and `said()` holds the server's words. Its buffers are in the
+struct: no allocator.
+
For a server, call `Server.receive()` after `push()`. A request borrows the input
until `release()`. After releasing backend fids and canceling outstanding work,
answer Tversion with `negotiate()`. Answer other requests with `reply()`. The