• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 /* this is the largest single fragment size we support */
37 #define MAX_WS_SIZE 65535
38 
39 /* part of 'struct HTTP', when used in the 'struct SingleRequest' in the
40    Curl_easy struct */
41 struct websocket {
42   bool contfragment; /* set TRUE if the previous fragment sent was not final */
43   unsigned char mask[4]; /* 32 bit mask for this connection */
44   struct Curl_easy *data; /* used for write callback handling */
45   struct dynbuf buf;
46   size_t usedbuf; /* number of leading bytes in 'buf' the most recent complete
47                      websocket frame uses */
48   struct curl_ws_frame frame; /* the struct used for frame state */
49   size_t stillblen; /* number of bytes left in the buffer to deliver in
50                          the next curl_ws_recv() call */
51   const char *stillb; /* the stillblen pending bytes are here */
52   curl_off_t sleft; /* outstanding number of payload bytes left to send */
53   unsigned int xori; /* xor index */
54 };
55 
56 struct ws_conn {
57   struct dynbuf early; /* data already read when switching to ws */
58 };
59 
60 CURLcode Curl_ws_request(struct Curl_easy *data, REQTYPE *req);
61 CURLcode Curl_ws_accept(struct Curl_easy *data, const char *mem, size_t len);
62 size_t Curl_ws_writecb(char *buffer, size_t size, size_t nitems, void *userp);
63 void Curl_ws_done(struct Curl_easy *data);
64 CURLcode Curl_ws_disconnect(struct Curl_easy *data,
65                             struct connectdata *conn,
66                             bool dead_connection);
67 #else
68 #define Curl_ws_request(x,y) CURLE_OK
69 #define Curl_ws_done(x) Curl_nop_stmt
70 #define Curl_ws_free(x) Curl_nop_stmt
71 #endif
72 
73 #endif /* HEADER_CURL_WS_H */
74