Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove connect keep alive protocol from Event Stream API

Browse Source
This commit is contained in:
Brett Sun
2017-02-16 15:26:17 +01:00
parent 00785e5f02
commit 9307c21baa
1 changed files with 6 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/server/source/drivers-clients/websocket-event-stream-api.rst
View File

@@ -36,35 +36,17 @@ response contains a ``streams_<version>`` property in ``_links``::
Connection Keep Alive
~~~~~~~~~~~~~~~~~~~~~
The Event Stream API requires clients to signal that they'd like their
connection to stay open by sending "pings" across the open connection.
BigchainDB nodes will automatically close any connections that haven't sent a
ping in the last three minutes.
.. note::
While three minutes is the limit before a BigchainDB server will terminate
a connection, we suggest sending a ping every 30 seconds for better
reliability.
A "ping" consists of a message containing only the string ``"ping"``, for example
in JavaScript:
.. code-block:: javascript
new WebSocket("...").send("ping")
If the BigchainDB node received the ping, it'll respond back with a message
containing only the string ``"pong"``.
The Event Stream API initially does not provide any mechanisms for connection
keep alive other than enabling TCP keepalive on each open WebSocket connection.
In the future, we may add additional functionality to handle ping/pong frames
or payloads designed for keep alive.
Streams
-------
Each stream is meant as a unidirectional communication channel, where the
BigchainDB node is the only party sending messages (except for `keep-alive
pings <#connection-keep-alive>`_). Any messages sent to the BigchainDB node
(except the keep-alive pings) will be ignored.
BigchainDB node is the only party sending messages. Any messages sent to the
BigchainDB node will be ignored.
Streams will always be under the WebSocket protocol (so ``ws://`` or
``wss://``) and accessible as extensions to the ``/api/v<version>/streams/``