wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1619 from turt2live/travis/c2s/local-echo

Browse source 
Reference that transaction IDs may be used to echo
This commit is contained in:
Travis Ralston 2018-08-31 09:48:02 -06:00 • committed by GitHub
commit f72c821be4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1619.clarification Normal file
View file

@ -0,0 +1 @@
Add a note that clients may use the transaction ID to avoid flickering when doing local echo.

11
specification/modules/instant_messaging.rst
View file

@ -173,9 +173,14 @@ message which they receive from the event stream. The echo of the same message
from the event stream is referred to as "remote echo". Both echoes need to be from the event stream is referred to as "remote echo". Both echoes need to be
identified as the same message in order to prevent duplicate messages being identified as the same message in order to prevent duplicate messages being
displayed. Ideally this pairing would occur transparently to the user: the UI displayed. Ideally this pairing would occur transparently to the user: the UI
would not flicker as it transitions from local to remote. Flickering cannot be would not flicker as it transitions from local to remote. Flickering can be
fully avoided in the current client-server API. Two scenarios need to be reduced through clients making use of the transaction ID they used to send
considered: a particular event. The transaction ID used will be included in the event's
``unsigned`` data as ``transaction_id`` when it arrives through the event stream.
Clients unable to make use of the transaction ID are more likely to experience
flickering due to the following two scenarios, however the effect can be mitigated
to a degree:
- The client sends a message and the remote echo arrives on the event stream - The client sends a message and the remote echo arrives on the event stream
*after* the request to send the message completes. *after* the request to send the message completes.