1#ifndef HEADER_CURL_WS_H
2#define HEADER_CURL_WS_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#include "curl_setup.h"
27
28#ifdef USE_WEBSOCKETS
29
30#ifdef USE_HYPER
31#define REQTYPE void
32#else
33#define REQTYPE struct dynbuf
34#endif
35
36/* a client-side WS frame decoder, parsing frame headers and
37 * payload, keeping track of current position and stats */
38enum ws_dec_state {
39 WS_DEC_INIT,
40 WS_DEC_HEAD,
41 WS_DEC_PAYLOAD
42};
43
44struct ws_decoder {
45 int frame_age; /* zero */
46 int frame_flags; /* See the CURLWS_* defines */
47 curl_off_t payload_offset; /* the offset parsing is at */
48 curl_off_t payload_len;
49 unsigned char head[10];
50 int head_len, head_total;
51 enum ws_dec_state state;
52};
53
54/* a client-side WS frame encoder, generating frame headers and
55 * converting payloads, tracking remaining data in current frame */
56struct ws_encoder {
57 curl_off_t payload_len; /* payload length of current frame */
58 curl_off_t payload_remain; /* remaining payload of current */
59 unsigned int xori; /* xor index */
60 unsigned char mask[4]; /* 32 bit mask for this connection */
61 unsigned char firstbyte; /* first byte of frame we encode */
62 bool contfragment; /* set TRUE if the previous fragment sent was not final */
63};
64
65/* A websocket connection with en- and decoder that treat frames
66 * and keep track of boundaries. */
67struct websocket {
68 struct Curl_easy *data; /* used for write callback handling */
69 struct ws_decoder dec; /* decode of we frames */
70 struct ws_encoder enc; /* decode of we frames */
71 struct bufq recvbuf; /* raw data from the server */
72 struct bufq sendbuf; /* raw data to be sent to the server */
73 struct curl_ws_frame frame; /* the current WS FRAME received */
74};
75
76CURLcode Curl_ws_request(struct Curl_easy *data, REQTYPE *req);
77CURLcode Curl_ws_accept(struct Curl_easy *data, const char *mem, size_t len);
78size_t Curl_ws_writecb(char *buffer, size_t size, size_t nitems, void *userp);
79void Curl_ws_done(struct Curl_easy *data);
80CURLcode Curl_ws_disconnect(struct Curl_easy *data,
81 struct connectdata *conn,
82 bool dead_connection);
83#else
84#define Curl_ws_request(x,y) CURLE_OK
85#define Curl_ws_done(x) Curl_nop_stmt
86#define Curl_ws_free(x) Curl_nop_stmt
87#endif
88
89#endif /* HEADER_CURL_WS_H */
90