1#ifndef CURLINC_WEBSOCKETS_H
2#define CURLINC_WEBSOCKETS_H
3/***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31struct curl_ws_frame {
32 int age; /* zero */
33 int flags; /* See the CURLWS_* defines */
34 curl_off_t offset; /* the offset of this data into the frame */
35 curl_off_t bytesleft; /* number of pending bytes left of the payload */
36 size_t len; /* size of the current data chunk */
37};
38
39/* flag bits */
40#define CURLWS_TEXT (1<<0)
41#define CURLWS_BINARY (1<<1)
42#define CURLWS_CONT (1<<2)
43#define CURLWS_CLOSE (1<<3)
44#define CURLWS_PING (1<<4)
45#define CURLWS_OFFSET (1<<5)
46
47/*
48 * NAME curl_ws_recv()
49 *
50 * DESCRIPTION
51 *
52 * Receives data from the websocket connection. Use after successful
53 * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
54 */
55CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen,
56 size_t *recv,
57 const struct curl_ws_frame **metap);
58
59/* flags for curl_ws_send() */
60#define CURLWS_PONG (1<<6)
61
62/*
63 * NAME curl_ws_send()
64 *
65 * DESCRIPTION
66 *
67 * Sends data over the websocket connection. Use after successful
68 * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
69 */
70CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer,
71 size_t buflen, size_t *sent,
72 curl_off_t fragsize,
73 unsigned int flags);
74
75/* bits for the CURLOPT_WS_OPTIONS bitmask: */
76#define CURLWS_RAW_MODE (1<<0)
77
78CURL_EXTERN const struct curl_ws_frame *curl_ws_meta(CURL *curl);
79
80#ifdef __cplusplus
81}
82#endif
83
84#endif /* CURLINC_WEBSOCKETS_H */
85