open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rendezvous_websocket.py: add idempotency docs

Browse Source
This commit is contained in:
Brian Warner 2017-02-26 02:30:31 -08:00
parent 8d5770d8cc
commit 65db4729cd
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wormhole/server/rendezvous_websocket.py
View File

@ -38,6 +38,17 @@ from ..util import dict_to_bytes, bytes_to_dict
# has claimed the nameplate has also released it, the nameplate is # has claimed the nameplate has also released it, the nameplate is
# deallocated (but they will probably keep the underlying mailbox open). # deallocated (but they will probably keep the underlying mailbox open).
# "claim" and "release" may only be called once per connection, however calls
# across connections (assuming a consistent "side") are idempotent. [connect,
# claim, disconnect, connect, claim] is legal, but not useful, as is a
# "release" for a nameplate that nobody is currently claiming.
# "open" and "close" may only be called once per connection. They are
# basically idempotent, however "open" doubles as a subscribe action. So
# [connect, open, disconnect, connect, open] is legal *and* useful (without
# the second "open", the second connection would not be subscribed to hear
# about new messages).
# Inbound (client to server) commands are marked as "->" below. Unrecognized # Inbound (client to server) commands are marked as "->" below. Unrecognized
# inbound keys will be ignored. Outbound (server to client) responses use # inbound keys will be ignored. Outbound (server to client) responses use
# "<-". There is no guaranteed correlation between requests and responses. In # "<-". There is no guaranteed correlation between requests and responses. In