2
0

ws.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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. #if defined(USE_WEBSOCKETS) && !defined(CURL_DISABLE_HTTP)
  28. #ifdef USE_HYPER
  29. #define REQTYPE void
  30. #else
  31. #define REQTYPE struct dynbuf
  32. #endif
  33. /* a client-side WS frame decoder, parsing frame headers and
  34. * payload, keeping track of current position and stats */
  35. enum ws_dec_state {
  36. WS_DEC_INIT,
  37. WS_DEC_HEAD,
  38. WS_DEC_PAYLOAD
  39. };
  40. struct ws_decoder {
  41. int frame_age; /* zero */
  42. int frame_flags; /* See the CURLWS_* defines */
  43. curl_off_t payload_offset; /* the offset parsing is at */
  44. curl_off_t payload_len;
  45. unsigned char head[10];
  46. int head_len, head_total;
  47. enum ws_dec_state state;
  48. };
  49. /* a client-side WS frame encoder, generating frame headers and
  50. * converting payloads, tracking remaining data in current frame */
  51. struct ws_encoder {
  52. curl_off_t payload_len; /* payload length of current frame */
  53. curl_off_t payload_remain; /* remaining payload of current */
  54. unsigned int xori; /* xor index */
  55. unsigned char mask[4]; /* 32 bit mask for this connection */
  56. unsigned char firstbyte; /* first byte of frame we encode */
  57. bool contfragment; /* set TRUE if the previous fragment sent was not final */
  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. CURLcode Curl_ws_request(struct Curl_easy *data, REQTYPE *req);
  70. CURLcode Curl_ws_accept(struct Curl_easy *data, const char *mem, size_t len);
  71. extern const struct Curl_handler Curl_handler_ws;
  72. #ifdef USE_SSL
  73. extern const struct Curl_handler Curl_handler_wss;
  74. #endif
  75. #else
  76. #define Curl_ws_request(x,y) CURLE_OK
  77. #define Curl_ws_free(x) Curl_nop_stmt
  78. #endif
  79. #endif /* HEADER_CURL_WS_H */