summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-09-12 14:24:56 +0100
committerDavid Baker <dbkr@matrix.org>2014-09-12 14:24:56 +0100
commit09a59ce2d314764e2d11548c3df4a28b91de8966 (patch)
tree1ac23da99ada5f23d68868c3f1fc790d05ebc7d1 /docs
parentAlways pick the incoming call if we've not yet sent out our invite, otherwise... (diff)
downloadsynapse-09a59ce2d314764e2d11548c3df4a28b91de8966.tar.xz
Some words about glare
Diffstat (limited to '')
-rw-r--r--docs/specification.rst28
1 files changed, 27 insertions, 1 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index b15792c00d..aad200c04d 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -1249,7 +1249,33 @@ Or a rejected call:
                  <------- m.call.hangup
 
 Calls are negotiated according to the WebRTC specification.
- 
+
+
+Glare
+-----
+This specification aims to address the problem of two users calling each other
+at roughly the same time and their invites crossing on the wire. It is a far
+better experience for the users if their calls are connected if it is clear
+that their intention is to set up a call with one another.
+
+In Matrix, calls are to rooms rather than users (even if those rooms may only
+contain one other user) so we consider calls which are to the same room.
+
+The rules for dealing with such a situation are as follows:
+
+ - If an invite to a room is received whilst the client is preparing to send an
+   invite to the same room, the client should cancel its outgoing call and
+   instead automatically accept the incoming call on behalf of the user.
+ - If an invite to a room is received after the client has sent an invite to the
+   same room and is waiting for a response, the client should perform a
+   lexicographical comparison of the call IDs of the two calls and use the
+   lesser of the two calls, aborting the greater. If the incoming call is the
+   lesser, the client should accept this call on behalf of the user.
+
+The call setup should appear seamless to the user as if they had simply placed
+a call and the other party had accepted. Thusly, any media stream that had been
+setup for use on a call should be transferred and used for the call that
+replaces it.
  
 Profiles
 ========