Utilities/cmcurl/lib/ws.h

   1 #ifndef HEADER_CURL_WS_H
   2 #define HEADER_CURL_WS_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2022, 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   curl_off_t oleft; /* outstanding number of payload bytes left from the
  50                        server */
  51   curl_off_t stillbuffer; /* number of bytes left in the buffer to deliver in
  52                              the next curl_ws_recv() call */
  53   char *stillb; /* the stillbuffer pending bytes are here */
  54   curl_off_t sleft; /* outstanding number of payload bytes left to send */
  55   unsigned int xori; /* xor index */
  56 };
  57
  58 CURLcode Curl_ws_request(struct Curl_easy *data, REQTYPE *req);
  59 CURLcode Curl_ws_accept(struct Curl_easy *data);
  60
  61 size_t Curl_ws_writecb(char *buffer, size_t size, size_t nitems, void *userp);
  62 void Curl_ws_done(struct Curl_easy *data);
  63
  64 #else
  65 #define Curl_ws_request(x,y) CURLE_OK
  66 #define Curl_ws_done(x) Curl_nop_stmt
  67 #endif
  68
  69 #endif /* HEADER_CURL_WS_H */