Skip to content

Commit

Permalink
Elaborate auth doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ErnestKz committed Jan 10, 2024
1 parent cce6cb6 commit 90909a7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/IcepeakProtocolMultiSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The URL path:
- points to the root of your icepeak service
- has the query parameter `method` set to `reusable`

The authorisation mechanism is a "subscription deadline timout": Initial websocket connection does not need authorisation, but if the client does not subscribe to a client before the server-configured timeout, then the connection will be closed.
The authorisation mechanism is a "subscription deadline timout": Initial websocket connection does not need authorisation, but if the client does not subscribe to a client before the server-configured timeout, then the connection will be closed un-politely, i.e the server will not send a WS close control message.

Timeout is set by the `--first-subscription-deadline-timeout` flag, the input is in terms of microseconds, the default value is `100000` (0.1 seconds).

Expand Down

0 comments on commit 90909a7

Please sign in to comment.