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