mirror of
https://github.com/curl/curl.git
synced 2026-04-14 13:01:42 +08:00
e3f335148a
curl_ws_recv() now receives data to fill up the provided buffer, but can return a partial fragment. The function now also get a pointer to a curl_ws_frame struct with metadata that also mentions the offset and total size of the fragment (of which you might be receiving a smaller piece). This way, large incoming fragments will be "streamed" to the application. When the curl_ws_frame struct field 'bytesleft' is 0, the final fragment piece has been delivered. curl_ws_recv() was also adjusted to work with a buffer size smaller than the fragment size. (Possibly needless to say as the fragment size can now be 63 bit large). curl_ws_send() now supports sending a piece of a fragment, in a streaming manner, in addition to sending the entire fragment in a single call if it is small enough. To send a huge fragment, curl_ws_send() can be used to send it in many small calls by first telling libcurl about the total expected fragment size, and then send the payload in N number of separate invokes and libcurl will stream those over the wire. The struct curl_ws_meta() returns is now called 'curl_ws_frame' and it has been extended with two new fields: *offset* and *bytesleft*. To help describe the passed on data chunk when a fragment is delivered in many smaller pieces. The documentation has been updated accordingly. Closes #9636
84 lines
2.6 KiB
C
84 lines
2.6 KiB
C
#ifndef CURLINC_WEBSOCKETS_H
|
|
#define CURLINC_WEBSOCKETS_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct curl_ws_frame {
|
|
int age; /* zero */
|
|
int flags; /* See the CURLWS_* defines */
|
|
curl_off_t offset; /* the offset of this data into the frame */
|
|
curl_off_t bytesleft; /* number of pending bytes left of the payload */
|
|
};
|
|
|
|
/* flag bits */
|
|
#define CURLWS_TEXT (1<<0)
|
|
#define CURLWS_BINARY (1<<1)
|
|
#define CURLWS_CONT (1<<2)
|
|
#define CURLWS_CLOSE (1<<3)
|
|
#define CURLWS_PING (1<<4)
|
|
#define CURLWS_OFFSET (1<<5)
|
|
|
|
/*
|
|
* NAME curl_ws_recv()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Receives data from the websocket connection. Use after successful
|
|
* curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
|
|
size_t *recv,
|
|
struct curl_ws_frame **metap);
|
|
|
|
/* sendflags for curl_ws_send() */
|
|
#define CURLWS_PONG (1<<6)
|
|
|
|
/*
|
|
* NAME curl_easy_send()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Sends data over the websocket connection. Use after successful
|
|
* curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer,
|
|
size_t buflen, size_t *sent,
|
|
curl_off_t framesize,
|
|
unsigned int sendflags);
|
|
|
|
/* bits for the CURLOPT_WS_OPTIONS bitmask: */
|
|
#define CURLWS_RAW_MODE (1<<0)
|
|
|
|
CURL_EXTERN struct curl_ws_frame *curl_ws_meta(CURL *curl);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CURLINC_WEBSOCKETS_H */
|