romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-08-24 19:53:46 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: use "WebSocket" in singular

Browse source 
This is how the RFC calls the protocol. Also rename the file in docs/ to
WEBSOCKET.md in uppercase to match how we have done it for many other
protocol docs in similar fashion.

Add the WebSocket docs to the tarball.

Closes #9496
This commit is contained in:
Daniel Stenberg 2022-09-13 09:17:53 +02:00
parent 7740530ced
commit 6a1bfbd11b
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
5 changed files with 35 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/libcurl/curl_ws_meta.3
View file

@ -24,7 +24,7 @@
.\"
.TH curl_ws_meta 3 "12 Jun 2022" "libcurl 7.85.0" "libcurl Manual"
.SH NAME
curl_ws_meta - meta data websocket information
curl_ws_meta - meta data WebSocket information
.SH SYNOPSIS
.nf
#include <curl/easy.h>
@ -44,7 +44,7 @@ received WebSocket traffic, \fIcurl_ws_meta(3)\fP can be called from within
the callback to provide additional information about the data.
This function only works from within the callback, and only when receiving
Websocket data.
WebSocket data.
This function requires an easy handle as input argument for libcurl to know
what transfer the question is about, but as there is no such pointer provided

6
docs/libcurl/curl_ws_recv.3
View file

@ -24,7 +24,7 @@
.\"
.TH curl_ws_recv 3 "12 Jun 2022" "libcurl 7.85.0" "libcurl Manual"
.SH NAME
curl_ws_recv - receive websocket data
curl_ws_recv - receive WebSocket data
.SH SYNOPSIS
.nf
#include <curl/easy.h>
@ -35,12 +35,12 @@ CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
.SH DESCRIPTION
This function call is EXPERIMENTAL.
Retrives as much as possible of a received WebSockets data fragment into the
Retrives as much as possible of a received WebSocket data fragment into the
\fBbuffer\fP, but not more than \fBbuflen\fP bytes. The provide
\fIrecvflags\fP argument gets bits set to help characterize the fragment.
.SH RECVFLAGS
.IP CURLWS_TEXT
The buffer contains text data. Note that this makes a difference to WebSockets
The buffer contains text data. Note that this makes a difference to WebSocket
but libcurl itself will not make any verification of the content or
precautions that you actually receive valid UTF-8 content.
.IP CURLWS_BINARY

4
docs/libcurl/curl_ws_send.3
View file

@ -35,14 +35,14 @@ CURLcode curl_ws_send(CURL *curl, const void *buffer, size_t buflen,
.SH DESCRIPTION
This function call is EXPERIMENTAL.
Send the specific message fragment over the established websockets connection.
Send the specific message fragment over the established WebSocket connection.
If \fBCURLWS_RAW_MODE\fP is enabled in \fICURLOPT_WS_OPTIONS(3)\fP, the
\fBsendflags\fP argument should be set to 0.
.SH SENDFLAGS
.IP CURLWS_TEXT
The buffer contains text data. Note that this makes a difference to WebSockets
The buffer contains text data. Note that this makes a difference to WebSocket
but libcurl itself will not make any verification of the content or
precautions that you actually send valid UTF-8 content.
.IP CURLWS_BINARY