开发文档

WEBSOCKET 和 JSON-RPC API

此篇内容尚无原站英文对应版本;切换语言后可浏览英文资料库。
如果你想和streamd服务器直接通信,那可以使用WebSocket API或JSON-RPC API。两种API都使用相同的命令列表,每个命令参数几乎完全相同。或者,你可以使用StreamAPI,这是一个简化的JavaScript客户端库,可使用Node.js或者Web浏览器直接通信:
  • Websocket API 使用Websocket协议,对大多数浏览器和JavaScript可实现,从而达到持久的双向交流。请求和回应之间不是1:1的相关性。有些请求服务器会异步响应多个信息;其他时候,与提交它们的请求相比,回应可能以不同的顺序到达。streamd服务器可以配置接受安全的(wss://)、不安全的(ws://)Websocket连接,或同时接受两个。
  • JSON-RPC API依赖HTTP或HTTPs的请求-回应交流。(streamd服务器可以配置接受HTTP、HTTPS,或同时接受两个。)对于提示多个响应的命令,你可以提供一个回调URL。
  • streamd程序也可以被用作快速命令行客户端,向正在运行的streamd服务器发送JSON-RPC请求。这是为管理目的而设计,不是受支持的API。
一般来说,我们推荐使用WebSocket,因为WebSocket的推动范例有较少的延迟和网络开销。JSON-RPC处理每个个体信息时必须打开和关闭HTTP连接。WebSocket也更靠谱,你不用太担心丢失信息和建立多个连接的问题。然而,这三个都有有效的用例,而且在可预见的未来持续受到支持。
THE NEXT CONNECTION

下一次连接,从这里开始。

加入 Stream 社区,一起探索价值互联。

联系我们