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

Merge pull request #984 from matrix-org/rav/sync_timeout

Browse source 
Make clear that the /sync timeout is zero by default
This commit is contained in:
David Baker 2017-08-31 17:56:20 +01:00 • committed by GitHub
commit 883767a905
2 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

8
api/client-server/sync.yaml
View file

@ -88,8 +88,12 @@ paths:
name: timeout
type: integer
description: |-
The maximum time to poll in milliseconds before returning this
request.
The maximum time to wait, in milliseconds, before returning this
request. If no events (or other data) become available before this
time elapses, the server will return a response with empty fields.
By default, this is ``0``, so the server will return immediately
even if the response is empty.
x-example: 30000
responses:
200:

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::