romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-05-30 06:17:28 +03:00
Code Issues Projects Releases Packages Wiki Activity

websocket: rename arguments/variables to match docs

Browse source 
Pedantry/semantic-alignment between functions, docs, comments with
respect to websocket protocol code; No functional change intended.

* "totalsize", "framesize" becomes "fragsize" (we deal in frame fragments).

* "sendflags" becomes "flags"

* use canonical CURL *handle

Closes #11493
This commit is contained in:
bch 2023-07-20 15:03:16 -07:00 • committed by Daniel Stenberg
parent 3b3c41f933
commit bc642cb333
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
3 changed files with 18 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.mailmap
View file

@ -104,3 +104,4 @@ Michael Musset <mickamusset@gmail.com>
Andy Alt <arch_stanton5995@protonmail.com>
Thomas1664 on github <46387399+Thomas1664@users.noreply.github.com>
dengjfzh on github <dengjfzh@gmail.com>
Brad Harder <brad.harder@gmail.com>

8
include/curl/websockets.h
View file

@ -56,11 +56,11 @@ CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
size_t *recv,
const struct curl_ws_frame **metap);
/* sendflags for curl_ws_send() */
/* flags for curl_ws_send() */
#define CURLWS_PONG (1<<6)
/*
* NAME curl_easy_send()
* NAME curl_ws_send()
*
* DESCRIPTION
*
@ -69,8 +69,8 @@ CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
*/
CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer,
size_t buflen, size_t *sent,
curl_off_t framesize,
unsigned int sendflags);
curl_off_t fragsize,
unsigned int flags);
/* bits for the CURLOPT_WS_OPTIONS bitmask: */
#define CURLWS_RAW_MODE (1<<0)

26
lib/ws.c
View file

@ -970,10 +970,10 @@ static CURLcode ws_flush(struct Curl_easy *data, struct websocket *ws,
return CURLE_OK;
}
CURL_EXTERN CURLcode curl_ws_send(struct Curl_easy *data, const void *buffer,
CURL_EXTERN CURLcode curl_ws_send(CURL *data, const void *buffer,
size_t buflen, size_t *sent,
curl_off_t totalsize,
unsigned int sendflags)
curl_off_t fragsize,
unsigned int flags)
{
struct websocket *ws;
ssize_t nwritten, n;
@ -997,7 +997,7 @@ CURL_EXTERN CURLcode curl_ws_send(struct Curl_easy *data, const void *buffer,
ws = data->conn->proto.ws;
if(data->set.ws_raw_mode) {
if(totalsize || sendflags)
if(fragsize || flags)
return CURLE_BAD_FUNCTION_ARGUMENT;
if(!buflen)
/* nothing to do */
@ -1030,10 +1030,10 @@ CURL_EXTERN CURLcode curl_ws_send(struct Curl_easy *data, const void *buffer,
if(space < 14)
return CURLE_AGAIN;
if(sendflags & CURLWS_OFFSET) {
if(totalsize) {
/* a frame series 'totalsize' bytes big, this is the first */
n = ws_enc_write_head(data, &ws->enc, sendflags, totalsize,
if(flags & CURLWS_OFFSET) {
if(fragsize) {
/* a frame series 'fragsize' bytes big, this is the first */
n = ws_enc_write_head(data, &ws->enc, flags, fragsize,
&ws->sendbuf, &result);
if(n < 0)
return result;
@ -1047,7 +1047,7 @@ CURL_EXTERN CURLcode curl_ws_send(struct Curl_easy *data, const void *buffer,
}
}
else if(!ws->enc.payload_remain) {
n = ws_enc_write_head(data, &ws->enc, sendflags, (curl_off_t)buflen,
n = ws_enc_write_head(data, &ws->enc, flags, (curl_off_t)buflen,
&ws->sendbuf, &result);
if(n < 0)
return result;
@ -1112,15 +1112,15 @@ CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer,
size_t buflen, size_t *sent,
curl_off_t framesize,
unsigned int sendflags)
curl_off_t fragsize,
unsigned int flags)
{
(void)curl;
(void)buffer;
(void)buflen;
(void)sent;
(void)framesize;
(void)sendflags;
(void)fragsize;
(void)flags;
return CURLE_NOT_BUILT_IN;
}