Mirror
/
Crow
mirror of https://github.com/CrowCpp/Crow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #670 from robertgodfrey/doc-update-ws 

Update websocket example code, minor grammar fixes
This commit is contained in:
Farook Al-Sammarraie 2023-06-30 23:35:24 +00:00 committed by GitHub
parent 13a91a1941 6f5a6df642
commit af6b7edc22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/guides/websockets.md
View File

@ -17,12 +17,11 @@ A websocket route differs from a normal route quite a bit. It uses a slightly al
!!! Warning
By default, Crow allows Clients to send unmasked websocket messages, which is useful for debugging but goes against the protocol specification. Production Crow applications should enforce the protocol by adding `#!cpp #define CROW_ENFORCE_WS_SPEC` to their source code.
By default, Crow allows clients to send unmasked websocket messages. This is useful for debugging, but goes against the protocol specifications. Production Crow applications should enforce the protocol by adding `#!cpp #define CROW_ENFORCE_WS_SPEC` to their source code.
These event methods and their handlers can be chained. The full Route should look similar to this:
These event methods and their handlers can be chained. The full route should look similar to this:
```cpp
CROW_ROUTE(app, "/ws")
.websocket()
CROW_WEBSOCKET_ROUTE(app, "/ws")
.onopen([&](crow::websocket::connection& conn){
do_something();
})
@ -44,7 +43,7 @@ The maximum payload size that a connection accepts can be adjusted either global
!!! note
By default, This limit is disabled. To disable the global setting in specific routes, you only need to call `#!cpp CROW_WEBSOCKET_ROUTE(app, "/url").max_payload(UINT64_MAX)`.
By default, this limit is disabled. To disable the global setting in specific routes, you only need to call `#!cpp CROW_WEBSOCKET_ROUTE(app, "/url").max_payload(UINT64_MAX)`.
For more info about websocket routes go [here](../reference/classcrow_1_1_web_socket_rule.html).