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

Make clear that the /sync timeout is zero by default

Browse source
This commit is contained in:
Richard van der Hoff 2017-08-31 16:56:50 +01:00
parent b0ea6038c6
commit 1e3f5683c8
2 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

10
specification/client_server_api.rst
View file

@ -949,11 +949,11 @@ You can visualise the range of events being returned as::
Clients then receive new events by "long-polling" the homeserver via the
``/sync`` API, passing the value of the ``next_batch`` field from the response
to the previous call as the ``since`` parameter. This involves specifying a
timeout in the request which will hold open the HTTP connection for a short
period of time waiting for new events, returning early if an event occurs. Only
the ``/sync`` API (and the deprecated ``/events`` API) support long-polling in
this way.
to the previous call as the ``since`` parameter. The client should also pass a
``timeout`` parameter. The server will then hold open the HTTP connection for a
short period of time waiting for new events, returning early if an event
occurs. Only the ``/sync`` API (and the deprecated ``/events`` API) support
long-polling in this way.
The response for such an incremental sync can be visualised as::