mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-03-25 15:50:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

libcurl-ws.3: mention raw mode

Browse Source 
Closes #11339
This commit is contained in:
Daniel Stenberg 2023-06-18 20:57:29 +02:00
parent c6ec264d1f
commit 7ed832a245
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/libcurl/libcurl-ws.3
View File

@ -58,6 +58,18 @@ arrive for the same frame.
A message has an unknown size until the last frame header for the message has
been received since only frames have set sizes.
.SH "Raw mode"
libcurl can be told to speak WebSocket in "raw mode" by setting the
\fBCURLWS_RAW_MODE\fP bit to the \fICURLOPT_WS_OPTIONS(3)\fP option.
Raw WebSocket means that libcurl will pass on the data from the network
without parsing it leaving that entirely to the application. This mode assumes
that the user of this knows WebSocket and can parse and figure out the data
all by itself.
This mode is intended for applications that already have a WebSocket
parser/engine that want to switch over to use libcurl for enabling WebSocket,
but keep parts of the existing software architecture.
.SH PING
WebSocket is designed to allow long-lived sessions and in order to keep the
connections alive, both ends can send PING messages for the other end to