taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

Add note about frame types and content of a frame wrt NATS protocols

Browse Source 
Signed-off-by: Ivan Kozlovic <ivan@synadia.com>
This commit is contained in:
Ivan Kozlovic 2021-02-10 13:18:37 -07:00
parent 6d00a5523b
commit 44fa12e358
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
nats-server/configuration/websockets.md
View File

@ -6,6 +6,11 @@ Websocket support can be enabled in the server and may be used alongside the
traditional TCP socket connections. TLS, compression and traditional TCP socket connections. TLS, compression and
Origin Header checking are supported. Origin Header checking are supported.
**Important**
- NATS Supports only Websocket data frames in Binary, not Text format (https://tools.ietf.org/html/rfc6455#section-5.6). The server will always send in Binary and your clients MUST send in Binary too.
- For writers of client libraries: a Websocket frame is not guaranteed to contain a full NATS protocol (actually will generally not). Any data from a frame must be going through a parser that can handle partial protocols. See the protocol description [here](../../nats-protocol/nats-protocol/README.md).
To enable websocket support in the server, add a `websockets` configuration To enable websocket support in the server, add a `websockets` configuration
block in the server's configuration file like the following: block in the server's configuration file like the following: