Mercurial > nomad > old-fuse
changeset 140:2d53c59b31b7
docs: document restrictions of when fs RPCs can execute
This closes #32.
Signed-off-by: Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
| author | Josef 'Jeff' Sipek <jeffpc@josefsipek.net> |
|---|---|
| date | Sun, 18 Oct 2015 12:14:07 -0400 |
| parents | b2cc6b793df1 |
| children | 284620d22c0a |
| files | docs/fs-protocol.md |
| diffstat | 1 files changed, 25 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/fs-protocol.md Sun Oct 18 10:40:00 2015 -0400 +++ b/docs/fs-protocol.md Sun Oct 18 12:14:07 2015 -0400 @@ -37,6 +37,10 @@ This is a simple no-operation. +Limitations +----------- +None. + LOGIN (0x0001) ============== @@ -54,6 +58,11 @@ ------- * obj handle of root +Limitations +----------- +At most one successful LOGIN is allowed per connection. All LOGIN attempts +after a successful LOGIN will fail with `EALREADY`. + STAT (0x0002) ============= @@ -68,6 +77,10 @@ ------- * attributes +Limitations +----------- +Fails with `EPROTO` if the client hasn't gotten a successful LOGIN. + LOOKUP (0x0003) =============== @@ -99,6 +112,10 @@ directory version to get incremented. Since the directory didn't get replaced (it got modified only), it's oid will stay the same. +Limitations +----------- +Fails with `EPROTO` if the client hasn't gotten a successful LOGIN. + CREATE (0x0004) =============== @@ -118,6 +135,10 @@ ------- * new file/dir/etc.'s obj handle +Limitations +----------- +Fails with `EPROTO` if the client hasn't gotten a successful LOGIN. + REMOVE (0x0005) =============== @@ -134,6 +155,10 @@ THOUGHT: Should this RPC also take an obj handle of the object we want to remove? +Limitations +----------- +Fails with `EPROTO` if the client hasn't gotten a successful LOGIN. + Other RPCs that may end up useful =================================