From ed4acef481a402a8a34e2a523f8bd434b9064da9 Mon Sep 17 00:00:00 2001 From: Andy Green Date: Mon, 12 Dec 2016 13:36:25 +0800 Subject: [PATCH] RFC7233 HTTP Ranges support for server This adds a serverside implementation of RFC7233 HTTP ranges. - LWS_WITH_RANGES is on by default at cmake - Accept-Ranges: bytes is added if LWS_WITH_RANGES is enabled - Both single ranges and multipart (2+) ranges are supported Test with curl like this Single $ $ curl -s -r 64-95 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 53 6f |.....'....tEXtSo| 00000010 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b 73 63 |ftware.www.inksc| Multipart $ curl -s -r 64-95,128-143 http://localhost:7681/libwebsockets.org-logo.png | hexdump -C 00000000 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d 54 79 |_lws..Content-Ty| 00000010 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d 0a 43 |pe: image/png..C| 00000020 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 62 79 |ontent-Range: by| 00000030 74 65 73 20 36 34 2d 39 35 2f 37 30 32 39 0d 0a |tes 64-95/7029..| 00000040 0d 0a 2e 01 fd 9d 12 27 00 00 00 19 74 45 58 74 |.......'....tEXt| 00000050 53 6f 66 74 77 61 72 65 00 77 77 77 2e 69 6e 6b |Software.www.ink| 00000060 73 63 5f 6c 77 73 0d 0a 43 6f 6e 74 65 6e 74 2d |sc_lws..Content-| 00000070 54 79 70 65 3a 20 69 6d 61 67 65 2f 70 6e 67 0d |Type: image/png.| 00000080 0a 43 6f 6e 74 65 6e 74 2d 52 61 6e 67 65 3a 20 |.Content-Range: | 00000090 62 79 74 65 73 20 31 32 38 2d 31 34 33 2f 37 30 |bytes 128-143/70| 000000a0 32 39 0d 0a 0d 0a 05 14 50 40 05 15 a5 c4 60 43 |29......P@....`C| 000000b0 91 c4 4a d4 c4 fc 5f 6c 77 73 0d 00 |..J..._lws..| The corresponding header part is like this 0x0030: 4854 5450 2f31 2e31 2032 3036 HTTP/1.1.206 0x0040: 200d 0a73 6572 7665 723a 206c 7773 7773 ...server:.lwsws 0x0050: 0d0a 636f 6e74 656e 742d 7479 7065 3a20 ..content-type:. 0x0060: 6d75 6c74 6970 6172 742f 6279 7465 7261 multipart/bytera 0x0070: 6e67 6573 0d0a 6163 6365 7074 2d72 616e nges..accept-ran 0x0080: 6765 733a 2062 7974 6573 0d0a 636f 6e74 ges:.bytes..cont 0x0090: 656e 742d 6c65 6e67 7468 3a20 3138 380d ent-length:.188. 0x00a0: 0a63 6163 6865 2d63 6f6e 7472 6f6c 3a20 .cache-control:. 0x00b0: 7072 6976 6174 6520 6d61 782d 6167 653a private.max-age: 0x00c0: 2036 300d 0a63 6f6e 6e65 6374 696f 6e3a .60..connection: 0x00d0: 206b 6565 702d 616c 6976 650d 0a65 7461 .keep-alive..eta 0x00e0: 673a 2030 3030 3031 4237 3535 3444 3433 g:.00001B7554D43 0x00f0: 3033 330d 0a0d 0a 033.... --- CMakeLists.txt | 9 +- doc/html/group__form-parsing.html | 6 +- doc/html/group__html-chunked-substitution.html | 29 ++-- doc/html/group__sending-data.html | 14 +- doc/html/group__smtp.html | 18 +-- doc/html/libwebsockets_8h.html | 29 ++-- doc/html/libwebsockets_8h.js | 1 + doc/html/libwebsockets_8h_source.html | 122 +++++++------- doc/html/navtreedata.js | 4 +- doc/html/navtreeindex0.js | 4 +- doc/html/navtreeindex1.js | 62 ++++---- doc/html/navtreeindex2.js | 42 ++--- doc/html/navtreeindex3.js | 4 +- doc/html/navtreeindex4.js | 13 +- lib/libwebsockets.h | 1 + lib/output.c | 100 ++++++++++-- lib/private-libwebsockets.h | 33 ++++ lib/ranges.c | 211 +++++++++++++++++++++++++ lib/server.c | 109 ++++++++++++- lws_config.h.in | 3 + 20 files changed, 628 insertions(+), 186 deletions(-) create mode 100644 lib/ranges.c diff --git a/CMakeLists.txt b/CMakeLists.txt index 0b9e273..e599b7e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -110,6 +110,7 @@ option(LWS_WITH_SMTP "Provide SMTP support" OFF) option(LWS_WITH_ESP8266 "Build for ESP8266" OFF) option(LWS_WITH_NO_LOGS "Disable all logging from being compiled in" OFF) option(LWS_STATIC_PIC "Build the static version of the library with position-independent code" OFF) +option(LWS_WITH_RANGES "Support http ranges (RFC7233)" ON) if (LWS_WITH_LWSWS) message(STATUS "LWS_WITH_LWSWS --> Enabling LWS_WITH_PLUGINS and LWS_WITH_LIBUV") @@ -164,6 +165,7 @@ if (LWS_WITH_ESP8266) set(LWS_WITHOUT_TESTAPPS ON) set(LWS_WITHOUT_EXTENSIONS ON) set(LWS_WITH_PLUGINS OFF) + set(LWS_WITH_RANGES OFF) # this implies no pthreads in the lib set(LWS_MAX_SMP 1) set(LWS_HAVE_MALLOC 1) @@ -652,6 +654,11 @@ if (LWS_WITH_SMTP) lib/smtp.c) endif() +if (LWS_WITH_RANGES) + list(APPEND SOURCES + lib/ranges.c) +endif() + # Add helper files for Windows. if (WIN32) set(WIN32_HELPERS_PATH win32port/win32helpers) @@ -1640,7 +1647,7 @@ message(" LWS_WITH_LEJP_CONF = ${LWS_WITH_LEJP_CONF}") message(" LWS_WITH_SMTP = ${LWS_WITH_SMTP}") message(" LWS_WITH_GENERIC_SESSIONS = ${LWS_WITH_GENERIC_SESSIONS}") message(" LWS_STATIC_PIC = ${LWS_STATIC_PIC}") - +message(" LWS_WITH_RANGES = ${LWS_WITH_RANGES}") message("---------------------------------------------------------------------") diff --git a/doc/html/group__form-parsing.html b/doc/html/group__form-parsing.html index d613aa1..cf1eda9 100644 --- a/doc/html/group__form-parsing.html +++ b/doc/html/group__form-parsing.html @@ -156,9 +156,9 @@ Functions LWS_UFS_OPEN 

a new file is starting to arrive

-
2846  {
2847  LWS_UFS_CONTENT,
2849  LWS_UFS_FINAL_CONTENT,
2851  LWS_UFS_OPEN
2853 };
LWS_UFS_FINAL_CONTENT
Definition: libwebsockets.h:2849
-
LWS_UFS_OPEN
Definition: libwebsockets.h:2851
-
LWS_UFS_CONTENT
Definition: libwebsockets.h:2847
+
2847  {
2848  LWS_UFS_CONTENT,
2850  LWS_UFS_FINAL_CONTENT,
2852  LWS_UFS_OPEN
2854 };
LWS_UFS_FINAL_CONTENT
Definition: libwebsockets.h:2850
+
LWS_UFS_OPEN
Definition: libwebsockets.h:2852
+
LWS_UFS_CONTENT
Definition: libwebsockets.h:2848
diff --git a/doc/html/group__html-chunked-substitution.html b/doc/html/group__html-chunked-substitution.html index 87ecd56..fdd9b5e 100644 --- a/doc/html/group__html-chunked-substitution.html +++ b/doc/html/group__html-chunked-substitution.html @@ -88,40 +88,41 @@ Enumerations enum  http_status {
  HTTP_STATUS_OK = 200, HTTP_STATUS_NO_CONTENT = 204, +HTTP_STATUS_PARTIAL_CONTENT = 206, HTTP_STATUS_MOVED_PERMANENTLY = 301, -HTTP_STATUS_FOUND = 302,
-  HTTP_STATUS_SEE_OTHER = 303, +  HTTP_STATUS_FOUND = 302, +HTTP_STATUS_SEE_OTHER = 303, HTTP_STATUS_BAD_REQUEST = 400, HTTP_STATUS_UNAUTHORIZED, -HTTP_STATUS_PAYMENT_REQUIRED,
-  HTTP_STATUS_FORBIDDEN, +  HTTP_STATUS_PAYMENT_REQUIRED, +HTTP_STATUS_FORBIDDEN, HTTP_STATUS_NOT_FOUND, HTTP_STATUS_METHOD_NOT_ALLOWED, -HTTP_STATUS_NOT_ACCEPTABLE,
-  HTTP_STATUS_PROXY_AUTH_REQUIRED, +  HTTP_STATUS_NOT_ACCEPTABLE, +HTTP_STATUS_PROXY_AUTH_REQUIRED, HTTP_STATUS_REQUEST_TIMEOUT, HTTP_STATUS_CONFLICT, -HTTP_STATUS_GONE,
-  HTTP_STATUS_LENGTH_REQUIRED, +  HTTP_STATUS_GONE, +HTTP_STATUS_LENGTH_REQUIRED, HTTP_STATUS_PRECONDITION_FAILED, HTTP_STATUS_REQ_ENTITY_TOO_LARGE, -HTTP_STATUS_REQ_URI_TOO_LONG,
-  HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, +  HTTP_STATUS_REQ_URI_TOO_LONG, +HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE, HTTP_STATUS_EXPECTATION_FAILED, -HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
-  HTTP_STATUS_NOT_IMPLEMENTED, +  HTTP_STATUS_INTERNAL_SERVER_ERROR = 500, +HTTP_STATUS_NOT_IMPLEMENTED, HTTP_STATUS_BAD_GATEWAY, HTTP_STATUS_SERVICE_UNAVAILABLE, -HTTP_STATUS_GATEWAY_TIMEOUT,
-  HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED +  HTTP_STATUS_GATEWAY_TIMEOUT, +HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED
}   diff --git a/doc/html/group__sending-data.html b/doc/html/group__sending-data.html index e3b6fe4..af930e6 100644 --- a/doc/html/group__sending-data.html +++ b/doc/html/group__sending-data.html @@ -124,13 +124,13 @@ Functions LWS_WRITE_CLIENT_IGNORE_XOR_MASK 

client packet payload goes out on wire unmunged only useful for security tests since normal servers cannot decode the content if used

-
3190  {
3191  LWS_WRITE_TEXT = 0,
3195  LWS_WRITE_BINARY = 1,
3198  LWS_WRITE_CONTINUATION = 2,
3201  LWS_WRITE_HTTP = 3,
3204  /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3205  LWS_WRITE_PING = 5,
3206  LWS_WRITE_PONG = 6,
3207 
3208  /* Same as write_http but we know this write ends the transaction */
3209  LWS_WRITE_HTTP_FINAL = 7,
3210 
3211  /* HTTP2 */
3212 
3213  LWS_WRITE_HTTP_HEADERS = 8,
3220  /****** add new things just above ---^ ******/
3221 
3222  /* flags */
3223 
3224  LWS_WRITE_NO_FIN = 0x40,
3227  LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3231 };
LWS_WRITE_HTTP
Definition: libwebsockets.h:3201
-
LWS_WRITE_NO_FIN
Definition: libwebsockets.h:3224
-
LWS_WRITE_TEXT
Definition: libwebsockets.h:3191
-
LWS_WRITE_BINARY
Definition: libwebsockets.h:3195
-
LWS_WRITE_CLIENT_IGNORE_XOR_MASK
Definition: libwebsockets.h:3227
-
LWS_WRITE_CONTINUATION
Definition: libwebsockets.h:3198
-
LWS_WRITE_HTTP_HEADERS
Definition: libwebsockets.h:3213
+
3191  {
3192  LWS_WRITE_TEXT = 0,
3196  LWS_WRITE_BINARY = 1,
3199  LWS_WRITE_CONTINUATION = 2,
3202  LWS_WRITE_HTTP = 3,
3205  /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3206  LWS_WRITE_PING = 5,
3207  LWS_WRITE_PONG = 6,
3208 
3209  /* Same as write_http but we know this write ends the transaction */
3210  LWS_WRITE_HTTP_FINAL = 7,
3211 
3212  /* HTTP2 */
3213 
3214  LWS_WRITE_HTTP_HEADERS = 8,
3221  /****** add new things just above ---^ ******/
3222 
3223  /* flags */
3224 
3225  LWS_WRITE_NO_FIN = 0x40,
3228  LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3232 };
LWS_WRITE_HTTP
Definition: libwebsockets.h:3202
+
LWS_WRITE_NO_FIN
Definition: libwebsockets.h:3225
+
LWS_WRITE_TEXT
Definition: libwebsockets.h:3192
+
LWS_WRITE_BINARY
Definition: libwebsockets.h:3196
+
LWS_WRITE_CLIENT_IGNORE_XOR_MASK
Definition: libwebsockets.h:3228
+
LWS_WRITE_CONTINUATION
Definition: libwebsockets.h:3199
+
LWS_WRITE_HTTP_HEADERS
Definition: libwebsockets.h:3214
diff --git a/doc/html/group__smtp.html b/doc/html/group__smtp.html index ab58e18..4a42dda 100644 --- a/doc/html/group__smtp.html +++ b/doc/html/group__smtp.html @@ -149,15 +149,15 @@ Functions LGSSMTP_SENT_QUIT 

sent the session quit

-
4145  {
4146  LGSSMTP_IDLE,
4147  LGSSMTP_CONNECTING,
4148  LGSSMTP_CONNECTED,
4149  LGSSMTP_SENT_HELO,
4150  LGSSMTP_SENT_FROM,
4151  LGSSMTP_SENT_TO,
4152  LGSSMTP_SENT_DATA,
4153  LGSSMTP_SENT_BODY,
4154  LGSSMTP_SENT_QUIT,
4155 };
LGSSMTP_CONNECTED
Definition: libwebsockets.h:4148
-
LGSSMTP_SENT_BODY
Definition: libwebsockets.h:4153
-
LGSSMTP_IDLE
Definition: libwebsockets.h:4146
-
LGSSMTP_CONNECTING
Definition: libwebsockets.h:4147
-
LGSSMTP_SENT_TO
Definition: libwebsockets.h:4151
-
LGSSMTP_SENT_FROM
Definition: libwebsockets.h:4150
-
LGSSMTP_SENT_QUIT
Definition: libwebsockets.h:4154
-
LGSSMTP_SENT_HELO
Definition: libwebsockets.h:4149
-
LGSSMTP_SENT_DATA
Definition: libwebsockets.h:4152
+
4146  {
4147  LGSSMTP_IDLE,
4148  LGSSMTP_CONNECTING,
4149  LGSSMTP_CONNECTED,
4150  LGSSMTP_SENT_HELO,
4151  LGSSMTP_SENT_FROM,
4152  LGSSMTP_SENT_TO,
4153  LGSSMTP_SENT_DATA,
4154  LGSSMTP_SENT_BODY,
4155  LGSSMTP_SENT_QUIT,
4156 };
LGSSMTP_CONNECTED
Definition: libwebsockets.h:4149
+
LGSSMTP_SENT_BODY
Definition: libwebsockets.h:4154
+
LGSSMTP_IDLE
Definition: libwebsockets.h:4147
+
LGSSMTP_CONNECTING
Definition: libwebsockets.h:4148
+
LGSSMTP_SENT_TO
Definition: libwebsockets.h:4152
+
LGSSMTP_SENT_FROM
Definition: libwebsockets.h:4151
+
LGSSMTP_SENT_QUIT
Definition: libwebsockets.h:4155
+
LGSSMTP_SENT_HELO
Definition: libwebsockets.h:4150
+
LGSSMTP_SENT_DATA
Definition: libwebsockets.h:4153
diff --git a/doc/html/libwebsockets_8h.html b/doc/html/libwebsockets_8h.html index 78fa036..a896a53 100644 --- a/doc/html/libwebsockets_8h.html +++ b/doc/html/libwebsockets_8h.html @@ -387,40 +387,41 @@ Enumerations enum  http_status {
  HTTP_STATUS_OK = 200, HTTP_STATUS_NO_CONTENT = 204, +HTTP_STATUS_PARTIAL_CONTENT = 206, HTTP_STATUS_MOVED_PERMANENTLY = 301, -HTTP_STATUS_FOUND = 302,
-  HTTP_STATUS_SEE_OTHER = 303, +  HTTP_STATUS_FOUND = 302, +HTTP_STATUS_SEE_OTHER = 303, HTTP_STATUS_BAD_REQUEST = 400, HTTP_STATUS_UNAUTHORIZED, -HTTP_STATUS_PAYMENT_REQUIRED,
-  HTTP_STATUS_FORBIDDEN, +  HTTP_STATUS_PAYMENT_REQUIRED, +HTTP_STATUS_FORBIDDEN, HTTP_STATUS_NOT_FOUND, HTTP_STATUS_METHOD_NOT_ALLOWED, -HTTP_STATUS_NOT_ACCEPTABLE,
-  HTTP_STATUS_PROXY_AUTH_REQUIRED, +  HTTP_STATUS_NOT_ACCEPTABLE, +HTTP_STATUS_PROXY_AUTH_REQUIRED, HTTP_STATUS_REQUEST_TIMEOUT, HTTP_STATUS_CONFLICT, -HTTP_STATUS_GONE,
-  HTTP_STATUS_LENGTH_REQUIRED, +  HTTP_STATUS_GONE, +HTTP_STATUS_LENGTH_REQUIRED, HTTP_STATUS_PRECONDITION_FAILED, HTTP_STATUS_REQ_ENTITY_TOO_LARGE, -HTTP_STATUS_REQ_URI_TOO_LONG,
-  HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, +  HTTP_STATUS_REQ_URI_TOO_LONG, +HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE, HTTP_STATUS_EXPECTATION_FAILED, -HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
-  HTTP_STATUS_NOT_IMPLEMENTED, +  HTTP_STATUS_INTERNAL_SERVER_ERROR = 500, +HTTP_STATUS_NOT_IMPLEMENTED, HTTP_STATUS_BAD_GATEWAY, HTTP_STATUS_SERVICE_UNAVAILABLE, -HTTP_STATUS_GATEWAY_TIMEOUT,
-  HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED +  HTTP_STATUS_GATEWAY_TIMEOUT, +HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED
}   diff --git a/doc/html/libwebsockets_8h.js b/doc/html/libwebsockets_8h.js index 56ae0ff..d02bab2 100644 --- a/doc/html/libwebsockets_8h.js +++ b/doc/html/libwebsockets_8h.js @@ -24,6 +24,7 @@ var libwebsockets_8h = [ "http_status", "group__html-chunked-substitution.html#gabc3b93f68c8bdd857ad32913628dfa8d", [ [ "HTTP_STATUS_OK", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad34cd21de350cd4fa83b8099e3993b91", null ], [ "HTTP_STATUS_NO_CONTENT", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad000a2e30c534c201201dd74fac8d2f9", null ], + [ "HTTP_STATUS_PARTIAL_CONTENT", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daa55ceddb5bb2104bfcfefb16995192a4", null ], [ "HTTP_STATUS_MOVED_PERMANENTLY", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da9632802fcd318d1676be7589e6004e96", null ], [ "HTTP_STATUS_FOUND", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da53df069872b37830e4296f32e7ec20d8", null ], [ "HTTP_STATUS_SEE_OTHER", "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dae301c12d0cf56920659cb7b947a95267", null ], diff --git a/doc/html/libwebsockets_8h_source.html b/doc/html/libwebsockets_8h_source.html index b93cf08..4b92013 100644 --- a/doc/html/libwebsockets_8h_source.html +++ b/doc/html/libwebsockets_8h_source.html @@ -64,9 +64,9 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
libwebsockets.h
-Go to the documentation of this file.
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation:
9  * version 2.1 of the License.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19  * MA 02110-1301 USA
20  */
21 
24 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
25 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
26 
27 #ifdef __cplusplus
28 #include <cstddef>
29 #include <cstdarg>
30 #ifdef MBED_OPERATORS
31 #include "mbed-drivers/mbed.h"
32 #include "sal-iface-eth/EthernetInterface.h"
33 #include "sockets/TCPListener.h"
34 #include "sal-stack-lwip/lwipv4_init.h"
35 
36 namespace {
37 }
38 using namespace mbed::Sockets::v0;
39 
40 
41 struct sockaddr_in;
42 struct lws;
43 
44 class lws_conn {
45  public:
46  lws_conn():
47  ts(NULL),
48  wsi(NULL),
49  writeable(1),
50  awaiting_on_writeable(0)
51  {
52  }
53 
54 public:
55  void set_wsi(struct lws *_wsi) { wsi = _wsi; }
56  int actual_onRX(Socket *s);
57  void onRX(Socket *s);
58  void onError(Socket *s, socket_error_t err);
59  void onDisconnect(TCPStream *s);
60  void onSent(Socket *s, uint16_t len);
61  void serialized_writeable(struct lws *wsi);
62 
63 public:
64  TCPStream *ts;
65 
66 public:
67  struct lws *wsi;
68  char writeable;
69  char awaiting_on_writeable;
70 };
71 
72 class lws_conn_listener : lws_conn {
73 public:
74  lws_conn_listener():
75  srv(SOCKET_STACK_LWIP_IPV4)
76  {
77  srv.setOnError(TCPStream::ErrorHandler_t(this,
78  &lws_conn_listener::onError));
79  }
80 
81  void start(const uint16_t port);
83 protected:
84  void onRX(Socket *s);
85  void onError(Socket *s, socket_error_t err);
86  void onIncoming(TCPListener *s, void *impl);
87  void onDisconnect(TCPStream *s);
89 public:
90  TCPListener srv;
91 };
92 
93 #endif
94 
95 extern "C" {
96 #else
97 #include <stdarg.h>
98 #endif
99 
100 #if defined(MBED_OPERATORS) || defined(LWS_WITH_ESP8266)
101 struct sockaddr_in;
102 #define LWS_POSIX 0
103 #else
104 #define LWS_POSIX 1
105 #endif
106 
107 #include "lws_config.h"
108 
109 #if defined(WIN32) || defined(_WIN32)
110 #ifndef WIN32_LEAN_AND_MEAN
111 #define WIN32_LEAN_AND_MEAN
112 #endif
113 
114 #include <winsock2.h>
115 #include <ws2tcpip.h>
116 #include <stddef.h>
117 #include <basetsd.h>
118 #ifndef _WIN32_WCE
119 #include <fcntl.h>
120 #else
121 #define _O_RDONLY 0x0000
122 #define O_RDONLY _O_RDONLY
123 #endif
124 
125 // Visual studio older than 2015 and WIN_CE has only _stricmp
126 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
127 #define strcasecmp _stricmp
128 #elif !defined(__MINGW32__)
129 #define strcasecmp stricmp
130 #endif
131 #define getdtablesize() 30000
132 
133 #define LWS_INLINE __inline
134 #define LWS_VISIBLE
135 #define LWS_WARN_UNUSED_RESULT
136 #define LWS_WARN_DEPRECATED
137 
138 #ifdef LWS_DLL
139 #ifdef LWS_INTERNAL
140 #define LWS_EXTERN extern __declspec(dllexport)
141 #else
142 #define LWS_EXTERN extern __declspec(dllimport)
143 #endif
144 #else
145 #define LWS_EXTERN
146 #endif
147 
148 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
149 #define LWS_O_RDONLY _O_RDONLY
150 
151 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
152 #define lws_snprintf _snprintf
153 #endif
154 
155 #ifndef __func__
156 #define __func__ __FUNCTION__
157 #endif
158 
159 #else /* NOT WIN32 */
160 #include <unistd.h>
161 
162 #if defined(__NetBSD__) || defined(__FreeBSD__)
163 #include <netinet/in.h>
164 #endif
165 
166 #define LWS_INLINE inline
167 #define LWS_O_RDONLY O_RDONLY
168 
169 #if !defined(MBED_OPERATORS) && !defined(LWS_WITH_ESP8266)
170 #include <poll.h>
171 #include <netdb.h>
172 #define LWS_INVALID_FILE -1
173 #else
174 #define getdtablesize() (20)
175 #define LWS_INVALID_FILE NULL
176 #endif
177 
178 #if defined(__GNUC__)
179 
180 /* warn_unused_result attribute only supported by GCC 3.4 or later */
181 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
182 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
183 #else
184 #define LWS_WARN_UNUSED_RESULT
185 #endif
186 
187 #define LWS_VISIBLE __attribute__((visibility("default")))
188 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
189 #else
190 #define LWS_VISIBLE
191 #define LWS_WARN_UNUSED_RESULT
192 #define LWS_WARN_DEPRECATED
193 #endif
194 
195 #if defined(__ANDROID__)
196 #include <unistd.h>
197 #define getdtablesize() sysconf(_SC_OPEN_MAX)
198 #endif
199 
200 #endif
201 
202 #ifdef LWS_USE_LIBEV
203 #include <ev.h>
204 #endif /* LWS_USE_LIBEV */
205 #ifdef LWS_USE_LIBUV
206 #include <uv.h>
207 #ifdef LWS_HAVE_UV_VERSION_H
208 #include <uv-version.h>
209 #endif
210 #endif /* LWS_USE_LIBUV */
211 
212 #ifndef LWS_EXTERN
213 #define LWS_EXTERN extern
214 #endif
215 
216 #ifdef _WIN32
217 #define random rand
218 #else
219 #include <sys/time.h>
220 #include <unistd.h>
221 #endif
222 
223 #ifdef LWS_OPENSSL_SUPPORT
224 
225 #ifdef USE_WOLFSSL
226 #ifdef USE_OLD_CYASSL
227 #include <cyassl/openssl/ssl.h>
228 #include <cyassl/error-ssl.h>
229 #else
230 #include <wolfssl/openssl/ssl.h>
231 #include <wolfssl/error-ssl.h>
232 #endif /* not USE_OLD_CYASSL */
233 #else
234 #if defined(LWS_USE_POLARSSL)
235 #include <polarssl/ssl.h>
236 struct lws_polarssl_context {
237  x509_crt ca;
238  x509_crt certificate;
239  rsa_context key;
240 };
241 typedef struct lws_polarssl_context SSL_CTX;
242 typedef ssl_context SSL;
243 #else
244 #if defined(LWS_USE_MBEDTLS)
245 #include <mbedtls/ssl.h>
246 #else
247 #include <openssl/ssl.h>
248 #include <openssl/err.h>
249 #endif /* not USE_MBEDTLS */
250 #endif /* not USE_POLARSSL */
251 #endif /* not USE_WOLFSSL */
252 #endif
253 
254 
255 #define CONTEXT_PORT_NO_LISTEN -1
256 
267 
269 enum lws_log_levels {
270  LLL_ERR = 1 << 0,
271  LLL_WARN = 1 << 1,
272  LLL_NOTICE = 1 << 2,
273  LLL_INFO = 1 << 3,
274  LLL_DEBUG = 1 << 4,
275  LLL_PARSER = 1 << 5,
276  LLL_HEADER = 1 << 6,
277  LLL_EXT = 1 << 7,
278  LLL_CLIENT = 1 << 8,
279  LLL_LATENCY = 1 << 9,
280 
281  LLL_COUNT = 10 /* set to count of valid flags */
282 };
283 
284 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...);
285 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
295 LWS_VISIBLE LWS_EXTERN int
296 lwsl_timestamp(int level, char *p, int len);
297 
298 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
299 
300 #if !defined(LWS_WITH_NO_LOGS)
301 /* notice, warn and log are always compiled in */
302 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
303 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
304 #endif
305 /*
306  * weaker logging can be deselected at configure time using --disable-debug
307  * that gets rid of the overhead of checking while keeping _warn and _err
308  * active
309  */
310 
311 #if defined(LWS_WITH_ESP8266)
312 #undef _DEBUG
313 #endif
314 
315 #ifdef _DEBUG
316 #if defined(LWS_WITH_NO_LOGS)
317 /* notice, warn and log are always compiled in */
318 //#define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
319 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
320 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
321 #endif
322 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
323 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
324 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
325 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
326 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
327 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
328 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
329 
335 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
336 
337 #else /* no debug */
338 #if defined(LWS_WITH_NO_LOGS)
339 //#define lwsl_err(...) do {} while(0)
340 #define lwsl_warn(...) do {} while(0)
341 #define lwsl_notice(...) do {} while(0)
342 #endif
343 #define lwsl_info(...) do {} while(0)
344 #define lwsl_debug(...) do {} while(0)
345 #define lwsl_parser(...) do {} while(0)
346 #define lwsl_header(...) do {} while(0)
347 #define lwsl_ext(...) do {} while(0)
348 #define lwsl_client(...) do {} while(0)
349 #define lwsl_latency(...) do {} while(0)
350 #define lwsl_hexdump(a, b)
351 
352 #endif
353 
364 LWS_VISIBLE LWS_EXTERN void
365 lws_set_log_level(int level,
366  void (*log_emit_function)(int level, const char *line));
367 
377 LWS_VISIBLE LWS_EXTERN void
378 lwsl_emit_syslog(int level, const char *line);
379 
381 
382 
383 #include <stddef.h>
384 
385 #ifndef lws_container_of
386 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
387 #endif
388 
389 
390 struct lws;
391 #ifndef ARRAY_SIZE
392 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
393 #endif
394 
395 /* api change list for user code to test against */
396 
397 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
398 
399 /* the struct lws_protocols has the id field present */
400 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
401 
402 /* you can call lws_get_peer_write_allowance */
403 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
404 
405 /* extra parameter introduced in 917f43ab821 */
406 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
407 
408 /* File operations stuff exists */
409 #define LWS_FEATURE_FOPS
410 
411 
412 #if defined(_WIN32)
413 typedef SOCKET lws_sockfd_type;
414 typedef HANDLE lws_filefd_type;
415 #define lws_sockfd_valid(sfd) (!!sfd)
416 struct lws_pollfd {
417  lws_sockfd_type fd;
418  SHORT events;
419  SHORT revents;
420 };
421 #define LWS_POLLHUP (FD_CLOSE)
422 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
423 #define LWS_POLLOUT (FD_WRITE)
424 #else
425 
426 #if defined(MBED_OPERATORS)
427 /* it's a class lws_conn * */
428 typedef void * lws_sockfd_type;
429 typedef void * lws_filefd_type;
430 #define lws_sockfd_valid(sfd) (!!sfd)
431 struct pollfd {
432  lws_sockfd_type fd;
433  short events;
434  short revents;
435 };
436 #define POLLIN 0x0001
437 #define POLLPRI 0x0002
438 #define POLLOUT 0x0004
439 #define POLLERR 0x0008
440 #define POLLHUP 0x0010
441 #define POLLNVAL 0x0020
442 
443 struct lws;
444 
445 void * mbed3_create_tcp_stream_socket(void);
446 void mbed3_delete_tcp_stream_socket(void *sockfd);
447 void mbed3_tcp_stream_bind(void *sock, int port, struct lws *);
448 void mbed3_tcp_stream_accept(void *sock, struct lws *);
449 #else
450 #if defined(LWS_WITH_ESP8266)
451 
452 #include <user_interface.h>
453 #include <espconn.h>
454 
455 typedef struct espconn * lws_sockfd_type;
456 typedef void * lws_filefd_type;
457 #define lws_sockfd_valid(sfd) (!!sfd)
458 struct pollfd {
459  lws_sockfd_type fd;
460  short events;
461  short revents;
462 };
463 #define POLLIN 0x0001
464 #define POLLPRI 0x0002
465 #define POLLOUT 0x0004
466 #define POLLERR 0x0008
467 #define POLLHUP 0x0010
468 #define POLLNVAL 0x0020
469 
470 struct lws_vhost;
471 
472 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
473 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
474 
475 #include <os_type.h>
476 #include <osapi.h>
477 #include "ets_sys.h"
478 
479 int ets_snprintf(char *str, size_t size, const char *format, ...);
480 #define snprintf ets_snprintf
481 
482 typedef os_timer_t uv_timer_t;
483 typedef void uv_cb_t(uv_timer_t *);
484 
485 void os_timer_disarm(void *);
486 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
487 
488 void ets_timer_arm_new(os_timer_t *, int, int, int);
489 
490 //void os_timer_arm(os_timer_t *, int, int);
491 
492 #define UV_VERSION_MAJOR 1
493 
494 #define lws_uv_getloop(a, b) (NULL)
495 
496 static inline void uv_timer_init(void *l, uv_timer_t *t)
497 {
498  (void)l;
499  memset(t, 0, sizeof(*t));
500  os_timer_disarm(t);
501 }
502 
503 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
504 {
505  os_timer_setfn(t, (os_timer_func_t *)cb, t);
506  /* ms, repeat */
507  os_timer_arm(t, first, !!rep);
508 }
509 
510 static inline void uv_timer_stop(uv_timer_t *t)
511 {
512  os_timer_disarm(t);
513 }
514 
515 #else
516 typedef int lws_sockfd_type;
517 typedef int lws_filefd_type;
518 #define lws_sockfd_valid(sfd) (sfd >= 0)
519 #endif
520 #endif
521 
522 #define lws_pollfd pollfd
523 #define LWS_POLLHUP (POLLHUP|POLLERR)
524 #define LWS_POLLIN (POLLIN)
525 #define LWS_POLLOUT (POLLOUT)
526 #endif
527 
530 struct lws_pollargs {
531  lws_sockfd_type fd;
532  int events;
533  int prev_events;
534 };
535 
536 struct lws_tokens;
537 struct lws_token_limits;
538 
546 
548 /*
549  * NOTE: These public enums are part of the abi. If you want to add one,
550  * add it at where specified so existing users are unaffected.
551  */
553 enum lws_close_status {
554  LWS_CLOSE_STATUS_NOSTATUS = 0,
555  LWS_CLOSE_STATUS_NORMAL = 1000,
558  LWS_CLOSE_STATUS_GOINGAWAY = 1001,
561  LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
564  LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
569  LWS_CLOSE_STATUS_RESERVED = 1004,
571  LWS_CLOSE_STATUS_NO_STATUS = 1005,
576  LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
582  LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
587  LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
593  LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
597  LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
605  LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
609  LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
616  /****** add new things just above ---^ ******/
617 
618  LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
619 };
620 
633 LWS_VISIBLE LWS_EXTERN void
634 lws_close_reason(struct lws *wsi, enum lws_close_status status,
635  unsigned char *buf, size_t len);
636 
638 
639 struct lws;
640 struct lws_context;
641 /* needed even with extensions disabled for create context */
642 struct lws_extension;
643 
655 
657 
658 /*
659  * NOTE: These public enums are part of the abi. If you want to add one,
660  * add it at where specified so existing users are unaffected.
661  */
663 enum lws_callback_reasons {
664  LWS_CALLBACK_ESTABLISHED = 0,
668  LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
712  LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
719  LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
722  LWS_CALLBACK_CLOSED = 4,
724  LWS_CALLBACK_CLOSED_HTTP = 5,
726  LWS_CALLBACK_RECEIVE = 6,
730  LWS_CALLBACK_RECEIVE_PONG = 7,
732  LWS_CALLBACK_CLIENT_RECEIVE = 8,
735  LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
737  LWS_CALLBACK_CLIENT_WRITEABLE = 10,
745  LWS_CALLBACK_SERVER_WRITEABLE = 11,
747  LWS_CALLBACK_HTTP = 12,
761  LWS_CALLBACK_HTTP_BODY = 13,
764  LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
766  LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
768  LWS_CALLBACK_HTTP_WRITEABLE = 16,
770  LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
781  LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
793  LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
801  LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
813  LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
820  LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
826  LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
844  LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
868  LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
879  LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
888  LWS_CALLBACK_PROTOCOL_INIT = 27,
891  LWS_CALLBACK_PROTOCOL_DESTROY = 28,
896  LWS_CALLBACK_WSI_CREATE = 29,
898  LWS_CALLBACK_WSI_DESTROY = 30,
900  LWS_CALLBACK_GET_THREAD_ID = 31,
905  /* external poll() management support */
906  LWS_CALLBACK_ADD_POLL_FD = 32,
922  LWS_CALLBACK_DEL_POLL_FD = 33,
928  LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
936  LWS_CALLBACK_LOCK_POLL = 35,
948  LWS_CALLBACK_UNLOCK_POLL = 36,
951  LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
959  LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
968  LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
971  LWS_CALLBACK_CGI = 40,
973  LWS_CALLBACK_CGI_TERMINATED = 41,
975  LWS_CALLBACK_CGI_STDIN_DATA = 42,
977  LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
979  LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
981  LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
983  LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
985  LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
987  LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
989  LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
991  LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
993  LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
995  LWS_CALLBACK_PROCESS_HTML = 52,
997  LWS_CALLBACK_ADD_HEADERS = 53,
999  LWS_CALLBACK_SESSION_INFO = 54,
1002  LWS_CALLBACK_GS_EVENT = 55,
1004  LWS_CALLBACK_HTTP_PMO = 56,
1009  LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1019  /****** add new things just above ---^ ******/
1020 
1021  LWS_CALLBACK_USER = 1000,
1023 };
1024 
1025 
1026 
1042 typedef int
1043 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1044  void *user, void *in, size_t len);
1046 
1056 
1058 /*
1059  * NOTE: These public enums are part of the abi. If you want to add one,
1060  * add it at where specified so existing users are unaffected.
1061  */
1062 enum lws_extension_callback_reasons {
1063  LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1064  LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1065  LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1066  LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1067  LWS_EXT_CB_CONSTRUCT = 4,
1068  LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1069  LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1070  LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1071  LWS_EXT_CB_DESTROY = 8,
1072  LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1073  LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1074  LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1075  LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1076  LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1077  LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1078  LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1079  LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1080  LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1081  LWS_EXT_CB_1HZ = 18,
1082  LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1083  LWS_EXT_CB_IS_WRITEABLE = 20,
1084  LWS_EXT_CB_PAYLOAD_TX = 21,
1085  LWS_EXT_CB_PAYLOAD_RX = 22,
1086  LWS_EXT_CB_OPTION_DEFAULT = 23,
1087  LWS_EXT_CB_OPTION_SET = 24,
1088  LWS_EXT_CB_OPTION_CONFIRM = 25,
1089  LWS_EXT_CB_NAMED_OPTION_SET = 26,
1090 
1091  /****** add new things just above ---^ ******/
1092 };
1093 
1095 enum lws_ext_options_types {
1096  EXTARG_NONE,
1097  EXTARG_DEC,
1098  EXTARG_OPT_DEC
1100  /* Add new things just above here ---^
1101  * This is part of the ABI, don't needlessly break compatibility */
1102 };
1103 
1108 struct lws_ext_options {
1109  const char *name;
1110  enum lws_ext_options_types type;
1112  /* Add new things just above here ---^
1113  * This is part of the ABI, don't needlessly break compatibility */
1114 };
1115 
1117 struct lws_ext_option_arg {
1118  const char *option_name;
1119  int option_index;
1120  const char *start;
1121  int len;
1122 };
1123 
1184 typedef int
1185 lws_extension_callback_function(struct lws_context *context,
1186  const struct lws_extension *ext, struct lws *wsi,
1187  enum lws_extension_callback_reasons reason,
1188  void *user, void *in, size_t len);
1189 
1191 struct lws_extension {
1192  const char *name;
1193  lws_extension_callback_function *callback;
1194  const char *client_offer;
1196  /* Add new things just above here ---^
1197  * This is part of the ABI, don't needlessly break compatibility */
1198 };
1199 
1208 LWS_VISIBLE LWS_EXTERN int
1209 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1210  const char *opt_name, const char *opt_val);
1211 
1212 #ifndef LWS_NO_EXTENSIONS
1213 /* lws_get_internal_extensions() - DEPRECATED
1214  *
1215  * \Deprecated There is no longer a set internal extensions table. The table is provided
1216  * by user code along with application-specific settings. See the test
1217  * client and server for how to do.
1218  */
1219 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1220 lws_get_internal_extensions(void) { return NULL; }
1221 
1232 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1233 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1234  void *ext_user, const struct lws_ext_options *opts,
1235  const char *o, int len);
1236 #endif
1237 
1250 LWS_EXTERN
1251 int lws_extension_callback_pm_deflate(
1252  struct lws_context *context, const struct lws_extension *ext,
1253  struct lws *wsi, enum lws_extension_callback_reasons reason,
1254  void *user, void *in, size_t len);
1255 
1256 /*
1257  * The internal exts are part of the public abi
1258  * If we add more extensions, publish the callback here ------v
1259  */
1261 
1277 
1281 struct lws_protocols {
1282  const char *name;
1285  lws_callback_function *callback;
1289  size_t per_session_data_size;
1294  size_t rx_buffer_size;
1303  unsigned int id;
1310  void *user;
1313  /* Add new things just above here ---^
1314  * This is part of the ABI, don't needlessly break compatibility */
1315 };
1316 
1317 struct lws_vhost;
1318 
1327 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1328 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1329 
1339 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1340 lws_get_protocol(struct lws *wsi);
1341 
1343 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1344 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1345 
1356 LWS_VISIBLE LWS_EXTERN void *
1357 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1358  int size);
1359 
1369 LWS_VISIBLE LWS_EXTERN void *
1370 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1371 
1380 LWS_VISIBLE LWS_EXTERN int
1381 lws_finalize_startup(struct lws_context *context);
1382 
1383 #ifdef LWS_WITH_PLUGINS
1384 
1385 /* PLUGINS implies LIBUV */
1386 
1387 #define LWS_PLUGIN_API_MAGIC 180
1388 
1390 struct lws_plugin_capability {
1391  unsigned int api_magic;
1392  const struct lws_protocols *protocols;
1393  int count_protocols;
1394  const struct lws_extension *extensions;
1395  int count_extensions;
1396 };
1397 
1398 typedef int (*lws_plugin_init_func)(struct lws_context *,
1399  struct lws_plugin_capability *);
1400 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1401 
1403 struct lws_plugin {
1404  struct lws_plugin *list;
1405 #if (UV_VERSION_MAJOR > 0)
1406  uv_lib_t lib;
1407 #else
1408  void *l;
1409 #endif
1410  char name[64];
1411  struct lws_plugin_capability caps;
1412 };
1413 
1414 #endif
1415 
1417 
1418 
1427 
1429 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1430 
1432 /* SHA-1 binary and hexified versions */
1434 typedef struct { unsigned char bin[20]; } lwsgw_hash_bin;
1436 typedef struct { char id[41]; } lwsgw_hash;
1437 
1439 enum lwsgs_auth_bits {
1440  LWSGS_AUTH_LOGGED_IN = 1,
1441  LWSGS_AUTH_ADMIN = 2,
1442  LWSGS_AUTH_VERIFIED = 4,
1443  LWSGS_AUTH_FORGOT_FLOW = 8,
1444 };
1445 
1447 struct lws_session_info {
1448  char username[32];
1449  char email[100];
1450  char ip[72];
1451  unsigned int mask;
1453  char session[42];
1454 };
1455 
1457 enum lws_gs_event {
1458  LWSGSE_CREATED,
1459  LWSGSE_DELETED
1460 };
1461 
1463 struct lws_gs_event_args {
1464  enum lws_gs_event event;
1465  const char *username;
1466  const char *email;
1467 };
1468 
1470 
1471 
1485 
1487 /*
1488  * NOTE: These public enums are part of the abi. If you want to add one,
1489  * add it at where specified so existing users are unaffected.
1490  */
1491 
1493 enum lws_context_options {
1494  LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1495  (1 << 12),
1499  LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1501  LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1502  (1 << 12),
1506  LWS_SERVER_OPTION_LIBEV = (1 << 4),
1508  LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1510  LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1513  LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1515  LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1517  LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1518  (1 << 12),
1520  LWS_SERVER_OPTION_LIBUV = (1 << 10),
1522  LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1523  (1 << 12),
1526  LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1528  LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1531  LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1533  LWS_SERVER_OPTION_STS = (1 << 15),
1536  LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1538  LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1540  LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1547  /****** add new things just above ---^ ******/
1548 };
1549 
1550 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1551 
1561 struct lws_context_creation_info {
1562  int port;
1567  const char *iface;
1574  const struct lws_protocols *protocols;
1578  const struct lws_extension *extensions;
1581  const struct lws_token_limits *token_limits;
1584  const char *ssl_private_key_password;
1586  const char *ssl_cert_filepath;
1590  const char *ssl_private_key_filepath;
1596  const char *ssl_ca_filepath;
1598  const char *ssl_cipher_list;
1602  const char *http_proxy_address;
1605  unsigned int http_proxy_port;
1607  int gid;
1609  int uid;
1611  unsigned int options;
1613  void *user;
1616  int ka_time;
1619  int ka_probes;
1623  int ka_interval;
1626 #ifdef LWS_OPENSSL_SUPPORT
1627  SSL_CTX *provided_client_ssl_ctx;
1632 #else /* maintain structure layout either way */
1633  void *provided_client_ssl_ctx;
1634 #endif
1635 
1636  short max_http_header_data;
1639  short max_http_header_pool;
1646  unsigned int count_threads;
1648  unsigned int fd_limit_per_thread;
1652  unsigned int timeout_secs;
1657  const char *ecdh_curve;
1659  const char *vhost_name;
1663  const char * const *plugin_dirs;
1666  const struct lws_protocol_vhost_options *pvo;
1669  int keepalive_timeout;
1672  const char *log_filepath;
1675  const struct lws_http_mount *mounts;
1677  const char *server_string;
1680  unsigned int pt_serv_buf_size;
1686  unsigned int max_http_header_data2;
1691  long ssl_options_set;
1693  long ssl_options_clear;
1695  unsigned short ws_ping_pong_interval;
1707  const struct lws_protocol_vhost_options *headers;
1711  const struct lws_protocol_vhost_options *reject_service_keywords;
1718  void *external_baggage_free_on_destroy;
1726  /* Add new things just above here ---^
1727  * This is part of the ABI, don't needlessly break compatibility
1728  *
1729  * The below is to ensure later library versions with new
1730  * members added above will see 0 (default) even if the app
1731  * was not built against the newer headers.
1732  */
1733 
1734  void *_unused[8];
1735 };
1736 
1771 LWS_VISIBLE LWS_EXTERN struct lws_context *
1772 lws_create_context(struct lws_context_creation_info *info);
1773 
1782 LWS_VISIBLE LWS_EXTERN void
1783 lws_context_destroy(struct lws_context *context);
1784 
1802 LWS_VISIBLE LWS_EXTERN int
1803 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
1804 
1805 
1806 struct lws_vhost;
1807 
1817 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
1818 lws_create_vhost(struct lws_context *context,
1819  struct lws_context_creation_info *info);
1820 
1835 LWS_VISIBLE LWS_EXTERN int
1836 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
1837  char **config_strings, int *len);
1838 
1854 LWS_VISIBLE LWS_EXTERN int
1855 lwsws_get_config_vhosts(struct lws_context *context,
1856  struct lws_context_creation_info *info, const char *d,
1857  char **config_strings, int *len);
1858 
1860 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1861 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1862 
1868 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1869 lws_get_vhost(struct lws *wsi);
1870 
1878 LWS_VISIBLE LWS_EXTERN int
1879 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
1880 
1888 LWS_VISIBLE LWS_EXTERN int
1889 lws_json_dump_context(const struct lws_context *context, char *buf, int len);
1890 
1900 LWS_VISIBLE LWS_EXTERN void *
1901 lws_context_user(struct lws_context *context);
1902 
1908 
1915 struct lws_protocol_vhost_options {
1916  const struct lws_protocol_vhost_options *next;
1917  const struct lws_protocol_vhost_options *options;
1918  const char *name;
1919  const char *value;
1920 };
1921 
1926 enum lws_mount_protocols {
1927  LWSMPRO_HTTP = 0,
1928  LWSMPRO_HTTPS = 1,
1929  LWSMPRO_FILE = 2,
1930  LWSMPRO_CGI = 3,
1931  LWSMPRO_REDIR_HTTP = 4,
1932  LWSMPRO_REDIR_HTTPS = 5,
1933  LWSMPRO_CALLBACK = 6,
1934 };
1935 
1940 struct lws_http_mount {
1941  const struct lws_http_mount *mount_next;
1943  const char *mountpoint;
1945  const char *origin;
1947  const char *def;
1949  const char *protocol;
1952  const struct lws_protocol_vhost_options *cgienv;
1956  const struct lws_protocol_vhost_options *extra_mimetypes;
1958  const struct lws_protocol_vhost_options *interpret;
1961  int cgi_timeout;
1963  int cache_max_age;
1965  unsigned int auth_mask;
1968  unsigned int cache_reusable:1;
1969  unsigned int cache_revalidate:1;
1970  unsigned int cache_intermediaries:1;
1972  unsigned char origin_protocol;
1973  unsigned char mountpoint_len;
1975  const char *basic_auth_login_file;
1978  /* Add new things just above here ---^
1979  * This is part of the ABI, don't needlessly break compatibility
1980  *
1981  * The below is to ensure later library versions with new
1982  * members added above will see 0 (default) even if the app
1983  * was not built against the newer headers.
1984  */
1985 
1986  void *_unused[2];
1987 };
1990 
1996 
2003 enum lws_client_connect_ssl_connection_flags {
2004  LCCSCF_USE_SSL = (1 << 0),
2005  LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2006  LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2007  LCCSCF_ALLOW_EXPIRED = (1 << 3)
2008 };
2009 
2013 struct lws_client_connect_info {
2014  struct lws_context *context;
2016  const char *address;
2018  int port;
2020  int ssl_connection;
2022  const char *path;
2024  const char *host;
2026  const char *origin;
2028  const char *protocol;
2030  int ietf_version_or_minus_one;
2032  void *userdata;
2034  const struct lws_extension *client_exts;
2036  const char *method;
2039  struct lws *parent_wsi;
2043  const char *uri_replace_from;
2046  const char *uri_replace_to;
2048  struct lws_vhost *vhost;
2050  struct lws **pwsi;
2062  /* Add new things just above here ---^
2063  * This is part of the ABI, don't needlessly break compatibility
2064  *
2065  * The below is to ensure later library versions with new
2066  * members added above will see 0 (default) even if the app
2067  * was not built against the newer headers.
2068  */
2069 
2070  void *_unused[4];
2071 };
2072 
2080 LWS_VISIBLE LWS_EXTERN struct lws *
2081 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2082 
2103 /* deprecated, use lws_client_connect_via_info() */
2104 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2105 lws_client_connect(struct lws_context *clients, const char *address,
2106  int port, int ssl_connection, const char *path,
2107  const char *host, const char *origin, const char *protocol,
2108  int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2109 /* deprecated, use lws_client_connect_via_info() */
2130 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2131 lws_client_connect_extended(struct lws_context *clients, const char *address,
2132  int port, int ssl_connection, const char *path,
2133  const char *host, const char *origin,
2134  const char *protocol, int ietf_version_or_minus_one,
2135  void *userdata) LWS_WARN_DEPRECATED;
2136 
2162 LWS_VISIBLE LWS_EXTERN int
2163 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2164  struct lws_vhost *vhost);
2165 
2166 LWS_VISIBLE LWS_EXTERN int
2167 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2168 
2176 LWS_VISIBLE LWS_EXTERN unsigned int
2177 lws_http_client_http_response(struct lws *wsi);
2178 
2179 LWS_VISIBLE LWS_EXTERN void
2180 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2181 
2202 
2211 
2244 LWS_VISIBLE LWS_EXTERN int
2245 lws_service(struct lws_context *context, int timeout_ms);
2246 
2258 LWS_VISIBLE LWS_EXTERN int
2259 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2260 
2276 LWS_VISIBLE LWS_EXTERN void
2277 lws_cancel_service_pt(struct lws *wsi);
2278 
2290 LWS_VISIBLE LWS_EXTERN void
2291 lws_cancel_service(struct lws_context *context);
2292 
2319 LWS_VISIBLE LWS_EXTERN int
2320 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2321 
2331 LWS_VISIBLE LWS_EXTERN int
2332 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2333  int tsi);
2334 
2352 LWS_VISIBLE LWS_EXTERN int
2353 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2354 
2355 /* Backwards compatibility */
2356 #define lws_plat_service_tsi lws_service_tsi
2357 
2359 
2365 
2372 
2384 LWS_VISIBLE LWS_EXTERN const char *
2385 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2386 
2405 LWS_VISIBLE LWS_EXTERN int
2406 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2407  const char *other_headers, int other_headers_len);
2408 LWS_VISIBLE LWS_EXTERN int
2409 lws_serve_http_file_fragment(struct lws *wsi);
2411 
2422 
2423 enum http_status {
2424  HTTP_STATUS_OK = 200,
2425  HTTP_STATUS_NO_CONTENT = 204,
2426 
2427  HTTP_STATUS_MOVED_PERMANENTLY = 301,
2428  HTTP_STATUS_FOUND = 302,
2429  HTTP_STATUS_SEE_OTHER = 303,
2430 
2431  HTTP_STATUS_BAD_REQUEST = 400,
2432  HTTP_STATUS_UNAUTHORIZED,
2433  HTTP_STATUS_PAYMENT_REQUIRED,
2434  HTTP_STATUS_FORBIDDEN,
2435  HTTP_STATUS_NOT_FOUND,
2436  HTTP_STATUS_METHOD_NOT_ALLOWED,
2437  HTTP_STATUS_NOT_ACCEPTABLE,
2438  HTTP_STATUS_PROXY_AUTH_REQUIRED,
2439  HTTP_STATUS_REQUEST_TIMEOUT,
2440  HTTP_STATUS_CONFLICT,
2441  HTTP_STATUS_GONE,
2442  HTTP_STATUS_LENGTH_REQUIRED,
2443  HTTP_STATUS_PRECONDITION_FAILED,
2444  HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2445  HTTP_STATUS_REQ_URI_TOO_LONG,
2446  HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2447  HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2448  HTTP_STATUS_EXPECTATION_FAILED,
2449 
2450  HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2451  HTTP_STATUS_NOT_IMPLEMENTED,
2452  HTTP_STATUS_BAD_GATEWAY,
2453  HTTP_STATUS_SERVICE_UNAVAILABLE,
2454  HTTP_STATUS_GATEWAY_TIMEOUT,
2455  HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2456 };
2457 
2458 struct lws_process_html_args {
2459  char *p;
2460  int len;
2461  int max_len;
2462  int final;
2463 };
2464 
2465 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2466 
2467 struct lws_process_html_state {
2468  char *start;
2469  char swallow[16];
2470  int pos;
2471  void *data;
2472  const char * const *vars;
2473  int count_vars;
2475  lws_process_html_state_cb replace;
2476 };
2477 
2482 LWS_VISIBLE LWS_EXTERN int
2483 lws_chunked_html_process(struct lws_process_html_args *args,
2484  struct lws_process_html_state *s);
2486 
2519 
2527 struct lws_tokens {
2528  char *token;
2529  int token_len;
2530 };
2531 
2532 /* enum lws_token_indexes
2533  * these have to be kept in sync with lextable.h / minilex.c
2534  *
2535  * NOTE: These public enums are part of the abi. If you want to add one,
2536  * add it at where specified so existing users are unaffected.
2537  */
2538 enum lws_token_indexes {
2539  WSI_TOKEN_GET_URI = 0,
2540  WSI_TOKEN_POST_URI = 1,
2541  WSI_TOKEN_OPTIONS_URI = 2,
2542  WSI_TOKEN_HOST = 3,
2543  WSI_TOKEN_CONNECTION = 4,
2544  WSI_TOKEN_UPGRADE = 5,
2545  WSI_TOKEN_ORIGIN = 6,
2546  WSI_TOKEN_DRAFT = 7,
2547  WSI_TOKEN_CHALLENGE = 8,
2548  WSI_TOKEN_EXTENSIONS = 9,
2549  WSI_TOKEN_KEY1 = 10,
2550  WSI_TOKEN_KEY2 = 11,
2551  WSI_TOKEN_PROTOCOL = 12,
2552  WSI_TOKEN_ACCEPT = 13,
2553  WSI_TOKEN_NONCE = 14,
2554  WSI_TOKEN_HTTP = 15,
2555  WSI_TOKEN_HTTP2_SETTINGS = 16,
2556  WSI_TOKEN_HTTP_ACCEPT = 17,
2557  WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2558  WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2559  WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2560  WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2561  WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2562  WSI_TOKEN_HTTP_PRAGMA = 23,
2563  WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2564  WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2565  WSI_TOKEN_HTTP_COOKIE = 26,
2566  WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2567  WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2568  WSI_TOKEN_HTTP_DATE = 29,
2569  WSI_TOKEN_HTTP_RANGE = 30,
2570  WSI_TOKEN_HTTP_REFERER = 31,
2571  WSI_TOKEN_KEY = 32,
2572  WSI_TOKEN_VERSION = 33,
2573  WSI_TOKEN_SWORIGIN = 34,
2574 
2575  WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2576  WSI_TOKEN_HTTP_COLON_METHOD = 36,
2577  WSI_TOKEN_HTTP_COLON_PATH = 37,
2578  WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2579  WSI_TOKEN_HTTP_COLON_STATUS = 39,
2580 
2581  WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2582  WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2583  WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2584  WSI_TOKEN_HTTP_AGE = 43,
2585  WSI_TOKEN_HTTP_ALLOW = 44,
2586  WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2587  WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2588  WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2589  WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2590  WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2591  WSI_TOKEN_HTTP_ETAG = 50,
2592  WSI_TOKEN_HTTP_EXPECT = 51,
2593  WSI_TOKEN_HTTP_EXPIRES = 52,
2594  WSI_TOKEN_HTTP_FROM = 53,
2595  WSI_TOKEN_HTTP_IF_MATCH = 54,
2596  WSI_TOKEN_HTTP_IF_RANGE = 55,
2597  WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2598  WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2599  WSI_TOKEN_HTTP_LINK = 58,
2600  WSI_TOKEN_HTTP_LOCATION = 59,
2601  WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2602  WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2603  WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2604  WSI_TOKEN_HTTP_REFRESH = 63,
2605  WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2606  WSI_TOKEN_HTTP_SERVER = 65,
2607  WSI_TOKEN_HTTP_SET_COOKIE = 66,
2608  WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2609  WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
2610  WSI_TOKEN_HTTP_USER_AGENT = 69,
2611  WSI_TOKEN_HTTP_VARY = 70,
2612  WSI_TOKEN_HTTP_VIA = 71,
2613  WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
2614 
2615  WSI_TOKEN_PATCH_URI = 73,
2616  WSI_TOKEN_PUT_URI = 74,
2617  WSI_TOKEN_DELETE_URI = 75,
2618 
2619  WSI_TOKEN_HTTP_URI_ARGS = 76,
2620  WSI_TOKEN_PROXY = 77,
2621  WSI_TOKEN_HTTP_X_REAL_IP = 78,
2622  WSI_TOKEN_HTTP1_0 = 79,
2623  WSI_TOKEN_X_FORWARDED_FOR = 80,
2624 
2625  /****** add new things just above ---^ ******/
2626 
2627  /* use token storage to stash these internally, not for
2628  * user use */
2629 
2630  _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
2631  _WSI_TOKEN_CLIENT_PEER_ADDRESS,
2632  _WSI_TOKEN_CLIENT_URI,
2633  _WSI_TOKEN_CLIENT_HOST,
2634  _WSI_TOKEN_CLIENT_ORIGIN,
2635  _WSI_TOKEN_CLIENT_METHOD,
2636 
2637  /* always last real token index*/
2638  WSI_TOKEN_COUNT,
2639 
2640  /* parser state additions, no storage associated */
2641  WSI_TOKEN_NAME_PART,
2642  WSI_TOKEN_SKIPPING,
2643  WSI_TOKEN_SKIPPING_SAW_CR,
2644  WSI_PARSING_COMPLETE,
2645  WSI_INIT_TOKEN_MUXURL,
2646 };
2647 
2648 struct lws_token_limits {
2649  unsigned short token_limit[WSI_TOKEN_COUNT];
2650 };
2651 
2657 LWS_VISIBLE LWS_EXTERN const unsigned char *
2658 lws_token_to_string(enum lws_token_indexes token);
2659 
2660 
2669 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2670 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
2671 
2681 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2682 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
2683 
2697 LWS_VISIBLE LWS_EXTERN int
2698 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
2699 
2717 LWS_VISIBLE LWS_EXTERN int
2718 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
2719  enum lws_token_indexes h, int frag_idx);
2720 
2731 LWS_VISIBLE LWS_EXTERN const char *
2732 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
2734 
2749 
2760 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2761 lws_add_http_header_status(struct lws *wsi,
2762  unsigned int code, unsigned char **p,
2763  unsigned char *end);
2776 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2777 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
2778  const unsigned char *value, int length,
2779  unsigned char **p, unsigned char *end);
2793 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2794 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
2795  const unsigned char *value, int length,
2796  unsigned char **p, unsigned char *end);
2807 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2808 lws_add_http_header_content_length(struct lws *wsi,
2809  unsigned long content_length,
2810  unsigned char **p, unsigned char *end);
2820 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2821 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
2822  unsigned char *end);
2824 
2843 
2846 enum lws_spa_fileupload_states {
2847  LWS_UFS_CONTENT,
2849  LWS_UFS_FINAL_CONTENT,
2851  LWS_UFS_OPEN
2853 };
2854 
2868 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
2869  const char *filename, char *buf, int len,
2870  enum lws_spa_fileupload_states state);
2871 
2874 struct lws_spa;
2875 
2894 LWS_VISIBLE LWS_EXTERN struct lws_spa *
2895 lws_spa_create(struct lws *wsi, const char * const *param_names,
2896  int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
2897  void *opt_data);
2898 
2906 LWS_VISIBLE LWS_EXTERN int
2907 lws_spa_process(struct lws_spa *spa, const char *in, int len);
2908 
2914 LWS_VISIBLE LWS_EXTERN int
2915 lws_spa_finalize(struct lws_spa *spa);
2916 
2923 LWS_VISIBLE LWS_EXTERN int
2924 lws_spa_get_length(struct lws_spa *spa, int n);
2925 
2931 LWS_VISIBLE LWS_EXTERN const char *
2932 lws_spa_get_string(struct lws_spa *spa, int n);
2933 
2939 LWS_VISIBLE LWS_EXTERN int
2940 lws_spa_destroy(struct lws_spa *spa);
2942 
2953 
2964 LWS_VISIBLE LWS_EXTERN const char *
2965 lws_urlencode(char *escaped, const char *string, int len);
2966 
2967 /*
2968  * URLDECODE 1 / 2
2969  *
2970  * This simple urldecode only operates until the first '\0' and requires the
2971  * data to exist all at once
2972  */
2985 LWS_VISIBLE LWS_EXTERN int
2986 lws_urldecode(char *string, const char *escaped, int len);
2988 
2997 LWS_VISIBLE LWS_EXTERN int
2998 lws_return_http_status(struct lws *wsi, unsigned int code,
2999  const char *html_body);
3000 
3011 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3012 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3013  unsigned char **p, unsigned char *end);
3014 
3023 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3024 lws_http_transaction_completed(struct lws *wsi);
3026 
3034 
3045 LWS_VISIBLE LWS_EXTERN const char *
3046 lws_sql_purify(char *escaped, const char *string, int len);
3047 
3058 LWS_VISIBLE LWS_EXTERN const char *
3059 lws_json_purify(char *escaped, const char *string, int len);
3061 
3068 
3070 #ifdef LWS_USE_LIBEV
3071 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3072 
3073 LWS_VISIBLE LWS_EXTERN int
3074 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3075  lws_ev_signal_cb_t *cb);
3076 
3077 LWS_VISIBLE LWS_EXTERN int
3078 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3079 
3080 LWS_VISIBLE LWS_EXTERN void
3081 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3082 #endif /* LWS_USE_LIBEV */
3083 
3085 
3092 #ifdef LWS_USE_LIBUV
3094 LWS_VISIBLE LWS_EXTERN int
3095 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3096  uv_signal_cb cb);
3097 
3098 LWS_VISIBLE LWS_EXTERN void
3099 lws_libuv_run(const struct lws_context *context, int tsi);
3100 
3101 LWS_VISIBLE LWS_EXTERN void
3102 lws_libuv_stop(struct lws_context *context);
3103 
3104 LWS_VISIBLE LWS_EXTERN int
3105 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3106 
3107 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3108 lws_uv_getloop(struct lws_context *context, int tsi);
3109 
3110 LWS_VISIBLE LWS_EXTERN void
3111 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3112 #endif /* LWS_USE_LIBUV */
3113 
3120 
3121 /*
3122  * NOTE: These public enums are part of the abi. If you want to add one,
3123  * add it at where specified so existing users are unaffected.
3124  */
3125 enum pending_timeout {
3126  NO_PENDING_TIMEOUT = 0,
3127  PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3128  PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3129  PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3130  PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3131  PENDING_TIMEOUT_AWAITING_PING = 5,
3132  PENDING_TIMEOUT_CLOSE_ACK = 6,
3133  PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3134  PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3135  PENDING_TIMEOUT_SSL_ACCEPT = 9,
3136  PENDING_TIMEOUT_HTTP_CONTENT = 10,
3137  PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3138  PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3139  PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3140  PENDING_TIMEOUT_CGI = 14,
3141  PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3142  PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3143  PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3144  PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3145 
3146  /****** add new things just above ---^ ******/
3147 };
3148 
3158 LWS_VISIBLE LWS_EXTERN void
3159 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3161 
3167 #if !defined(LWS_SIZEOFPTR)
3168 #define LWS_SIZEOFPTR (sizeof (void *))
3169 #endif
3170 #if !defined(u_int64_t)
3171 #define u_int64_t unsigned long long
3172 #endif
3173 
3174 #if defined(__x86_64__)
3175 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3176 #else
3177 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3178 #endif
3179 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3180  ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3181 #define LWS_PRE _LWS_PAD(4 + 10)
3182 /* used prior to 1.7 and retained for backward compatibility */
3183 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3184 #define LWS_SEND_BUFFER_POST_PADDING 0
3185 
3186 /*
3187  * NOTE: These public enums are part of the abi. If you want to add one,
3188  * add it at where specified so existing users are unaffected.
3189  */
3190 enum lws_write_protocol {
3191  LWS_WRITE_TEXT = 0,
3195  LWS_WRITE_BINARY = 1,
3198  LWS_WRITE_CONTINUATION = 2,
3201  LWS_WRITE_HTTP = 3,
3204  /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3205  LWS_WRITE_PING = 5,
3206  LWS_WRITE_PONG = 6,
3207 
3208  /* Same as write_http but we know this write ends the transaction */
3209  LWS_WRITE_HTTP_FINAL = 7,
3210 
3211  /* HTTP2 */
3212 
3213  LWS_WRITE_HTTP_HEADERS = 8,
3220  /****** add new things just above ---^ ******/
3221 
3222  /* flags */
3223 
3224  LWS_WRITE_NO_FIN = 0x40,
3227  LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3231 };
3232 
3233 
3320 LWS_VISIBLE LWS_EXTERN int
3321 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3322  enum lws_write_protocol protocol);
3323 
3324 /* helper for case where buffer may be const */
3325 #define lws_write_http(wsi, buf, len) \
3326  lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3327 
3347 
3360 LWS_VISIBLE LWS_EXTERN int
3361 lws_callback_on_writable(struct lws *wsi);
3362 
3376 LWS_VISIBLE LWS_EXTERN int
3377 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3378  const struct lws_protocols *protocol);
3379 
3393 LWS_VISIBLE LWS_EXTERN int
3394 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3395  const struct lws_protocols *protocol);
3396 
3409 LWS_VISIBLE LWS_EXTERN int
3410 lws_callback_all_protocol(struct lws_context *context,
3411  const struct lws_protocols *protocol, int reason);
3412 
3425 LWS_VISIBLE LWS_EXTERN int
3426 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3427  const struct lws_protocols *protocol, int reason);
3428 
3442 LWS_VISIBLE LWS_EXTERN int
3443 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3444 
3445 LWS_VISIBLE LWS_EXTERN int
3446 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3447  void *user, void *in, size_t len);
3448 
3456 LWS_VISIBLE LWS_EXTERN int
3457 lws_get_socket_fd(struct lws *wsi);
3458 
3480 LWS_VISIBLE LWS_EXTERN size_t
3481 lws_get_peer_write_allowance(struct lws *wsi);
3483 
3494 LWS_VISIBLE LWS_EXTERN int
3495 lws_rx_flow_control(struct lws *wsi, int enable);
3496 
3506 LWS_VISIBLE LWS_EXTERN void
3507 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3508  const struct lws_protocols *protocol);
3509 
3526 LWS_VISIBLE LWS_EXTERN size_t
3527 lws_remaining_packet_payload(struct lws *wsi);
3528 
3529 
3538 
3551 LWS_VISIBLE LWS_EXTERN struct lws *
3552 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3575 LWS_VISIBLE LWS_EXTERN struct lws *
3576 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
3577  const char *readbuf, size_t len);
3579 
3585 
3596 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3597 lws_canonical_hostname(struct lws_context *context);
3598 
3613 LWS_VISIBLE LWS_EXTERN void
3614 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
3615  int name_len, char *rip, int rip_len);
3616 
3627 LWS_VISIBLE LWS_EXTERN const char *
3628 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
3629 #ifndef LWS_WITH_ESP8266
3630 
3641 LWS_VISIBLE LWS_EXTERN int
3642 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
3643  size_t addrlen);
3645 #endif
3646 
3652 
3665 LWS_VISIBLE LWS_EXTERN int
3666 lws_snprintf(char *str, size_t size, const char *format, ...);
3667 
3679 LWS_VISIBLE LWS_EXTERN int
3680 lws_get_random(struct lws_context *context, void *buf, int len);
3688 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3689 lws_daemonize(const char *_lock_path);
3695 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3696 lws_get_library_version(void);
3697 
3704 LWS_VISIBLE LWS_EXTERN void *
3705 lws_wsi_user(struct lws *wsi);
3706 
3718 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3719 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
3720  const char **path);
3721 
3725 LWS_VISIBLE LWS_EXTERN unsigned long
3726 lws_now_secs(void);
3727 
3737 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
3738 lws_get_context(const struct lws *wsi);
3739 
3749 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3750 lws_get_count_threads(struct lws_context *context);
3751 
3759 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3760 lws_get_parent(const struct lws *wsi);
3761 
3768 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3769 lws_get_child(const struct lws *wsi);
3770 
3771 
3772 /*
3773  * \deprecated DEPRECATED Note: this is not normally needed as a user api.
3774  * It's provided in case it is
3775  * useful when integrating with other app poll loop service code.
3776  */
3777 LWS_VISIBLE LWS_EXTERN int
3778 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
3779 
3787 LWS_VISIBLE LWS_EXTERN void
3788 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
3790 
3796 
3803 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3804 lws_send_pipe_choked(struct lws *wsi);
3805 
3810 LWS_VISIBLE LWS_EXTERN int
3811 lws_is_final_fragment(struct lws *wsi);
3812 
3817 LWS_VISIBLE LWS_EXTERN unsigned char
3818 lws_get_reserved_bits(struct lws *wsi);
3819 
3836 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3837 lws_partial_buffered(struct lws *wsi);
3838 
3848 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3849 lws_frame_is_binary(struct lws *wsi);
3850 
3859 LWS_VISIBLE LWS_EXTERN int
3860 lws_is_ssl(struct lws *wsi);
3865 LWS_VISIBLE LWS_EXTERN int
3866 lws_is_cgi(struct lws *wsi);
3868 
3869 
3875 #ifdef LWS_SHA1_USE_OPENSSL_NAME
3877 #define lws_SHA1 SHA1
3878 #else
3879 
3888 LWS_VISIBLE LWS_EXTERN unsigned char *
3889 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
3890 #endif
3891 
3901 LWS_VISIBLE LWS_EXTERN int
3902 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
3912 LWS_VISIBLE LWS_EXTERN int
3913 lws_b64_decode_string(const char *in, char *out, int out_size);
3915 
3916 
3926 #ifdef LWS_WITH_CGI
3927 enum lws_enum_stdinouterr {
3928  LWS_STDIN = 0,
3929  LWS_STDOUT = 1,
3930  LWS_STDERR = 2,
3931 };
3932 
3933 enum lws_cgi_hdr_state {
3934  LCHS_HEADER,
3935  LCHS_CR1,
3936  LCHS_LF1,
3937  LCHS_CR2,
3938  LCHS_LF2,
3939  LHCS_PAYLOAD,
3940  LCHS_SINGLE_0A,
3941 };
3942 
3943 struct lws_cgi_args {
3944  struct lws **stdwsi;
3945  enum lws_enum_stdinouterr ch;
3946  unsigned char *data;
3947  enum lws_cgi_hdr_state hdr_state;
3948  int len;
3949 };
3950 
3951 
3961 LWS_VISIBLE LWS_EXTERN int
3962 lws_cgi(struct lws *wsi, const char * const *exec_array,
3963  int script_uri_path_len, int timeout_secs,
3964  const struct lws_protocol_vhost_options *mp_cgienv);
3965 
3971 LWS_VISIBLE LWS_EXTERN int
3972 lws_cgi_write_split_stdout_headers(struct lws *wsi);
3973 
3979 LWS_VISIBLE LWS_EXTERN int
3980 lws_cgi_kill(struct lws *wsi);
3981 #endif
3982 
3984 
4001 
4007 struct lws_plat_file_ops {
4008  lws_filefd_type (*open)(struct lws *wsi, const char *filename,
4009  unsigned long *filelen, int flags);
4013  int (*close)(struct lws *wsi, lws_filefd_type fd);
4015  unsigned long (*seek_cur)(struct lws *wsi, lws_filefd_type fd,
4016  long offset_from_cur_pos);
4018  int (*read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4019  unsigned char *buf, unsigned long len);
4021  int (*write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4022  unsigned char *buf, unsigned long len);
4025  /* Add new things just above here ---^
4026  * This is part of the ABI, don't needlessly break compatibility */
4027 };
4028 
4034 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4035 lws_get_fops(struct lws_context *context);
4036 
4045 static LWS_INLINE lws_filefd_type LWS_WARN_UNUSED_RESULT
4046 lws_plat_file_open(struct lws *wsi, const char *filename,
4047  unsigned long *filelen, int flags)
4048 {
4049  return lws_get_fops(lws_get_context(wsi))->open(wsi, filename,
4050  filelen, flags);
4051 }
4052 
4059 static LWS_INLINE int
4060 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
4061 {
4062  return lws_get_fops(lws_get_context(wsi))->close(wsi, fd);
4063 }
4064 
4072 static LWS_INLINE unsigned long
4073 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
4074 {
4075  return lws_get_fops(lws_get_context(wsi))->seek_cur(wsi, fd, offset);
4076 }
4086 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4087 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4088  unsigned char *buf, unsigned long len)
4089 {
4090  return lws_get_fops(lws_get_context(wsi))->read(wsi, fd, amount, buf,
4091  len);
4092 }
4102 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4103 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4104  unsigned char *buf, unsigned long len)
4105 {
4106  return lws_get_fops(lws_get_context(wsi))->write(wsi, fd, amount, buf,
4107  len);
4108 }
4110 
4142 #ifdef LWS_WITH_SMTP
4143 
4145 enum lwsgs_smtp_states {
4146  LGSSMTP_IDLE,
4147  LGSSMTP_CONNECTING,
4148  LGSSMTP_CONNECTED,
4149  LGSSMTP_SENT_HELO,
4150  LGSSMTP_SENT_FROM,
4151  LGSSMTP_SENT_TO,
4152  LGSSMTP_SENT_DATA,
4153  LGSSMTP_SENT_BODY,
4154  LGSSMTP_SENT_QUIT,
4155 };
4156 
4158 struct lws_email {
4159  void *data;
4161  uv_loop_t *loop;
4164  char email_smtp_ip[32];
4165  char email_helo[32];
4166  char email_from[100];
4167  char email_to[100];
4169  unsigned int max_content_size;
4172  /* Fill all the callbacks before init */
4173 
4174  int (*on_next)(struct lws_email *email);
4179  int (*on_sent)(struct lws_email *email);
4184  int (*on_get_body)(struct lws_email *email, char *buf, int len);
4190  /* private things */
4191  uv_timer_t timeout_email;
4192  enum lwsgs_smtp_states estate;
4193  uv_connect_t email_connect_req;
4194  uv_tcp_t email_client;
4195  time_t email_connect_started;
4196  char email_buf[256];
4197  char *content;
4198 };
4199 
4209 LWS_VISIBLE LWS_EXTERN int
4210 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4211 
4220 LWS_VISIBLE LWS_EXTERN void
4221 lws_email_check(struct lws_email *email);
4229 LWS_VISIBLE LWS_EXTERN void
4230 lws_email_destroy(struct lws_email *email);
4231 
4232 #endif
4233 
4234 
4235 #ifdef __cplusplus
4236 }
4237 #endif
4238 
4239 #endif
lws_spa_destroy
LWS_VISIBLE LWS_EXTERN int lws_spa_destroy(struct lws_spa *spa)
+Go to the documentation of this file.
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation:
9  * version 2.1 of the License.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19  * MA 02110-1301 USA
20  */
21 
24 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
25 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
26 
27 #ifdef __cplusplus
28 #include <cstddef>
29 #include <cstdarg>
30 #ifdef MBED_OPERATORS
31 #include "mbed-drivers/mbed.h"
32 #include "sal-iface-eth/EthernetInterface.h"
33 #include "sockets/TCPListener.h"
34 #include "sal-stack-lwip/lwipv4_init.h"
35 
36 namespace {
37 }
38 using namespace mbed::Sockets::v0;
39 
40 
41 struct sockaddr_in;
42 struct lws;
43 
44 class lws_conn {
45  public:
46  lws_conn():
47  ts(NULL),
48  wsi(NULL),
49  writeable(1),
50  awaiting_on_writeable(0)
51  {
52  }
53 
54 public:
55  void set_wsi(struct lws *_wsi) { wsi = _wsi; }
56  int actual_onRX(Socket *s);
57  void onRX(Socket *s);
58  void onError(Socket *s, socket_error_t err);
59  void onDisconnect(TCPStream *s);
60  void onSent(Socket *s, uint16_t len);
61  void serialized_writeable(struct lws *wsi);
62 
63 public:
64  TCPStream *ts;
65 
66 public:
67  struct lws *wsi;
68  char writeable;
69  char awaiting_on_writeable;
70 };
71 
72 class lws_conn_listener : lws_conn {
73 public:
74  lws_conn_listener():
75  srv(SOCKET_STACK_LWIP_IPV4)
76  {
77  srv.setOnError(TCPStream::ErrorHandler_t(this,
78  &lws_conn_listener::onError));
79  }
80 
81  void start(const uint16_t port);
83 protected:
84  void onRX(Socket *s);
85  void onError(Socket *s, socket_error_t err);
86  void onIncoming(TCPListener *s, void *impl);
87  void onDisconnect(TCPStream *s);
89 public:
90  TCPListener srv;
91 };
92 
93 #endif
94 
95 extern "C" {
96 #else
97 #include <stdarg.h>
98 #endif
99 
100 #if defined(MBED_OPERATORS) || defined(LWS_WITH_ESP8266)
101 struct sockaddr_in;
102 #define LWS_POSIX 0
103 #else
104 #define LWS_POSIX 1
105 #endif
106 
107 #include "lws_config.h"
108 
109 #if defined(WIN32) || defined(_WIN32)
110 #ifndef WIN32_LEAN_AND_MEAN
111 #define WIN32_LEAN_AND_MEAN
112 #endif
113 
114 #include <winsock2.h>
115 #include <ws2tcpip.h>
116 #include <stddef.h>
117 #include <basetsd.h>
118 #ifndef _WIN32_WCE
119 #include <fcntl.h>
120 #else
121 #define _O_RDONLY 0x0000
122 #define O_RDONLY _O_RDONLY
123 #endif
124 
125 // Visual studio older than 2015 and WIN_CE has only _stricmp
126 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
127 #define strcasecmp _stricmp
128 #elif !defined(__MINGW32__)
129 #define strcasecmp stricmp
130 #endif
131 #define getdtablesize() 30000
132 
133 #define LWS_INLINE __inline
134 #define LWS_VISIBLE
135 #define LWS_WARN_UNUSED_RESULT
136 #define LWS_WARN_DEPRECATED
137 
138 #ifdef LWS_DLL
139 #ifdef LWS_INTERNAL
140 #define LWS_EXTERN extern __declspec(dllexport)
141 #else
142 #define LWS_EXTERN extern __declspec(dllimport)
143 #endif
144 #else
145 #define LWS_EXTERN
146 #endif
147 
148 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
149 #define LWS_O_RDONLY _O_RDONLY
150 
151 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
152 #define lws_snprintf _snprintf
153 #endif
154 
155 #ifndef __func__
156 #define __func__ __FUNCTION__
157 #endif
158 
159 #else /* NOT WIN32 */
160 #include <unistd.h>
161 
162 #if defined(__NetBSD__) || defined(__FreeBSD__)
163 #include <netinet/in.h>
164 #endif
165 
166 #define LWS_INLINE inline
167 #define LWS_O_RDONLY O_RDONLY
168 
169 #if !defined(MBED_OPERATORS) && !defined(LWS_WITH_ESP8266)
170 #include <poll.h>
171 #include <netdb.h>
172 #define LWS_INVALID_FILE -1
173 #else
174 #define getdtablesize() (20)
175 #define LWS_INVALID_FILE NULL
176 #endif
177 
178 #if defined(__GNUC__)
179 
180 /* warn_unused_result attribute only supported by GCC 3.4 or later */
181 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
182 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
183 #else
184 #define LWS_WARN_UNUSED_RESULT
185 #endif
186 
187 #define LWS_VISIBLE __attribute__((visibility("default")))
188 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
189 #else
190 #define LWS_VISIBLE
191 #define LWS_WARN_UNUSED_RESULT
192 #define LWS_WARN_DEPRECATED
193 #endif
194 
195 #if defined(__ANDROID__)
196 #include <unistd.h>
197 #define getdtablesize() sysconf(_SC_OPEN_MAX)
198 #endif
199 
200 #endif
201 
202 #ifdef LWS_USE_LIBEV
203 #include <ev.h>
204 #endif /* LWS_USE_LIBEV */
205 #ifdef LWS_USE_LIBUV
206 #include <uv.h>
207 #ifdef LWS_HAVE_UV_VERSION_H
208 #include <uv-version.h>
209 #endif
210 #endif /* LWS_USE_LIBUV */
211 
212 #ifndef LWS_EXTERN
213 #define LWS_EXTERN extern
214 #endif
215 
216 #ifdef _WIN32
217 #define random rand
218 #else
219 #include <sys/time.h>
220 #include <unistd.h>
221 #endif
222 
223 #ifdef LWS_OPENSSL_SUPPORT
224 
225 #ifdef USE_WOLFSSL
226 #ifdef USE_OLD_CYASSL
227 #include <cyassl/openssl/ssl.h>
228 #include <cyassl/error-ssl.h>
229 #else
230 #include <wolfssl/openssl/ssl.h>
231 #include <wolfssl/error-ssl.h>
232 #endif /* not USE_OLD_CYASSL */
233 #else
234 #if defined(LWS_USE_POLARSSL)
235 #include <polarssl/ssl.h>
236 struct lws_polarssl_context {
237  x509_crt ca;
238  x509_crt certificate;
239  rsa_context key;
240 };
241 typedef struct lws_polarssl_context SSL_CTX;
242 typedef ssl_context SSL;
243 #else
244 #if defined(LWS_USE_MBEDTLS)
245 #include <mbedtls/ssl.h>
246 #else
247 #include <openssl/ssl.h>
248 #include <openssl/err.h>
249 #endif /* not USE_MBEDTLS */
250 #endif /* not USE_POLARSSL */
251 #endif /* not USE_WOLFSSL */
252 #endif
253 
254 
255 #define CONTEXT_PORT_NO_LISTEN -1
256 
267 
269 enum lws_log_levels {
270  LLL_ERR = 1 << 0,
271  LLL_WARN = 1 << 1,
272  LLL_NOTICE = 1 << 2,
273  LLL_INFO = 1 << 3,
274  LLL_DEBUG = 1 << 4,
275  LLL_PARSER = 1 << 5,
276  LLL_HEADER = 1 << 6,
277  LLL_EXT = 1 << 7,
278  LLL_CLIENT = 1 << 8,
279  LLL_LATENCY = 1 << 9,
280 
281  LLL_COUNT = 10 /* set to count of valid flags */
282 };
283 
284 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...);
285 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
295 LWS_VISIBLE LWS_EXTERN int
296 lwsl_timestamp(int level, char *p, int len);
297 
298 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
299 
300 #if !defined(LWS_WITH_NO_LOGS)
301 /* notice, warn and log are always compiled in */
302 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
303 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
304 #endif
305 /*
306  * weaker logging can be deselected at configure time using --disable-debug
307  * that gets rid of the overhead of checking while keeping _warn and _err
308  * active
309  */
310 
311 #if defined(LWS_WITH_ESP8266)
312 #undef _DEBUG
313 #endif
314 
315 #ifdef _DEBUG
316 #if defined(LWS_WITH_NO_LOGS)
317 /* notice, warn and log are always compiled in */
318 //#define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
319 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
320 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
321 #endif
322 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
323 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
324 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
325 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
326 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
327 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
328 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
329 
335 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
336 
337 #else /* no debug */
338 #if defined(LWS_WITH_NO_LOGS)
339 //#define lwsl_err(...) do {} while(0)
340 #define lwsl_warn(...) do {} while(0)
341 #define lwsl_notice(...) do {} while(0)
342 #endif
343 #define lwsl_info(...) do {} while(0)
344 #define lwsl_debug(...) do {} while(0)
345 #define lwsl_parser(...) do {} while(0)
346 #define lwsl_header(...) do {} while(0)
347 #define lwsl_ext(...) do {} while(0)
348 #define lwsl_client(...) do {} while(0)
349 #define lwsl_latency(...) do {} while(0)
350 #define lwsl_hexdump(a, b)
351 
352 #endif
353 
364 LWS_VISIBLE LWS_EXTERN void
365 lws_set_log_level(int level,
366  void (*log_emit_function)(int level, const char *line));
367 
377 LWS_VISIBLE LWS_EXTERN void
378 lwsl_emit_syslog(int level, const char *line);
379 
381 
382 
383 #include <stddef.h>
384 
385 #ifndef lws_container_of
386 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
387 #endif
388 
389 
390 struct lws;
391 #ifndef ARRAY_SIZE
392 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
393 #endif
394 
395 /* api change list for user code to test against */
396 
397 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
398 
399 /* the struct lws_protocols has the id field present */
400 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
401 
402 /* you can call lws_get_peer_write_allowance */
403 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
404 
405 /* extra parameter introduced in 917f43ab821 */
406 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
407 
408 /* File operations stuff exists */
409 #define LWS_FEATURE_FOPS
410 
411 
412 #if defined(_WIN32)
413 typedef SOCKET lws_sockfd_type;
414 typedef HANDLE lws_filefd_type;
415 #define lws_sockfd_valid(sfd) (!!sfd)
416 struct lws_pollfd {
417  lws_sockfd_type fd;
418  SHORT events;
419  SHORT revents;
420 };
421 #define LWS_POLLHUP (FD_CLOSE)
422 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
423 #define LWS_POLLOUT (FD_WRITE)
424 #else
425 
426 #if defined(MBED_OPERATORS)
427 /* it's a class lws_conn * */
428 typedef void * lws_sockfd_type;
429 typedef void * lws_filefd_type;
430 #define lws_sockfd_valid(sfd) (!!sfd)
431 struct pollfd {
432  lws_sockfd_type fd;
433  short events;
434  short revents;
435 };
436 #define POLLIN 0x0001
437 #define POLLPRI 0x0002
438 #define POLLOUT 0x0004
439 #define POLLERR 0x0008
440 #define POLLHUP 0x0010
441 #define POLLNVAL 0x0020
442 
443 struct lws;
444 
445 void * mbed3_create_tcp_stream_socket(void);
446 void mbed3_delete_tcp_stream_socket(void *sockfd);
447 void mbed3_tcp_stream_bind(void *sock, int port, struct lws *);
448 void mbed3_tcp_stream_accept(void *sock, struct lws *);
449 #else
450 #if defined(LWS_WITH_ESP8266)
451 
452 #include <user_interface.h>
453 #include <espconn.h>
454 
455 typedef struct espconn * lws_sockfd_type;
456 typedef void * lws_filefd_type;
457 #define lws_sockfd_valid(sfd) (!!sfd)
458 struct pollfd {
459  lws_sockfd_type fd;
460  short events;
461  short revents;
462 };
463 #define POLLIN 0x0001
464 #define POLLPRI 0x0002
465 #define POLLOUT 0x0004
466 #define POLLERR 0x0008
467 #define POLLHUP 0x0010
468 #define POLLNVAL 0x0020
469 
470 struct lws_vhost;
471 
472 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
473 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
474 
475 #include <os_type.h>
476 #include <osapi.h>
477 #include "ets_sys.h"
478 
479 int ets_snprintf(char *str, size_t size, const char *format, ...);
480 #define snprintf ets_snprintf
481 
482 typedef os_timer_t uv_timer_t;
483 typedef void uv_cb_t(uv_timer_t *);
484 
485 void os_timer_disarm(void *);
486 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
487 
488 void ets_timer_arm_new(os_timer_t *, int, int, int);
489 
490 //void os_timer_arm(os_timer_t *, int, int);
491 
492 #define UV_VERSION_MAJOR 1
493 
494 #define lws_uv_getloop(a, b) (NULL)
495 
496 static inline void uv_timer_init(void *l, uv_timer_t *t)
497 {
498  (void)l;
499  memset(t, 0, sizeof(*t));
500  os_timer_disarm(t);
501 }
502 
503 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
504 {
505  os_timer_setfn(t, (os_timer_func_t *)cb, t);
506  /* ms, repeat */
507  os_timer_arm(t, first, !!rep);
508 }
509 
510 static inline void uv_timer_stop(uv_timer_t *t)
511 {
512  os_timer_disarm(t);
513 }
514 
515 #else
516 typedef int lws_sockfd_type;
517 typedef int lws_filefd_type;
518 #define lws_sockfd_valid(sfd) (sfd >= 0)
519 #endif
520 #endif
521 
522 #define lws_pollfd pollfd
523 #define LWS_POLLHUP (POLLHUP|POLLERR)
524 #define LWS_POLLIN (POLLIN)
525 #define LWS_POLLOUT (POLLOUT)
526 #endif
527 
530 struct lws_pollargs {
531  lws_sockfd_type fd;
532  int events;
533  int prev_events;
534 };
535 
536 struct lws_tokens;
537 struct lws_token_limits;
538 
546 
548 /*
549  * NOTE: These public enums are part of the abi. If you want to add one,
550  * add it at where specified so existing users are unaffected.
551  */
553 enum lws_close_status {
554  LWS_CLOSE_STATUS_NOSTATUS = 0,
555  LWS_CLOSE_STATUS_NORMAL = 1000,
558  LWS_CLOSE_STATUS_GOINGAWAY = 1001,
561  LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
564  LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
569  LWS_CLOSE_STATUS_RESERVED = 1004,
571  LWS_CLOSE_STATUS_NO_STATUS = 1005,
576  LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
582  LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
587  LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
593  LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
597  LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
605  LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
609  LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
616  /****** add new things just above ---^ ******/
617 
618  LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
619 };
620 
633 LWS_VISIBLE LWS_EXTERN void
634 lws_close_reason(struct lws *wsi, enum lws_close_status status,
635  unsigned char *buf, size_t len);
636 
638 
639 struct lws;
640 struct lws_context;
641 /* needed even with extensions disabled for create context */
642 struct lws_extension;
643 
655 
657 
658 /*
659  * NOTE: These public enums are part of the abi. If you want to add one,
660  * add it at where specified so existing users are unaffected.
661  */
663 enum lws_callback_reasons {
664  LWS_CALLBACK_ESTABLISHED = 0,
668  LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
712  LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
719  LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
722  LWS_CALLBACK_CLOSED = 4,
724  LWS_CALLBACK_CLOSED_HTTP = 5,
726  LWS_CALLBACK_RECEIVE = 6,
730  LWS_CALLBACK_RECEIVE_PONG = 7,
732  LWS_CALLBACK_CLIENT_RECEIVE = 8,
735  LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
737  LWS_CALLBACK_CLIENT_WRITEABLE = 10,
745  LWS_CALLBACK_SERVER_WRITEABLE = 11,
747  LWS_CALLBACK_HTTP = 12,
761  LWS_CALLBACK_HTTP_BODY = 13,
764  LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
766  LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
768  LWS_CALLBACK_HTTP_WRITEABLE = 16,
770  LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
781  LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
793  LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
801  LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
813  LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
820  LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
826  LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
844  LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
868  LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
879  LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
888  LWS_CALLBACK_PROTOCOL_INIT = 27,
891  LWS_CALLBACK_PROTOCOL_DESTROY = 28,
896  LWS_CALLBACK_WSI_CREATE = 29,
898  LWS_CALLBACK_WSI_DESTROY = 30,
900  LWS_CALLBACK_GET_THREAD_ID = 31,
905  /* external poll() management support */
906  LWS_CALLBACK_ADD_POLL_FD = 32,
922  LWS_CALLBACK_DEL_POLL_FD = 33,
928  LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
936  LWS_CALLBACK_LOCK_POLL = 35,
948  LWS_CALLBACK_UNLOCK_POLL = 36,
951  LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
959  LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
968  LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
971  LWS_CALLBACK_CGI = 40,
973  LWS_CALLBACK_CGI_TERMINATED = 41,
975  LWS_CALLBACK_CGI_STDIN_DATA = 42,
977  LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
979  LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
981  LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
983  LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
985  LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
987  LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
989  LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
991  LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
993  LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
995  LWS_CALLBACK_PROCESS_HTML = 52,
997  LWS_CALLBACK_ADD_HEADERS = 53,
999  LWS_CALLBACK_SESSION_INFO = 54,
1002  LWS_CALLBACK_GS_EVENT = 55,
1004  LWS_CALLBACK_HTTP_PMO = 56,
1009  LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1019  /****** add new things just above ---^ ******/
1020 
1021  LWS_CALLBACK_USER = 1000,
1023 };
1024 
1025 
1026 
1042 typedef int
1043 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1044  void *user, void *in, size_t len);
1046 
1056 
1058 /*
1059  * NOTE: These public enums are part of the abi. If you want to add one,
1060  * add it at where specified so existing users are unaffected.
1061  */
1062 enum lws_extension_callback_reasons {
1063  LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1064  LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1065  LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1066  LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1067  LWS_EXT_CB_CONSTRUCT = 4,
1068  LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1069  LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1070  LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1071  LWS_EXT_CB_DESTROY = 8,
1072  LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1073  LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1074  LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1075  LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1076  LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1077  LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1078  LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1079  LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1080  LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1081  LWS_EXT_CB_1HZ = 18,
1082  LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1083  LWS_EXT_CB_IS_WRITEABLE = 20,
1084  LWS_EXT_CB_PAYLOAD_TX = 21,
1085  LWS_EXT_CB_PAYLOAD_RX = 22,
1086  LWS_EXT_CB_OPTION_DEFAULT = 23,
1087  LWS_EXT_CB_OPTION_SET = 24,
1088  LWS_EXT_CB_OPTION_CONFIRM = 25,
1089  LWS_EXT_CB_NAMED_OPTION_SET = 26,
1090 
1091  /****** add new things just above ---^ ******/
1092 };
1093 
1095 enum lws_ext_options_types {
1096  EXTARG_NONE,
1097  EXTARG_DEC,
1098  EXTARG_OPT_DEC
1100  /* Add new things just above here ---^
1101  * This is part of the ABI, don't needlessly break compatibility */
1102 };
1103 
1108 struct lws_ext_options {
1109  const char *name;
1110  enum lws_ext_options_types type;
1112  /* Add new things just above here ---^
1113  * This is part of the ABI, don't needlessly break compatibility */
1114 };
1115 
1117 struct lws_ext_option_arg {
1118  const char *option_name;
1119  int option_index;
1120  const char *start;
1121  int len;
1122 };
1123 
1184 typedef int
1185 lws_extension_callback_function(struct lws_context *context,
1186  const struct lws_extension *ext, struct lws *wsi,
1187  enum lws_extension_callback_reasons reason,
1188  void *user, void *in, size_t len);
1189 
1191 struct lws_extension {
1192  const char *name;
1193  lws_extension_callback_function *callback;
1194  const char *client_offer;
1196  /* Add new things just above here ---^
1197  * This is part of the ABI, don't needlessly break compatibility */
1198 };
1199 
1208 LWS_VISIBLE LWS_EXTERN int
1209 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1210  const char *opt_name, const char *opt_val);
1211 
1212 #ifndef LWS_NO_EXTENSIONS
1213 /* lws_get_internal_extensions() - DEPRECATED
1214  *
1215  * \Deprecated There is no longer a set internal extensions table. The table is provided
1216  * by user code along with application-specific settings. See the test
1217  * client and server for how to do.
1218  */
1219 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1220 lws_get_internal_extensions(void) { return NULL; }
1221 
1232 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1233 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1234  void *ext_user, const struct lws_ext_options *opts,
1235  const char *o, int len);
1236 #endif
1237 
1250 LWS_EXTERN
1251 int lws_extension_callback_pm_deflate(
1252  struct lws_context *context, const struct lws_extension *ext,
1253  struct lws *wsi, enum lws_extension_callback_reasons reason,
1254  void *user, void *in, size_t len);
1255 
1256 /*
1257  * The internal exts are part of the public abi
1258  * If we add more extensions, publish the callback here ------v
1259  */
1261 
1277 
1281 struct lws_protocols {
1282  const char *name;
1285  lws_callback_function *callback;
1289  size_t per_session_data_size;
1294  size_t rx_buffer_size;
1303  unsigned int id;
1310  void *user;
1313  /* Add new things just above here ---^
1314  * This is part of the ABI, don't needlessly break compatibility */
1315 };
1316 
1317 struct lws_vhost;
1318 
1327 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1328 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1329 
1339 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1340 lws_get_protocol(struct lws *wsi);
1341 
1343 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1344 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1345 
1356 LWS_VISIBLE LWS_EXTERN void *
1357 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1358  int size);
1359 
1369 LWS_VISIBLE LWS_EXTERN void *
1370 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1371 
1380 LWS_VISIBLE LWS_EXTERN int
1381 lws_finalize_startup(struct lws_context *context);
1382 
1383 #ifdef LWS_WITH_PLUGINS
1384 
1385 /* PLUGINS implies LIBUV */
1386 
1387 #define LWS_PLUGIN_API_MAGIC 180
1388 
1390 struct lws_plugin_capability {
1391  unsigned int api_magic;
1392  const struct lws_protocols *protocols;
1393  int count_protocols;
1394  const struct lws_extension *extensions;
1395  int count_extensions;
1396 };
1397 
1398 typedef int (*lws_plugin_init_func)(struct lws_context *,
1399  struct lws_plugin_capability *);
1400 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1401 
1403 struct lws_plugin {
1404  struct lws_plugin *list;
1405 #if (UV_VERSION_MAJOR > 0)
1406  uv_lib_t lib;
1407 #else
1408  void *l;
1409 #endif
1410  char name[64];
1411  struct lws_plugin_capability caps;
1412 };
1413 
1414 #endif
1415 
1417 
1418 
1427 
1429 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1430 
1432 /* SHA-1 binary and hexified versions */
1434 typedef struct { unsigned char bin[20]; } lwsgw_hash_bin;
1436 typedef struct { char id[41]; } lwsgw_hash;
1437 
1439 enum lwsgs_auth_bits {
1440  LWSGS_AUTH_LOGGED_IN = 1,
1441  LWSGS_AUTH_ADMIN = 2,
1442  LWSGS_AUTH_VERIFIED = 4,
1443  LWSGS_AUTH_FORGOT_FLOW = 8,
1444 };
1445 
1447 struct lws_session_info {
1448  char username[32];
1449  char email[100];
1450  char ip[72];
1451  unsigned int mask;
1453  char session[42];
1454 };
1455 
1457 enum lws_gs_event {
1458  LWSGSE_CREATED,
1459  LWSGSE_DELETED
1460 };
1461 
1463 struct lws_gs_event_args {
1464  enum lws_gs_event event;
1465  const char *username;
1466  const char *email;
1467 };
1468 
1470 
1471 
1485 
1487 /*
1488  * NOTE: These public enums are part of the abi. If you want to add one,
1489  * add it at where specified so existing users are unaffected.
1490  */
1491 
1493 enum lws_context_options {
1494  LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1495  (1 << 12),
1499  LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1501  LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1502  (1 << 12),
1506  LWS_SERVER_OPTION_LIBEV = (1 << 4),
1508  LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1510  LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1513  LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1515  LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1517  LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1518  (1 << 12),
1520  LWS_SERVER_OPTION_LIBUV = (1 << 10),
1522  LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1523  (1 << 12),
1526  LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1528  LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1531  LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1533  LWS_SERVER_OPTION_STS = (1 << 15),
1536  LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1538  LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1540  LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1547  /****** add new things just above ---^ ******/
1548 };
1549 
1550 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1551 
1561 struct lws_context_creation_info {
1562  int port;
1567  const char *iface;
1574  const struct lws_protocols *protocols;
1578  const struct lws_extension *extensions;
1581  const struct lws_token_limits *token_limits;
1584  const char *ssl_private_key_password;
1586  const char *ssl_cert_filepath;
1590  const char *ssl_private_key_filepath;
1596  const char *ssl_ca_filepath;
1598  const char *ssl_cipher_list;
1602  const char *http_proxy_address;
1605  unsigned int http_proxy_port;
1607  int gid;
1609  int uid;
1611  unsigned int options;
1613  void *user;
1616  int ka_time;
1619  int ka_probes;
1623  int ka_interval;
1626 #ifdef LWS_OPENSSL_SUPPORT
1627  SSL_CTX *provided_client_ssl_ctx;
1632 #else /* maintain structure layout either way */
1633  void *provided_client_ssl_ctx;
1634 #endif
1635 
1636  short max_http_header_data;
1639  short max_http_header_pool;
1646  unsigned int count_threads;
1648  unsigned int fd_limit_per_thread;
1652  unsigned int timeout_secs;
1657  const char *ecdh_curve;
1659  const char *vhost_name;
1663  const char * const *plugin_dirs;
1666  const struct lws_protocol_vhost_options *pvo;
1669  int keepalive_timeout;
1672  const char *log_filepath;
1675  const struct lws_http_mount *mounts;
1677  const char *server_string;
1680  unsigned int pt_serv_buf_size;
1686  unsigned int max_http_header_data2;
1691  long ssl_options_set;
1693  long ssl_options_clear;
1695  unsigned short ws_ping_pong_interval;
1707  const struct lws_protocol_vhost_options *headers;
1711  const struct lws_protocol_vhost_options *reject_service_keywords;
1718  void *external_baggage_free_on_destroy;
1726  /* Add new things just above here ---^
1727  * This is part of the ABI, don't needlessly break compatibility
1728  *
1729  * The below is to ensure later library versions with new
1730  * members added above will see 0 (default) even if the app
1731  * was not built against the newer headers.
1732  */
1733 
1734  void *_unused[8];
1735 };
1736 
1771 LWS_VISIBLE LWS_EXTERN struct lws_context *
1772 lws_create_context(struct lws_context_creation_info *info);
1773 
1782 LWS_VISIBLE LWS_EXTERN void
1783 lws_context_destroy(struct lws_context *context);
1784 
1802 LWS_VISIBLE LWS_EXTERN int
1803 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
1804 
1805 
1806 struct lws_vhost;
1807 
1817 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
1818 lws_create_vhost(struct lws_context *context,
1819  struct lws_context_creation_info *info);
1820 
1835 LWS_VISIBLE LWS_EXTERN int
1836 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
1837  char **config_strings, int *len);
1838 
1854 LWS_VISIBLE LWS_EXTERN int
1855 lwsws_get_config_vhosts(struct lws_context *context,
1856  struct lws_context_creation_info *info, const char *d,
1857  char **config_strings, int *len);
1858 
1860 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1861 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1862 
1868 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1869 lws_get_vhost(struct lws *wsi);
1870 
1878 LWS_VISIBLE LWS_EXTERN int
1879 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
1880 
1888 LWS_VISIBLE LWS_EXTERN int
1889 lws_json_dump_context(const struct lws_context *context, char *buf, int len);
1890 
1900 LWS_VISIBLE LWS_EXTERN void *
1901 lws_context_user(struct lws_context *context);
1902 
1908 
1915 struct lws_protocol_vhost_options {
1916  const struct lws_protocol_vhost_options *next;
1917  const struct lws_protocol_vhost_options *options;
1918  const char *name;
1919  const char *value;
1920 };
1921 
1926 enum lws_mount_protocols {
1927  LWSMPRO_HTTP = 0,
1928  LWSMPRO_HTTPS = 1,
1929  LWSMPRO_FILE = 2,
1930  LWSMPRO_CGI = 3,
1931  LWSMPRO_REDIR_HTTP = 4,
1932  LWSMPRO_REDIR_HTTPS = 5,
1933  LWSMPRO_CALLBACK = 6,
1934 };
1935 
1940 struct lws_http_mount {
1941  const struct lws_http_mount *mount_next;
1943  const char *mountpoint;
1945  const char *origin;
1947  const char *def;
1949  const char *protocol;
1952  const struct lws_protocol_vhost_options *cgienv;
1956  const struct lws_protocol_vhost_options *extra_mimetypes;
1958  const struct lws_protocol_vhost_options *interpret;
1961  int cgi_timeout;
1963  int cache_max_age;
1965  unsigned int auth_mask;
1968  unsigned int cache_reusable:1;
1969  unsigned int cache_revalidate:1;
1970  unsigned int cache_intermediaries:1;
1972  unsigned char origin_protocol;
1973  unsigned char mountpoint_len;
1975  const char *basic_auth_login_file;
1978  /* Add new things just above here ---^
1979  * This is part of the ABI, don't needlessly break compatibility
1980  *
1981  * The below is to ensure later library versions with new
1982  * members added above will see 0 (default) even if the app
1983  * was not built against the newer headers.
1984  */
1985 
1986  void *_unused[2];
1987 };
1990 
1996 
2003 enum lws_client_connect_ssl_connection_flags {
2004  LCCSCF_USE_SSL = (1 << 0),
2005  LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2006  LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2007  LCCSCF_ALLOW_EXPIRED = (1 << 3)
2008 };
2009 
2013 struct lws_client_connect_info {
2014  struct lws_context *context;
2016  const char *address;
2018  int port;
2020  int ssl_connection;
2022  const char *path;
2024  const char *host;
2026  const char *origin;
2028  const char *protocol;
2030  int ietf_version_or_minus_one;
2032  void *userdata;
2034  const struct lws_extension *client_exts;
2036  const char *method;
2039  struct lws *parent_wsi;
2043  const char *uri_replace_from;
2046  const char *uri_replace_to;
2048  struct lws_vhost *vhost;
2050  struct lws **pwsi;
2062  /* Add new things just above here ---^
2063  * This is part of the ABI, don't needlessly break compatibility
2064  *
2065  * The below is to ensure later library versions with new
2066  * members added above will see 0 (default) even if the app
2067  * was not built against the newer headers.
2068  */
2069 
2070  void *_unused[4];
2071 };
2072 
2080 LWS_VISIBLE LWS_EXTERN struct lws *
2081 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2082 
2103 /* deprecated, use lws_client_connect_via_info() */
2104 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2105 lws_client_connect(struct lws_context *clients, const char *address,
2106  int port, int ssl_connection, const char *path,
2107  const char *host, const char *origin, const char *protocol,
2108  int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2109 /* deprecated, use lws_client_connect_via_info() */
2130 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2131 lws_client_connect_extended(struct lws_context *clients, const char *address,
2132  int port, int ssl_connection, const char *path,
2133  const char *host, const char *origin,
2134  const char *protocol, int ietf_version_or_minus_one,
2135  void *userdata) LWS_WARN_DEPRECATED;
2136 
2162 LWS_VISIBLE LWS_EXTERN int
2163 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2164  struct lws_vhost *vhost);
2165 
2166 LWS_VISIBLE LWS_EXTERN int
2167 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2168 
2176 LWS_VISIBLE LWS_EXTERN unsigned int
2177 lws_http_client_http_response(struct lws *wsi);
2178 
2179 LWS_VISIBLE LWS_EXTERN void
2180 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2181 
2202 
2211 
2244 LWS_VISIBLE LWS_EXTERN int
2245 lws_service(struct lws_context *context, int timeout_ms);
2246 
2258 LWS_VISIBLE LWS_EXTERN int
2259 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2260 
2276 LWS_VISIBLE LWS_EXTERN void
2277 lws_cancel_service_pt(struct lws *wsi);
2278 
2290 LWS_VISIBLE LWS_EXTERN void
2291 lws_cancel_service(struct lws_context *context);
2292 
2319 LWS_VISIBLE LWS_EXTERN int
2320 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2321 
2331 LWS_VISIBLE LWS_EXTERN int
2332 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2333  int tsi);
2334 
2352 LWS_VISIBLE LWS_EXTERN int
2353 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2354 
2355 /* Backwards compatibility */
2356 #define lws_plat_service_tsi lws_service_tsi
2357 
2359 
2365 
2372 
2384 LWS_VISIBLE LWS_EXTERN const char *
2385 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2386 
2405 LWS_VISIBLE LWS_EXTERN int
2406 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2407  const char *other_headers, int other_headers_len);
2408 LWS_VISIBLE LWS_EXTERN int
2409 lws_serve_http_file_fragment(struct lws *wsi);
2411 
2422 
2423 enum http_status {
2424  HTTP_STATUS_OK = 200,
2425  HTTP_STATUS_NO_CONTENT = 204,
2426  HTTP_STATUS_PARTIAL_CONTENT = 206,
2427 
2428  HTTP_STATUS_MOVED_PERMANENTLY = 301,
2429  HTTP_STATUS_FOUND = 302,
2430  HTTP_STATUS_SEE_OTHER = 303,
2431 
2432  HTTP_STATUS_BAD_REQUEST = 400,
2433  HTTP_STATUS_UNAUTHORIZED,
2434  HTTP_STATUS_PAYMENT_REQUIRED,
2435  HTTP_STATUS_FORBIDDEN,
2436  HTTP_STATUS_NOT_FOUND,
2437  HTTP_STATUS_METHOD_NOT_ALLOWED,
2438  HTTP_STATUS_NOT_ACCEPTABLE,
2439  HTTP_STATUS_PROXY_AUTH_REQUIRED,
2440  HTTP_STATUS_REQUEST_TIMEOUT,
2441  HTTP_STATUS_CONFLICT,
2442  HTTP_STATUS_GONE,
2443  HTTP_STATUS_LENGTH_REQUIRED,
2444  HTTP_STATUS_PRECONDITION_FAILED,
2445  HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2446  HTTP_STATUS_REQ_URI_TOO_LONG,
2447  HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2448  HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2449  HTTP_STATUS_EXPECTATION_FAILED,
2450 
2451  HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2452  HTTP_STATUS_NOT_IMPLEMENTED,
2453  HTTP_STATUS_BAD_GATEWAY,
2454  HTTP_STATUS_SERVICE_UNAVAILABLE,
2455  HTTP_STATUS_GATEWAY_TIMEOUT,
2456  HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2457 };
2458 
2459 struct lws_process_html_args {
2460  char *p;
2461  int len;
2462  int max_len;
2463  int final;
2464 };
2465 
2466 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2467 
2468 struct lws_process_html_state {
2469  char *start;
2470  char swallow[16];
2471  int pos;
2472  void *data;
2473  const char * const *vars;
2474  int count_vars;
2476  lws_process_html_state_cb replace;
2477 };
2478 
2483 LWS_VISIBLE LWS_EXTERN int
2484 lws_chunked_html_process(struct lws_process_html_args *args,
2485  struct lws_process_html_state *s);
2487 
2520 
2528 struct lws_tokens {
2529  char *token;
2530  int token_len;
2531 };
2532 
2533 /* enum lws_token_indexes
2534  * these have to be kept in sync with lextable.h / minilex.c
2535  *
2536  * NOTE: These public enums are part of the abi. If you want to add one,
2537  * add it at where specified so existing users are unaffected.
2538  */
2539 enum lws_token_indexes {
2540  WSI_TOKEN_GET_URI = 0,
2541  WSI_TOKEN_POST_URI = 1,
2542  WSI_TOKEN_OPTIONS_URI = 2,
2543  WSI_TOKEN_HOST = 3,
2544  WSI_TOKEN_CONNECTION = 4,
2545  WSI_TOKEN_UPGRADE = 5,
2546  WSI_TOKEN_ORIGIN = 6,
2547  WSI_TOKEN_DRAFT = 7,
2548  WSI_TOKEN_CHALLENGE = 8,
2549  WSI_TOKEN_EXTENSIONS = 9,
2550  WSI_TOKEN_KEY1 = 10,
2551  WSI_TOKEN_KEY2 = 11,
2552  WSI_TOKEN_PROTOCOL = 12,
2553  WSI_TOKEN_ACCEPT = 13,
2554  WSI_TOKEN_NONCE = 14,
2555  WSI_TOKEN_HTTP = 15,
2556  WSI_TOKEN_HTTP2_SETTINGS = 16,
2557  WSI_TOKEN_HTTP_ACCEPT = 17,
2558  WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2559  WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2560  WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2561  WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2562  WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2563  WSI_TOKEN_HTTP_PRAGMA = 23,
2564  WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2565  WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2566  WSI_TOKEN_HTTP_COOKIE = 26,
2567  WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2568  WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2569  WSI_TOKEN_HTTP_DATE = 29,
2570  WSI_TOKEN_HTTP_RANGE = 30,
2571  WSI_TOKEN_HTTP_REFERER = 31,
2572  WSI_TOKEN_KEY = 32,
2573  WSI_TOKEN_VERSION = 33,
2574  WSI_TOKEN_SWORIGIN = 34,
2575 
2576  WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2577  WSI_TOKEN_HTTP_COLON_METHOD = 36,
2578  WSI_TOKEN_HTTP_COLON_PATH = 37,
2579  WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2580  WSI_TOKEN_HTTP_COLON_STATUS = 39,
2581 
2582  WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2583  WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2584  WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2585  WSI_TOKEN_HTTP_AGE = 43,
2586  WSI_TOKEN_HTTP_ALLOW = 44,
2587  WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2588  WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2589  WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2590  WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2591  WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2592  WSI_TOKEN_HTTP_ETAG = 50,
2593  WSI_TOKEN_HTTP_EXPECT = 51,
2594  WSI_TOKEN_HTTP_EXPIRES = 52,
2595  WSI_TOKEN_HTTP_FROM = 53,
2596  WSI_TOKEN_HTTP_IF_MATCH = 54,
2597  WSI_TOKEN_HTTP_IF_RANGE = 55,
2598  WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2599  WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2600  WSI_TOKEN_HTTP_LINK = 58,
2601  WSI_TOKEN_HTTP_LOCATION = 59,
2602  WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2603  WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2604  WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2605  WSI_TOKEN_HTTP_REFRESH = 63,
2606  WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2607  WSI_TOKEN_HTTP_SERVER = 65,
2608  WSI_TOKEN_HTTP_SET_COOKIE = 66,
2609  WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2610  WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
2611  WSI_TOKEN_HTTP_USER_AGENT = 69,
2612  WSI_TOKEN_HTTP_VARY = 70,
2613  WSI_TOKEN_HTTP_VIA = 71,
2614  WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
2615 
2616  WSI_TOKEN_PATCH_URI = 73,
2617  WSI_TOKEN_PUT_URI = 74,
2618  WSI_TOKEN_DELETE_URI = 75,
2619 
2620  WSI_TOKEN_HTTP_URI_ARGS = 76,
2621  WSI_TOKEN_PROXY = 77,
2622  WSI_TOKEN_HTTP_X_REAL_IP = 78,
2623  WSI_TOKEN_HTTP1_0 = 79,
2624  WSI_TOKEN_X_FORWARDED_FOR = 80,
2625 
2626  /****** add new things just above ---^ ******/
2627 
2628  /* use token storage to stash these internally, not for
2629  * user use */
2630 
2631  _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
2632  _WSI_TOKEN_CLIENT_PEER_ADDRESS,
2633  _WSI_TOKEN_CLIENT_URI,
2634  _WSI_TOKEN_CLIENT_HOST,
2635  _WSI_TOKEN_CLIENT_ORIGIN,
2636  _WSI_TOKEN_CLIENT_METHOD,
2637 
2638  /* always last real token index*/
2639  WSI_TOKEN_COUNT,
2640 
2641  /* parser state additions, no storage associated */
2642  WSI_TOKEN_NAME_PART,
2643  WSI_TOKEN_SKIPPING,
2644  WSI_TOKEN_SKIPPING_SAW_CR,
2645  WSI_PARSING_COMPLETE,
2646  WSI_INIT_TOKEN_MUXURL,
2647 };
2648 
2649 struct lws_token_limits {
2650  unsigned short token_limit[WSI_TOKEN_COUNT];
2651 };
2652 
2658 LWS_VISIBLE LWS_EXTERN const unsigned char *
2659 lws_token_to_string(enum lws_token_indexes token);
2660 
2661 
2670 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2671 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
2672 
2682 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2683 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
2684 
2698 LWS_VISIBLE LWS_EXTERN int
2699 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
2700 
2718 LWS_VISIBLE LWS_EXTERN int
2719 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
2720  enum lws_token_indexes h, int frag_idx);
2721 
2732 LWS_VISIBLE LWS_EXTERN const char *
2733 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
2735 
2750 
2761 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2762 lws_add_http_header_status(struct lws *wsi,
2763  unsigned int code, unsigned char **p,
2764  unsigned char *end);
2777 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2778 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
2779  const unsigned char *value, int length,
2780  unsigned char **p, unsigned char *end);
2794 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2795 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
2796  const unsigned char *value, int length,
2797  unsigned char **p, unsigned char *end);
2808 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2809 lws_add_http_header_content_length(struct lws *wsi,
2810  unsigned long content_length,
2811  unsigned char **p, unsigned char *end);
2821 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2822 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
2823  unsigned char *end);
2825 
2844 
2847 enum lws_spa_fileupload_states {
2848  LWS_UFS_CONTENT,
2850  LWS_UFS_FINAL_CONTENT,
2852  LWS_UFS_OPEN
2854 };
2855 
2869 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
2870  const char *filename, char *buf, int len,
2871  enum lws_spa_fileupload_states state);
2872 
2875 struct lws_spa;
2876 
2895 LWS_VISIBLE LWS_EXTERN struct lws_spa *
2896 lws_spa_create(struct lws *wsi, const char * const *param_names,
2897  int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
2898  void *opt_data);
2899 
2907 LWS_VISIBLE LWS_EXTERN int
2908 lws_spa_process(struct lws_spa *spa, const char *in, int len);
2909 
2915 LWS_VISIBLE LWS_EXTERN int
2916 lws_spa_finalize(struct lws_spa *spa);
2917 
2924 LWS_VISIBLE LWS_EXTERN int
2925 lws_spa_get_length(struct lws_spa *spa, int n);
2926 
2932 LWS_VISIBLE LWS_EXTERN const char *
2933 lws_spa_get_string(struct lws_spa *spa, int n);
2934 
2940 LWS_VISIBLE LWS_EXTERN int
2941 lws_spa_destroy(struct lws_spa *spa);
2943 
2954 
2965 LWS_VISIBLE LWS_EXTERN const char *
2966 lws_urlencode(char *escaped, const char *string, int len);
2967 
2968 /*
2969  * URLDECODE 1 / 2
2970  *
2971  * This simple urldecode only operates until the first '\0' and requires the
2972  * data to exist all at once
2973  */
2986 LWS_VISIBLE LWS_EXTERN int
2987 lws_urldecode(char *string, const char *escaped, int len);
2989 
2998 LWS_VISIBLE LWS_EXTERN int
2999 lws_return_http_status(struct lws *wsi, unsigned int code,
3000  const char *html_body);
3001 
3012 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3013 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3014  unsigned char **p, unsigned char *end);
3015 
3024 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3025 lws_http_transaction_completed(struct lws *wsi);
3027 
3035 
3046 LWS_VISIBLE LWS_EXTERN const char *
3047 lws_sql_purify(char *escaped, const char *string, int len);
3048 
3059 LWS_VISIBLE LWS_EXTERN const char *
3060 lws_json_purify(char *escaped, const char *string, int len);
3062 
3069 
3071 #ifdef LWS_USE_LIBEV
3072 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3073 
3074 LWS_VISIBLE LWS_EXTERN int
3075 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3076  lws_ev_signal_cb_t *cb);
3077 
3078 LWS_VISIBLE LWS_EXTERN int
3079 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3080 
3081 LWS_VISIBLE LWS_EXTERN void
3082 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3083 #endif /* LWS_USE_LIBEV */
3084 
3086 
3093 #ifdef LWS_USE_LIBUV
3095 LWS_VISIBLE LWS_EXTERN int
3096 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3097  uv_signal_cb cb);
3098 
3099 LWS_VISIBLE LWS_EXTERN void
3100 lws_libuv_run(const struct lws_context *context, int tsi);
3101 
3102 LWS_VISIBLE LWS_EXTERN void
3103 lws_libuv_stop(struct lws_context *context);
3104 
3105 LWS_VISIBLE LWS_EXTERN int
3106 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3107 
3108 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3109 lws_uv_getloop(struct lws_context *context, int tsi);
3110 
3111 LWS_VISIBLE LWS_EXTERN void
3112 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3113 #endif /* LWS_USE_LIBUV */
3114 
3121 
3122 /*
3123  * NOTE: These public enums are part of the abi. If you want to add one,
3124  * add it at where specified so existing users are unaffected.
3125  */
3126 enum pending_timeout {
3127  NO_PENDING_TIMEOUT = 0,
3128  PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3129  PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3130  PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3131  PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3132  PENDING_TIMEOUT_AWAITING_PING = 5,
3133  PENDING_TIMEOUT_CLOSE_ACK = 6,
3134  PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3135  PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3136  PENDING_TIMEOUT_SSL_ACCEPT = 9,
3137  PENDING_TIMEOUT_HTTP_CONTENT = 10,
3138  PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3139  PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3140  PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3141  PENDING_TIMEOUT_CGI = 14,
3142  PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3143  PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3144  PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3145  PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3146 
3147  /****** add new things just above ---^ ******/
3148 };
3149 
3159 LWS_VISIBLE LWS_EXTERN void
3160 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3162 
3168 #if !defined(LWS_SIZEOFPTR)
3169 #define LWS_SIZEOFPTR (sizeof (void *))
3170 #endif
3171 #if !defined(u_int64_t)
3172 #define u_int64_t unsigned long long
3173 #endif
3174 
3175 #if defined(__x86_64__)
3176 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3177 #else
3178 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3179 #endif
3180 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3181  ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3182 #define LWS_PRE _LWS_PAD(4 + 10)
3183 /* used prior to 1.7 and retained for backward compatibility */
3184 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3185 #define LWS_SEND_BUFFER_POST_PADDING 0
3186 
3187 /*
3188  * NOTE: These public enums are part of the abi. If you want to add one,
3189  * add it at where specified so existing users are unaffected.
3190  */
3191 enum lws_write_protocol {
3192  LWS_WRITE_TEXT = 0,
3196  LWS_WRITE_BINARY = 1,
3199  LWS_WRITE_CONTINUATION = 2,
3202  LWS_WRITE_HTTP = 3,
3205  /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3206  LWS_WRITE_PING = 5,
3207  LWS_WRITE_PONG = 6,
3208 
3209  /* Same as write_http but we know this write ends the transaction */
3210  LWS_WRITE_HTTP_FINAL = 7,
3211 
3212  /* HTTP2 */
3213 
3214  LWS_WRITE_HTTP_HEADERS = 8,
3221  /****** add new things just above ---^ ******/
3222 
3223  /* flags */
3224 
3225  LWS_WRITE_NO_FIN = 0x40,
3228  LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3232 };
3233 
3234 
3321 LWS_VISIBLE LWS_EXTERN int
3322 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3323  enum lws_write_protocol protocol);
3324 
3325 /* helper for case where buffer may be const */
3326 #define lws_write_http(wsi, buf, len) \
3327  lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3328 
3348 
3361 LWS_VISIBLE LWS_EXTERN int
3362 lws_callback_on_writable(struct lws *wsi);
3363 
3377 LWS_VISIBLE LWS_EXTERN int
3378 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3379  const struct lws_protocols *protocol);
3380 
3394 LWS_VISIBLE LWS_EXTERN int
3395 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3396  const struct lws_protocols *protocol);
3397 
3410 LWS_VISIBLE LWS_EXTERN int
3411 lws_callback_all_protocol(struct lws_context *context,
3412  const struct lws_protocols *protocol, int reason);
3413 
3426 LWS_VISIBLE LWS_EXTERN int
3427 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3428  const struct lws_protocols *protocol, int reason);
3429 
3443 LWS_VISIBLE LWS_EXTERN int
3444 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3445 
3446 LWS_VISIBLE LWS_EXTERN int
3447 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3448  void *user, void *in, size_t len);
3449 
3457 LWS_VISIBLE LWS_EXTERN int
3458 lws_get_socket_fd(struct lws *wsi);
3459 
3481 LWS_VISIBLE LWS_EXTERN size_t
3482 lws_get_peer_write_allowance(struct lws *wsi);
3484 
3495 LWS_VISIBLE LWS_EXTERN int
3496 lws_rx_flow_control(struct lws *wsi, int enable);
3497 
3507 LWS_VISIBLE LWS_EXTERN void
3508 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3509  const struct lws_protocols *protocol);
3510 
3527 LWS_VISIBLE LWS_EXTERN size_t
3528 lws_remaining_packet_payload(struct lws *wsi);
3529 
3530 
3539 
3552 LWS_VISIBLE LWS_EXTERN struct lws *
3553 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3576 LWS_VISIBLE LWS_EXTERN struct lws *
3577 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
3578  const char *readbuf, size_t len);
3580 
3586 
3597 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3598 lws_canonical_hostname(struct lws_context *context);
3599 
3614 LWS_VISIBLE LWS_EXTERN void
3615 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
3616  int name_len, char *rip, int rip_len);
3617 
3628 LWS_VISIBLE LWS_EXTERN const char *
3629 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
3630 #ifndef LWS_WITH_ESP8266
3631 
3642 LWS_VISIBLE LWS_EXTERN int
3643 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
3644  size_t addrlen);
3646 #endif
3647 
3653 
3666 LWS_VISIBLE LWS_EXTERN int
3667 lws_snprintf(char *str, size_t size, const char *format, ...);
3668 
3680 LWS_VISIBLE LWS_EXTERN int
3681 lws_get_random(struct lws_context *context, void *buf, int len);
3689 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3690 lws_daemonize(const char *_lock_path);
3696 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3697 lws_get_library_version(void);
3698 
3705 LWS_VISIBLE LWS_EXTERN void *
3706 lws_wsi_user(struct lws *wsi);
3707 
3719 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3720 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
3721  const char **path);
3722 
3726 LWS_VISIBLE LWS_EXTERN unsigned long
3727 lws_now_secs(void);
3728 
3738 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
3739 lws_get_context(const struct lws *wsi);
3740 
3750 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3751 lws_get_count_threads(struct lws_context *context);
3752 
3760 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3761 lws_get_parent(const struct lws *wsi);
3762 
3769 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3770 lws_get_child(const struct lws *wsi);
3771 
3772 
3773 /*
3774  * \deprecated DEPRECATED Note: this is not normally needed as a user api.
3775  * It's provided in case it is
3776  * useful when integrating with other app poll loop service code.
3777  */
3778 LWS_VISIBLE LWS_EXTERN int
3779 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
3780 
3788 LWS_VISIBLE LWS_EXTERN void
3789 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
3791 
3797 
3804 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3805 lws_send_pipe_choked(struct lws *wsi);
3806 
3811 LWS_VISIBLE LWS_EXTERN int
3812 lws_is_final_fragment(struct lws *wsi);
3813 
3818 LWS_VISIBLE LWS_EXTERN unsigned char
3819 lws_get_reserved_bits(struct lws *wsi);
3820 
3837 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3838 lws_partial_buffered(struct lws *wsi);
3839 
3849 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3850 lws_frame_is_binary(struct lws *wsi);
3851 
3860 LWS_VISIBLE LWS_EXTERN int
3861 lws_is_ssl(struct lws *wsi);
3866 LWS_VISIBLE LWS_EXTERN int
3867 lws_is_cgi(struct lws *wsi);
3869 
3870 
3876 #ifdef LWS_SHA1_USE_OPENSSL_NAME
3878 #define lws_SHA1 SHA1
3879 #else
3880 
3889 LWS_VISIBLE LWS_EXTERN unsigned char *
3890 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
3891 #endif
3892 
3902 LWS_VISIBLE LWS_EXTERN int
3903 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
3913 LWS_VISIBLE LWS_EXTERN int
3914 lws_b64_decode_string(const char *in, char *out, int out_size);
3916 
3917 
3927 #ifdef LWS_WITH_CGI
3928 enum lws_enum_stdinouterr {
3929  LWS_STDIN = 0,
3930  LWS_STDOUT = 1,
3931  LWS_STDERR = 2,
3932 };
3933 
3934 enum lws_cgi_hdr_state {
3935  LCHS_HEADER,
3936  LCHS_CR1,
3937  LCHS_LF1,
3938  LCHS_CR2,
3939  LCHS_LF2,
3940  LHCS_PAYLOAD,
3941  LCHS_SINGLE_0A,
3942 };
3943 
3944 struct lws_cgi_args {
3945  struct lws **stdwsi;
3946  enum lws_enum_stdinouterr ch;
3947  unsigned char *data;
3948  enum lws_cgi_hdr_state hdr_state;
3949  int len;
3950 };
3951 
3952 
3962 LWS_VISIBLE LWS_EXTERN int
3963 lws_cgi(struct lws *wsi, const char * const *exec_array,
3964  int script_uri_path_len, int timeout_secs,
3965  const struct lws_protocol_vhost_options *mp_cgienv);
3966 
3972 LWS_VISIBLE LWS_EXTERN int
3973 lws_cgi_write_split_stdout_headers(struct lws *wsi);
3974 
3980 LWS_VISIBLE LWS_EXTERN int
3981 lws_cgi_kill(struct lws *wsi);
3982 #endif
3983 
3985 
4002 
4008 struct lws_plat_file_ops {
4009  lws_filefd_type (*open)(struct lws *wsi, const char *filename,
4010  unsigned long *filelen, int flags);
4014  int (*close)(struct lws *wsi, lws_filefd_type fd);
4016  unsigned long (*seek_cur)(struct lws *wsi, lws_filefd_type fd,
4017  long offset_from_cur_pos);
4019  int (*read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4020  unsigned char *buf, unsigned long len);
4022  int (*write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4023  unsigned char *buf, unsigned long len);
4026  /* Add new things just above here ---^
4027  * This is part of the ABI, don't needlessly break compatibility */
4028 };
4029 
4035 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4036 lws_get_fops(struct lws_context *context);
4037 
4046 static LWS_INLINE lws_filefd_type LWS_WARN_UNUSED_RESULT
4047 lws_plat_file_open(struct lws *wsi, const char *filename,
4048  unsigned long *filelen, int flags)
4049 {
4050  return lws_get_fops(lws_get_context(wsi))->open(wsi, filename,
4051  filelen, flags);
4052 }
4053 
4060 static LWS_INLINE int
4061 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
4062 {
4063  return lws_get_fops(lws_get_context(wsi))->close(wsi, fd);
4064 }
4065 
4073 static LWS_INLINE unsigned long
4074 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
4075 {
4076  return lws_get_fops(lws_get_context(wsi))->seek_cur(wsi, fd, offset);
4077 }
4087 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4088 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4089  unsigned char *buf, unsigned long len)
4090 {
4091  return lws_get_fops(lws_get_context(wsi))->read(wsi, fd, amount, buf,
4092  len);
4093 }
4103 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4104 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
4105  unsigned char *buf, unsigned long len)
4106 {
4107  return lws_get_fops(lws_get_context(wsi))->write(wsi, fd, amount, buf,
4108  len);
4109 }
4111 
4143 #ifdef LWS_WITH_SMTP
4144 
4146 enum lwsgs_smtp_states {
4147  LGSSMTP_IDLE,
4148  LGSSMTP_CONNECTING,
4149  LGSSMTP_CONNECTED,
4150  LGSSMTP_SENT_HELO,
4151  LGSSMTP_SENT_FROM,
4152  LGSSMTP_SENT_TO,
4153  LGSSMTP_SENT_DATA,
4154  LGSSMTP_SENT_BODY,
4155  LGSSMTP_SENT_QUIT,
4156 };
4157 
4159 struct lws_email {
4160  void *data;
4162  uv_loop_t *loop;
4165  char email_smtp_ip[32];
4166  char email_helo[32];
4167  char email_from[100];
4168  char email_to[100];
4170  unsigned int max_content_size;
4173  /* Fill all the callbacks before init */
4174 
4175  int (*on_next)(struct lws_email *email);
4180  int (*on_sent)(struct lws_email *email);
4185  int (*on_get_body)(struct lws_email *email, char *buf, int len);
4191  /* private things */
4192  uv_timer_t timeout_email;
4193  enum lwsgs_smtp_states estate;
4194  uv_connect_t email_connect_req;
4195  uv_tcp_t email_client;
4196  time_t email_connect_started;
4197  char email_buf[256];
4198  char *content;
4199 };
4200 
4210 LWS_VISIBLE LWS_EXTERN int
4211 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4212 
4221 LWS_VISIBLE LWS_EXTERN void
4222 lws_email_check(struct lws_email *email);
4230 LWS_VISIBLE LWS_EXTERN void
4231 lws_email_destroy(struct lws_email *email);
4232 
4233 #endif
4234 
4235 
4236 #ifdef __cplusplus
4237 }
4238 #endif
4239 
4240 #endif
lws_spa_destroy
LWS_VISIBLE LWS_EXTERN int lws_spa_destroy(struct lws_spa *spa)
lws_json_purify
LWS_VISIBLE LWS_EXTERN const char * lws_json_purify(char *escaped, const char *string, int len)
-
lws_cgi_args
Definition: libwebsockets.h:3943
+
lws_cgi_args
Definition: libwebsockets.h:3944
lws_protocols::rx_buffer_size
size_t rx_buffer_size
Definition: libwebsockets.h:1294
lws_spa_create
LWS_VISIBLE LWS_EXTERN struct lws_spa * lws_spa_create(struct lws *wsi, const char *const *param_names, int count_params, int max_storage, lws_spa_fileupload_cb opt_cb, void *opt_data)
lws_vhost_get
LWS_VISIBLE LWS_EXTERN struct lws_vhost * lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED
@@ -75,15 +75,15 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
LWS_CALLBACK_WSI_DESTROY
Definition: libwebsockets.h:898
lws_daemonize
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_daemonize(const char *_lock_path)
LWSMPRO_CGI
Definition: libwebsockets.h:1930
-
LWS_WRITE_HTTP
Definition: libwebsockets.h:3201
-
LGSSMTP_CONNECTED
Definition: libwebsockets.h:4148
+
LWS_WRITE_HTTP
Definition: libwebsockets.h:3202
+
LGSSMTP_CONNECTED
Definition: libwebsockets.h:4149
lws_adopt_socket_readbuf
LWS_VISIBLE LWS_EXTERN struct lws * lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd, const char *readbuf, size_t len)
lws_polarssl_context
Definition: libwebsockets.h:236
lws_http_mount::auth_mask
unsigned int auth_mask
Definition: libwebsockets.h:1965
-
LWS_WRITE_NO_FIN
Definition: libwebsockets.h:3224
-
lws_email::data
void * data
Definition: libwebsockets.h:4159
+
LWS_WRITE_NO_FIN
Definition: libwebsockets.h:3225
+
lws_email::data
void * data
Definition: libwebsockets.h:4160
lws_client_connect_info::uri_replace_from
const char * uri_replace_from
Definition: libwebsockets.h:2043
-
lws_plat_file_ops::write
int(* write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:4021
+
lws_plat_file_ops::write
int(* write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:4022
lws_callback_reasons
lws_callback_reasons
Definition: libwebsockets.h:663
lws_hdr_copy_fragment
LWS_VISIBLE LWS_EXTERN int lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len, enum lws_token_indexes h, int frag_idx)
LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS
Definition: libwebsockets.h:813
@@ -103,7 +103,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_get_peer_write_allowance
LWS_VISIBLE LWS_EXTERN size_t lws_get_peer_write_allowance(struct lws *wsi)
LWS_CALLBACK_HTTP
Definition: libwebsockets.h:747
lws_get_library_version
LWS_VISIBLE LWS_EXTERN const char *LWS_WARN_UNUSED_RESULT lws_get_library_version(void)
-
lws_email::on_sent
int(* on_sent)(struct lws_email *email)
Definition: libwebsockets.h:4179
+
lws_email::on_sent
int(* on_sent)(struct lws_email *email)
Definition: libwebsockets.h:4180
lwsgw_hash_bin
Definition: libwebsockets.h:1434
lws_client_connect_info::pwsi
struct lws ** pwsi
Definition: libwebsockets.h:2050
LWS_CALLBACK_FILTER_HTTP_CONNECTION
Definition: libwebsockets.h:781
@@ -112,22 +112,22 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
LWS_CLOSE_STATUS_INVALID_PAYLOAD
Definition: libwebsockets.h:582
lws_plugin_capability
Definition: libwebsockets.h:1390
lws_ext_parse_options
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi, void *ext_user, const struct lws_ext_options *opts, const char *o, int len)
-
lws_email::email_connect_started
time_t email_connect_started
Definition: libwebsockets.h:4195
+
lws_email::email_connect_started
time_t email_connect_started
Definition: libwebsockets.h:4196
lws_close_status
lws_close_status
Definition: libwebsockets.h:553
lws_callback_all_protocol
LWS_VISIBLE LWS_EXTERN int lws_callback_all_protocol(struct lws_context *context, const struct lws_protocols *protocol, int reason)
LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE
Definition: libwebsockets.h:593
LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT
Definition: libwebsockets.h:1494
-
lws_tokens::token_len
int token_len
Definition: libwebsockets.h:2529
+
lws_tokens::token_len
int token_len
Definition: libwebsockets.h:2530
lws_context_creation_info::mounts
const struct lws_http_mount * mounts
Definition: libwebsockets.h:1675
LWS_CALLBACK_DEL_POLL_FD
Definition: libwebsockets.h:922
lws_get_context
LWS_VISIBLE LWS_EXTERN struct lws_context *LWS_WARN_UNUSED_RESULT lws_get_context(const struct lws *wsi)
lws_protocol_vhost_options::value
const char * value
Definition: libwebsockets.h:1919
-
LWS_UFS_FINAL_CONTENT
Definition: libwebsockets.h:2849
-
LGSSMTP_SENT_BODY
Definition: libwebsockets.h:4153
+
LWS_UFS_FINAL_CONTENT
Definition: libwebsockets.h:2850
+
LGSSMTP_SENT_BODY
Definition: libwebsockets.h:4154
lws_gs_event_args::username
const char * username
Definition: libwebsockets.h:1465
lws_client_connect_via_info
LWS_VISIBLE LWS_EXTERN struct lws * lws_client_connect_via_info(struct lws_client_connect_info *ccinfo)
lws_http_mount::protocol
const char * protocol
Definition: libwebsockets.h:1949
-
lws_cgi_args::stdwsi
struct lws ** stdwsi
Definition: libwebsockets.h:3944
+
lws_cgi_args::stdwsi
struct lws ** stdwsi
Definition: libwebsockets.h:3945
lws_json_dump_vhost
LWS_VISIBLE LWS_EXTERN int lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len)
LWS_CALLBACK_CONFIRM_EXTENSION_OKAY
Definition: libwebsockets.h:868
lws_get_mimetype
LWS_VISIBLE LWS_EXTERN const char * lws_get_mimetype(const char *file, const struct lws_http_mount *m)
@@ -138,10 +138,10 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_context_creation_info
Definition: libwebsockets.h:1561
lws_context_destroy
LWS_VISIBLE LWS_EXTERN void lws_context_destroy(struct lws_context *context)
LWS_CLOSE_STATUS_TLS_FAILURE
Definition: libwebsockets.h:609
-
lws_process_html_state::start
char * start
Definition: libwebsockets.h:2468
+
lws_process_html_state::start
char * start
Definition: libwebsockets.h:2469
lws_set_allocator
LWS_VISIBLE LWS_EXTERN void lws_set_allocator(void *(*realloc)(void *ptr, size_t size))
lws_protocols::callback
lws_callback_function * callback
Definition: libwebsockets.h:1285
-
LWS_WRITE_TEXT
Definition: libwebsockets.h:3191
+
LWS_WRITE_TEXT
Definition: libwebsockets.h:3192
lws_get_socket_fd
LWS_VISIBLE LWS_EXTERN int lws_get_socket_fd(struct lws *wsi)
LWS_CALLBACK_WS_PEER_INITIATED_CLOSE
Definition: libwebsockets.h:959
LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY
Definition: libwebsockets.h:951
@@ -149,23 +149,23 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
LWS_CALLBACK_UNLOCK_POLL
Definition: libwebsockets.h:948
lws_context_creation_info::pt_serv_buf_size
unsigned int pt_serv_buf_size
Definition: libwebsockets.h:1680
lws_adopt_socket
LWS_VISIBLE LWS_EXTERN struct lws * lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
-
lws_process_html_args::len
int len
Definition: libwebsockets.h:2460
+
lws_process_html_args::len
int len
Definition: libwebsockets.h:2461
lws_context_creation_info::ka_time
int ka_time
Definition: libwebsockets.h:1616
LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS
Definition: libwebsockets.h:1510
lws_callback_on_writable_all_protocol
LWS_VISIBLE LWS_EXTERN int lws_callback_on_writable_all_protocol(const struct lws_context *context, const struct lws_protocols *protocol)
lws_set_log_level
LWS_VISIBLE LWS_EXTERN void lws_set_log_level(int level, void(*log_emit_function)(int level, const char *line))
lws_context_creation_info::ws_ping_pong_interval
unsigned short ws_ping_pong_interval
Definition: libwebsockets.h:1695
lws_plugin_capability::count_extensions
int count_extensions
Definition: libwebsockets.h:1395
-
LWS_WRITE_BINARY
Definition: libwebsockets.h:3195
+
LWS_WRITE_BINARY
Definition: libwebsockets.h:3196
lws_client_connect_info::port
int port
Definition: libwebsockets.h:2018
lws_client_connect_info::context
struct lws_context * context
Definition: libwebsockets.h:2014
LWSGS_AUTH_VERIFIED
Definition: libwebsockets.h:1442
lws_client_connect_info::ietf_version_or_minus_one
int ietf_version_or_minus_one
Definition: libwebsockets.h:2030
lws_callback_all_protocol_vhost
LWS_VISIBLE LWS_EXTERN int lws_callback_all_protocol_vhost(struct lws_vhost *vh, const struct lws_protocols *protocol, int reason)
-
LGSSMTP_IDLE
Definition: libwebsockets.h:4146
+
LGSSMTP_IDLE
Definition: libwebsockets.h:4147
lws_protocol_vhost_options
Definition: libwebsockets.h:1915
lws_callback_on_writable
LWS_VISIBLE LWS_EXTERN int lws_callback_on_writable(struct lws *wsi)
-
lws_process_html_state::vars
const char *const * vars
Definition: libwebsockets.h:2472
+
lws_process_html_state::vars
const char *const * vars
Definition: libwebsockets.h:2473
LWS_CLOSE_STATUS_PROTOCOL_ERR
Definition: libwebsockets.h:561
lws_client_connect_info
Definition: libwebsockets.h:2013
LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN
Definition: libwebsockets.h:1540
@@ -194,17 +194,17 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
LWS_CALLBACK_CLIENT_ESTABLISHED
Definition: libwebsockets.h:719
LWS_CALLBACK_ADD_POLL_FD
Definition: libwebsockets.h:906
lws_service_tsi
LWS_VISIBLE LWS_EXTERN int lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi)
-
lws_cgi_args::data
unsigned char * data
Definition: libwebsockets.h:3946
+
lws_cgi_args::data
unsigned char * data
Definition: libwebsockets.h:3947
lws_http_mount::extra_mimetypes
const struct lws_protocol_vhost_options * extra_mimetypes
Definition: libwebsockets.h:1956
lws_finalize_http_header
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_finalize_http_header(struct lws *wsi, unsigned char **p, unsigned char *end)
LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH
Definition: libwebsockets.h:712
lws_urlencode
LWS_VISIBLE LWS_EXTERN const char * lws_urlencode(char *escaped, const char *string, int len)
LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED
Definition: libwebsockets.h:793
-
lws_email::loop
uv_loop_t * loop
Definition: libwebsockets.h:4161
+
lws_email::loop
uv_loop_t * loop
Definition: libwebsockets.h:4162
LWS_CALLBACK_PROTOCOL_DESTROY
Definition: libwebsockets.h:891
lws_conn_listener
Definition: libwebsockets.h:72
-
LWS_WRITE_CLIENT_IGNORE_XOR_MASK
Definition: libwebsockets.h:3227
-
lws_process_html_state::pos
int pos
Definition: libwebsockets.h:2470
+
LWS_WRITE_CLIENT_IGNORE_XOR_MASK
Definition: libwebsockets.h:3228
+
lws_process_html_state::pos
int pos
Definition: libwebsockets.h:2471
lws_plugin::list
struct lws_plugin * list
Definition: libwebsockets.h:1404
lws_client_connect_extended
LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT lws_client_connect_extended(struct lws_context *clients, const char *address, int port, int ssl_connection, const char *path, const char *host, const char *origin, const char *protocol, int ietf_version_or_minus_one, void *userdata) LWS_WARN_DEPRECATED
lws_context_creation_info::max_http_header_data
short max_http_header_data
Definition: libwebsockets.h:1636
@@ -228,7 +228,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_http_mount::origin_protocol
unsigned char origin_protocol
Definition: libwebsockets.h:1972
lws_context_creation_info::log_filepath
const char * log_filepath
Definition: libwebsockets.h:1672
LWS_CALLBACK_HTTP_WRITEABLE
Definition: libwebsockets.h:768
-
lws_email::max_content_size
unsigned int max_content_size
Definition: libwebsockets.h:4169
+
lws_email::max_content_size
unsigned int max_content_size
Definition: libwebsockets.h:4170
lws_ext_option_arg::option_index
int option_index
Definition: libwebsockets.h:1119
lws_get_child
LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT lws_get_child(const struct lws *wsi)
lws_add_http_header_by_token
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token, const unsigned char *value, int length, unsigned char **p, unsigned char *end)
@@ -236,7 +236,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_client_connect_info::uri_replace_to
const char * uri_replace_to
Definition: libwebsockets.h:2046
lws_client_connect_info::parent_wsi
struct lws * parent_wsi
Definition: libwebsockets.h:2039
lws_b64_decode_string
LWS_VISIBLE LWS_EXTERN int lws_b64_decode_string(const char *in, char *out, int out_size)
-
lws_email::estate
enum lwsgs_smtp_states estate
Definition: libwebsockets.h:4192
+
lws_email::estate
enum lwsgs_smtp_states estate
Definition: libwebsockets.h:4193
lws_spa_finalize
LWS_VISIBLE LWS_EXTERN int lws_spa_finalize(struct lws_spa *spa)
LWS_CALLBACK_ESTABLISHED
Definition: libwebsockets.h:664
lws_get_count_threads
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_get_count_threads(struct lws_context *context)
@@ -244,26 +244,26 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_plugin::name
char name[64]
Definition: libwebsockets.h:1410
lws_hdr_fragment_length
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx)
lws_cgi_kill
LWS_VISIBLE LWS_EXTERN int lws_cgi_kill(struct lws *wsi)
-
lws_email::email_buf
char email_buf[256]
Definition: libwebsockets.h:4196
+
lws_email::email_buf
char email_buf[256]
Definition: libwebsockets.h:4197
lws_is_ssl
LWS_VISIBLE LWS_EXTERN int lws_is_ssl(struct lws *wsi)
LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME
Definition: libwebsockets.h:1499
-
lws_plat_file_ops::close
int(* close)(struct lws *wsi, lws_filefd_type fd)
Definition: libwebsockets.h:4013
+
lws_plat_file_ops::close
int(* close)(struct lws *wsi, lws_filefd_type fd)
Definition: libwebsockets.h:4014
lws_plugin::lib
uv_lib_t lib
Definition: libwebsockets.h:1406
lws_polarssl_context::certificate
x509_crt certificate
Definition: libwebsockets.h:238
lws_get_peer_addresses
LWS_VISIBLE LWS_EXTERN void lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name, int name_len, char *rip, int rip_len)
-
LGSSMTP_CONNECTING
Definition: libwebsockets.h:4147
+
LGSSMTP_CONNECTING
Definition: libwebsockets.h:4148
lws_is_cgi
LWS_VISIBLE LWS_EXTERN int lws_is_cgi(struct lws *wsi)
lws_client_connect_info::ssl_connection
int ssl_connection
Definition: libwebsockets.h:2020
LWSGSE_CREATED
Definition: libwebsockets.h:1458
lws_context_creation_info::provided_client_ssl_ctx
SSL_CTX * provided_client_ssl_ctx
Definition: libwebsockets.h:1627
lws_rx_flow_control
LWS_VISIBLE LWS_EXTERN int lws_rx_flow_control(struct lws *wsi, int enable)
-
lws_process_html_args
Definition: libwebsockets.h:2458
+
lws_process_html_args
Definition: libwebsockets.h:2459
lws_get_fops
LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops *LWS_WARN_UNUSED_RESULT lws_get_fops(struct lws_context *context)
lws_pollargs
Definition: libwebsockets.h:530
lws_http_mount::cgienv
const struct lws_protocol_vhost_options * cgienv
Definition: libwebsockets.h:1952
lws_protocol_vhost_options::name
const char * name
Definition: libwebsockets.h:1918
lws_http_mount::mountpoint_len
unsigned char mountpoint_len
Definition: libwebsockets.h:1973
-
LWS_WRITE_CONTINUATION
Definition: libwebsockets.h:3198
+
LWS_WRITE_CONTINUATION
Definition: libwebsockets.h:3199
LWS_SERVER_OPTION_SSL_ECDH
Definition: libwebsockets.h:1517
lws_pollfd::fd
lws_sockfd_type fd
Definition: libwebsockets.h:417
LWSMPRO_FILE
Definition: libwebsockets.h:1929
@@ -305,16 +305,16 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lwsl_timestamp
LWS_VISIBLE LWS_EXTERN int lwsl_timestamp(int level, char *p, int len)
LWS_CALLBACK_HTTP_PMO
Definition: libwebsockets.h:1004
LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE
Definition: libwebsockets.h:1538
-
lws_email::timeout_email
uv_timer_t timeout_email
Definition: libwebsockets.h:4191
+
lws_email::timeout_email
uv_timer_t timeout_email
Definition: libwebsockets.h:4192
LWS_SERVER_OPTION_DISABLE_IPV6
Definition: libwebsockets.h:1508
lws_context_creation_info::max_http_header_pool
short max_http_header_pool
Definition: libwebsockets.h:1639
lws_chunked_html_process
LWS_VISIBLE LWS_EXTERN int lws_chunked_html_process(struct lws_process_html_args *args, struct lws_process_html_state *s)
-
lws_process_html_args::p
char * p
Definition: libwebsockets.h:2459
+
lws_process_html_args::p
char * p
Definition: libwebsockets.h:2460
lws_polarssl_context::ca
x509_crt ca
Definition: libwebsockets.h:237
lws_protocols::per_session_data_size
size_t per_session_data_size
Definition: libwebsockets.h:1289
LWS_CLOSE_STATUS_NO_STATUS
Definition: libwebsockets.h:571
lws_context_creation_info::reject_service_keywords
const struct lws_protocol_vhost_options * reject_service_keywords
Definition: libwebsockets.h:1711
-
lwsgs_smtp_states
lwsgs_smtp_states
Definition: libwebsockets.h:4145
+
lwsgs_smtp_states
lwsgs_smtp_states
Definition: libwebsockets.h:4146
LWS_SERVER_OPTION_LIBUV
Definition: libwebsockets.h:1520
LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER
Definition: libwebsockets.h:844
lws_snprintf
LWS_VISIBLE LWS_EXTERN int lws_snprintf(char *str, size_t size, const char *format,...)
@@ -326,7 +326,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_gs_event_args::email
const char * email
Definition: libwebsockets.h:1466
lws_get_random
LWS_VISIBLE LWS_EXTERN int lws_get_random(struct lws_context *context, void *buf, int len)
LWS_CLOSE_STATUS_GOINGAWAY
Definition: libwebsockets.h:558
-
lws_email::email_connect_req
uv_connect_t email_connect_req
Definition: libwebsockets.h:4193
+
lws_email::email_connect_req
uv_connect_t email_connect_req
Definition: libwebsockets.h:4194
lws_context_creation_info::server_string
const char * server_string
Definition: libwebsockets.h:1677
LWS_SERVER_OPTION_UNIX_SOCK
Definition: libwebsockets.h:1531
lws_pollfd::events
SHORT events
Definition: libwebsockets.h:418
@@ -344,12 +344,12 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_context_creation_info::ka_interval
int ka_interval
Definition: libwebsockets.h:1623
LWSGS_AUTH_LOGGED_IN
Definition: libwebsockets.h:1440
lws_context_creation_info::uid
int uid
Definition: libwebsockets.h:1609
-
LWS_UFS_OPEN
Definition: libwebsockets.h:2851
+
LWS_UFS_OPEN
Definition: libwebsockets.h:2852
lws_b64_encode_string
LWS_VISIBLE LWS_EXTERN int lws_b64_encode_string(const char *in, int in_len, char *out, int out_size)
lws_context_user
LWS_VISIBLE LWS_EXTERN void * lws_context_user(struct lws_context *context)
lws_protocols::name
const char * name
Definition: libwebsockets.h:1282
lws_init_vhost_client_ssl
LWS_VISIBLE LWS_EXTERN int lws_init_vhost_client_ssl(const struct lws_context_creation_info *info, struct lws_vhost *vhost)
-
LGSSMTP_SENT_TO
Definition: libwebsockets.h:4151
+
LGSSMTP_SENT_TO
Definition: libwebsockets.h:4152
lws_context_creation_info::http_proxy_port
unsigned int http_proxy_port
Definition: libwebsockets.h:1605
lws_partial_buffered
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_partial_buffered(struct lws *wsi)
lws_context_creation_info::timeout_secs
unsigned int timeout_secs
Definition: libwebsockets.h:1652
@@ -363,7 +363,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_session_info
Definition: libwebsockets.h:1447
lws_ext_options
Definition: libwebsockets.h:1108
lws_context_creation_info::headers
const struct lws_protocol_vhost_options * headers
Definition: libwebsockets.h:1707
-
lws_token_limits
Definition: libwebsockets.h:2648
+
lws_token_limits
Definition: libwebsockets.h:2649
lws_write
LWS_VISIBLE LWS_EXTERN int lws_write(struct lws *wsi, unsigned char *buf, size_t len, enum lws_write_protocol protocol)
lws_context_creation_info::pvo
const struct lws_protocol_vhost_options * pvo
Definition: libwebsockets.h:1666
lws_http_mount::basic_auth_login_file
const char * basic_auth_login_file
Definition: libwebsockets.h:1975
@@ -371,29 +371,29 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_ext_option_arg
Definition: libwebsockets.h:1117
LWS_CLOSE_STATUS_EXTENSION_REQUIRED
Definition: libwebsockets.h:597
lws_vhost_name_to_protocol
LWS_VISIBLE LWS_EXTERN const struct lws_protocols * lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name)
-
lws_cgi_args::len
int len
Definition: libwebsockets.h:3948
+
lws_cgi_args::len
int len
Definition: libwebsockets.h:3949
lws_get_urlarg_by_name
LWS_VISIBLE LWS_EXTERN const char * lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len)
lws_context_creation_info::iface
const char * iface
Definition: libwebsockets.h:1567
-
lws_plat_file_ops
Definition: libwebsockets.h:4007
+
lws_plat_file_ops
Definition: libwebsockets.h:4008
lwsl_hexdump
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len)
LWS_CALLBACK_CLIENT_HTTP_WRITEABLE
Definition: libwebsockets.h:1009
-
lws_spa_fileupload_states
lws_spa_fileupload_states
Definition: libwebsockets.h:2846
+
lws_spa_fileupload_states
lws_spa_fileupload_states
Definition: libwebsockets.h:2847
lws_service_fd
LWS_VISIBLE LWS_EXTERN int lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd)
lws_callback_vhost_protocols
LWS_VISIBLE LWS_EXTERN int lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len)
LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS
Definition: libwebsockets.h:820
LWS_CLOSE_STATUS_NORMAL
Definition: libwebsockets.h:555
LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE
Definition: libwebsockets.h:564
lws_sql_purify
LWS_VISIBLE LWS_EXTERN const char * lws_sql_purify(char *escaped, const char *string, int len)
-
lws_email::email_client
uv_tcp_t email_client
Definition: libwebsockets.h:4194
+
lws_email::email_client
uv_tcp_t email_client
Definition: libwebsockets.h:4195
lws_json_dump_context
LWS_VISIBLE LWS_EXTERN int lws_json_dump_context(const struct lws_context *context, char *buf, int len)
lws_pollfd
Definition: libwebsockets.h:416
LWS_CALLBACK_CLIENT_CONNECTION_ERROR
Definition: libwebsockets.h:668
-
lws_plat_file_ops::open
lws_filefd_type(* open)(struct lws *wsi, const char *filename, unsigned long *filelen, int flags)
Definition: libwebsockets.h:4008
-
lws_write_protocol
lws_write_protocol
Definition: libwebsockets.h:3190
+
lws_plat_file_ops::open
lws_filefd_type(* open)(struct lws *wsi, const char *filename, unsigned long *filelen, int flags)
Definition: libwebsockets.h:4009
+
lws_write_protocol
lws_write_protocol
Definition: libwebsockets.h:3191
lws_extension::client_offer
const char * client_offer
Definition: libwebsockets.h:1194
-
lws_plat_file_ops::read
int(* read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:4018
+
lws_plat_file_ops::read
int(* read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:4019
lws_cancel_service
LWS_VISIBLE LWS_EXTERN void lws_cancel_service(struct lws_context *context)
-
LWS_UFS_CONTENT
Definition: libwebsockets.h:2847
+
LWS_UFS_CONTENT
Definition: libwebsockets.h:2848
LWS_CLOSE_STATUS_RESERVED
Definition: libwebsockets.h:569
lws_http_mount::origin
const char * origin
Definition: libwebsockets.h:1945
lws_ext_options::name
const char * name
Definition: libwebsockets.h:1109
@@ -404,7 +404,7 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_hdr_copy
LWS_VISIBLE LWS_EXTERN int lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h)
LWS_CALLBACK_SERVER_WRITEABLE
Definition: libwebsockets.h:745
lws_extension::name
const char * name
Definition: libwebsockets.h:1192
-
LGSSMTP_SENT_FROM
Definition: libwebsockets.h:4150
+
LGSSMTP_SENT_FROM
Definition: libwebsockets.h:4151
pollfd::revents
short revents
Definition: libwebsockets.h:434
lws_extension::callback
lws_extension_callback_function * callback
Definition: libwebsockets.h:1193
lws_context_creation_info::ssl_options_set
long ssl_options_set
Definition: libwebsockets.h:1691
@@ -425,37 +425,37 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_service
LWS_VISIBLE LWS_EXTERN int lws_service(struct lws_context *context, int timeout_ms)
LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED
Definition: libwebsockets.h:1513
lws_http_transaction_completed
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_http_transaction_completed(struct lws *wsi)
-
lws_process_html_state::count_vars
int count_vars
Definition: libwebsockets.h:2473
+
lws_process_html_state::count_vars
int count_vars
Definition: libwebsockets.h:2474
lws_add_http_header_status
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_add_http_header_status(struct lws *wsi, unsigned int code, unsigned char **p, unsigned char *end)
-
lws_tokens
Definition: libwebsockets.h:2527
+
lws_tokens
Definition: libwebsockets.h:2528
lws_create_context
LWS_VISIBLE LWS_EXTERN struct lws_context * lws_create_context(struct lws_context_creation_info *info)
LWS_CALLBACK_CLOSED_HTTP
Definition: libwebsockets.h:724
-
lws_process_html_state::data
void * data
Definition: libwebsockets.h:2471
-
lws_email::content
char * content
Definition: libwebsockets.h:4197
+
lws_process_html_state::data
void * data
Definition: libwebsockets.h:2472
+
lws_email::content
char * content
Definition: libwebsockets.h:4198
lws_interface_to_sa
LWS_VISIBLE LWS_EXTERN int lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr, size_t addrlen)
lws_context_creation_info::token_limits
const struct lws_token_limits * token_limits
Definition: libwebsockets.h:1581
-
lws_email
Definition: libwebsockets.h:4158
+
lws_email
Definition: libwebsockets.h:4159
lws_client_connect_info::address
const char * address
Definition: libwebsockets.h:2016
-
lws_plat_file_ops::seek_cur
unsigned long(* seek_cur)(struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)
Definition: libwebsockets.h:4015
+
lws_plat_file_ops::seek_cur
unsigned long(* seek_cur)(struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)
Definition: libwebsockets.h:4016
lws_protocols::user
void * user
Definition: libwebsockets.h:1310
lws_pollargs::events
int events
Definition: libwebsockets.h:532
lws_http_client_http_response
LWS_VISIBLE LWS_EXTERN unsigned int lws_http_client_http_response(struct lws *wsi)
-
lws_email::on_get_body
int(* on_get_body)(struct lws_email *email, char *buf, int len)
Definition: libwebsockets.h:4184
+
lws_email::on_get_body
int(* on_get_body)(struct lws_email *email, char *buf, int len)
Definition: libwebsockets.h:4185
LWSMPRO_CALLBACK
Definition: libwebsockets.h:1933
lws_context_creation_info::user
void * user
Definition: libwebsockets.h:1613
-
LGSSMTP_SENT_QUIT
Definition: libwebsockets.h:4154
-
LWS_WRITE_HTTP_HEADERS
Definition: libwebsockets.h:3213
-
lws_tokens::token
char * token
Definition: libwebsockets.h:2528
+
LGSSMTP_SENT_QUIT
Definition: libwebsockets.h:4155
+
LWS_WRITE_HTTP_HEADERS
Definition: libwebsockets.h:3214
+
lws_tokens::token
char * token
Definition: libwebsockets.h:2529
lws_protocol_vh_priv_get
LWS_VISIBLE LWS_EXTERN void * lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot)
lws_plugin_capability::count_protocols
int count_protocols
Definition: libwebsockets.h:1393
lws_plugin::l
void * l
Definition: libwebsockets.h:1408
lws_context_creation_info::ssl_private_key_filepath
const char * ssl_private_key_filepath
Definition: libwebsockets.h:1590
-
lws_process_html_args::max_len
int max_len
Definition: libwebsockets.h:2461
+
lws_process_html_args::max_len
int max_len
Definition: libwebsockets.h:2462
LWS_CALLBACK_RECEIVE
Definition: libwebsockets.h:726
lws_protocol_vhost_options::next
const struct lws_protocol_vhost_options * next
Definition: libwebsockets.h:1916
LWS_CALLBACK_CLIENT_WRITEABLE
Definition: libwebsockets.h:737
lws_rx_flow_allow_all_protocol
LWS_VISIBLE LWS_EXTERN void lws_rx_flow_allow_all_protocol(const struct lws_context *context, const struct lws_protocols *protocol)
-
lws_process_html_state
Definition: libwebsockets.h:2467
+
lws_process_html_state
Definition: libwebsockets.h:2468
lws_canonical_hostname
LWS_VISIBLE LWS_EXTERN const char *LWS_WARN_UNUSED_RESULT lws_canonical_hostname(struct lws_context *context)
LWS_CALLBACK_LOCK_POLL
Definition: libwebsockets.h:936
lws_context_creation_info::ssl_ca_filepath
const char * ssl_ca_filepath
Definition: libwebsockets.h:1596
@@ -466,12 +466,12 @@ $(document).ready(function(){initNavTree('libwebsockets_8h_source.html','');});
lws_cancel_service_pt
LWS_VISIBLE LWS_EXTERN void lws_cancel_service_pt(struct lws *wsi)
LWS_SERVER_OPTION_STS
Definition: libwebsockets.h:1533
LWS_CLOSE_STATUS_UNEXPECTED_CONDITION
Definition: libwebsockets.h:605
-
LGSSMTP_SENT_HELO
Definition: libwebsockets.h:4149
+
LGSSMTP_SENT_HELO
Definition: libwebsockets.h:4150
lws_plugin_capability::api_magic
unsigned int api_magic
Definition: libwebsockets.h:1391
LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY
Definition: libwebsockets.h:1536
lws_send_pipe_choked
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_send_pipe_choked(struct lws *wsi)
-
LGSSMTP_SENT_DATA
Definition: libwebsockets.h:4152
-
lws_spa_fileupload_cb
int(* lws_spa_fileupload_cb)(void *data, const char *name, const char *filename, char *buf, int len, enum lws_spa_fileupload_states state)
Definition: libwebsockets.h:2868
+
LGSSMTP_SENT_DATA
Definition: libwebsockets.h:4153
+
lws_spa_fileupload_cb
int(* lws_spa_fileupload_cb)(void *data, const char *name, const char *filename, char *buf, int len, enum lws_spa_fileupload_states state)
Definition: libwebsockets.h:2869
diff --git a/doc/html/navtreedata.js b/doc/html/navtreedata.js index ff0c93a..2fac4aa 100644 --- a/doc/html/navtreedata.js +++ b/doc/html/navtreedata.js @@ -134,9 +134,9 @@ var NAVTREEINDEX = [ "annotated.html", "group__context-and-vhost.html#gga41c2d763f78cc248df3b9f8645dbd2a5a87a824b2e812f4c3e7f2c4a1ea4f8abd", -"group__service.html#ga9b3cc4473fd8848e5bbee7f310712939", +"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2", "group__wsstatus.html#gaccd9c59336efad8af0554f79cc5966fd", -"structlws__http__mount.html#a4437423df85ee3dbcae0e15974c89ec7" +"structlws__http__mount.html#a4283e30ea89d27ae7d061ad760d1d146" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/doc/html/navtreeindex0.js b/doc/html/navtreeindex0.js index 1e2abf8..8d127de 100644 --- a/doc/html/navtreeindex0.js +++ b/doc/html/navtreeindex0.js @@ -181,8 +181,8 @@ var NAVTREEINDEX0 = "group__callback-when-writeable.html#gaa709e02a10558753c851e58f1e2c16ba":[9,1,7], "group__callback-when-writeable.html#gaa709e02a10558753c851e58f1e2c16ba":[11,0,0,0,101], "group__callback-when-writeable.html#gaad3d524a84d2be08ac85153bc158504b":[11,0,0,0,55], -"group__callback-when-writeable.html#gabbe4655c7eeb3eb1671b2323ec6b3107":[9,1,3], "group__callback-when-writeable.html#gabbe4655c7eeb3eb1671b2323ec6b3107":[11,0,0,0,57], +"group__callback-when-writeable.html#gabbe4655c7eeb3eb1671b2323ec6b3107":[9,1,3], "group__callback-when-writeable.html#gac4643fe16b0940ae5b68b4ee6195cbde":[9,1,6], "group__callback-when-writeable.html#gac4643fe16b0940ae5b68b4ee6195cbde":[11,0,0,0,97], "group__callback-when-writeable.html#gacf04bbe089f47c971c6408c5efe2ac70":[9,1,0], @@ -195,8 +195,8 @@ var NAVTREEINDEX0 = "group__client.html#ga4450c34200bf9dab3beb90ef23221870":[11,0,0,0,109], "group__client.html#ga4af0a20108a95e8b6d94dd4d80055ff3":[9,2,2], "group__client.html#ga4af0a20108a95e8b6d94dd4d80055ff3":[11,0,0,0,67], -"group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340":[9,2,6], "group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340":[11,0,0,0,112], +"group__client.html#ga4f44b8230e6732816ca5cd8d1aaaf340":[9,2,6], "group__client.html#ga715efffc0c4e8fbf72a4293008eb2187":[9,2,5], "group__client.html#ga715efffc0c4e8fbf72a4293008eb2187":[11,0,0,0,108], "group__client.html#ga96f3dbad54b2853969cfa933d66871ce":[9,2,1], diff --git a/doc/html/navtreeindex1.js b/doc/html/navtreeindex1.js index 3f177f8..560d282 100644 --- a/doc/html/navtreeindex1.js +++ b/doc/html/navtreeindex1.js @@ -116,35 +116,36 @@ var NAVTREEINDEX1 = "group__html-chunked-substitution.html#ga643073f918c0a7016b690aae9793fd60":[11,0,0,0,66], "group__html-chunked-substitution.html#ga669d3d7ce2d5f193473f649a89b3e7ac":[11,0,0,0,14], "group__html-chunked-substitution.html#gabc3b93f68c8bdd857ad32913628dfa8d":[11,0,0,0,21], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da08107f6b0e1d7c9e2ca100700cc7200f":[11,0,0,0,21,22], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da145570ed1178d3d90ad9b7652fea83cf":[11,0,0,0,21,20], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da1558c42d80f54def5f3277dc879d2844":[11,0,0,0,21,11], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da2637ec8a704c0d7fcb7ff8ce5d871be0":[11,0,0,0,21,19], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da299a2d262210540b593420fe89e01b32":[11,0,0,0,21,23], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da2e57a633f7a2422f67bf207648519e30":[11,0,0,0,21,21], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da36b5bcf2059ae3c84a47e080822239c7":[11,0,0,0,21,13], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da40246e02220192ce8d7f86591ca1cfe4":[11,0,0,0,21,12], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da419c919f74b88d18803358141ab9471c":[11,0,0,0,21,8], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da49cf9c4c184f9e4d265ceae249e92477":[11,0,0,0,21,5], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da53df069872b37830e4296f32e7ec20d8":[11,0,0,0,21,3], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da63eb71a406e943d4634c357d60dd96df":[11,0,0,0,21,10], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da67278d96cfa0eb507535b94338810d65":[11,0,0,0,21,15], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da6964f9591ba7284dc4bd388d40c106a9":[11,0,0,0,21,14], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da9632802fcd318d1676be7589e6004e96":[11,0,0,0,21,2], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daafd60e3a2073e04b8f2247f8f9ac9710":[11,0,0,0,21,18], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dab355dd546e62b1478fe3ef94b554f75c":[11,0,0,0,21,26], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dab42dfcbd67b4e66096e3a8e924b6d6c9":[11,0,0,0,21,16], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac3d4da4de851d5c8f95748145b59716a":[11,0,0,0,21,17], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac96829d2c2cb76feb1549f0fac72c69e":[11,0,0,0,21,25], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac9c5b4e80aa858cfe2763656db1f16e3":[11,0,0,0,21,24], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da08107f6b0e1d7c9e2ca100700cc7200f":[11,0,0,0,21,23], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da145570ed1178d3d90ad9b7652fea83cf":[11,0,0,0,21,21], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da1558c42d80f54def5f3277dc879d2844":[11,0,0,0,21,12], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da2637ec8a704c0d7fcb7ff8ce5d871be0":[11,0,0,0,21,20], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da299a2d262210540b593420fe89e01b32":[11,0,0,0,21,24], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da2e57a633f7a2422f67bf207648519e30":[11,0,0,0,21,22], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da36b5bcf2059ae3c84a47e080822239c7":[11,0,0,0,21,14], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da40246e02220192ce8d7f86591ca1cfe4":[11,0,0,0,21,13], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da419c919f74b88d18803358141ab9471c":[11,0,0,0,21,9], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da49cf9c4c184f9e4d265ceae249e92477":[11,0,0,0,21,6], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da53df069872b37830e4296f32e7ec20d8":[11,0,0,0,21,4], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da63eb71a406e943d4634c357d60dd96df":[11,0,0,0,21,11], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da67278d96cfa0eb507535b94338810d65":[11,0,0,0,21,16], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da6964f9591ba7284dc4bd388d40c106a9":[11,0,0,0,21,15], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8da9632802fcd318d1676be7589e6004e96":[11,0,0,0,21,3], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daa55ceddb5bb2104bfcfefb16995192a4":[11,0,0,0,21,2], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daafd60e3a2073e04b8f2247f8f9ac9710":[11,0,0,0,21,19], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dab355dd546e62b1478fe3ef94b554f75c":[11,0,0,0,21,27], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dab42dfcbd67b4e66096e3a8e924b6d6c9":[11,0,0,0,21,17], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac3d4da4de851d5c8f95748145b59716a":[11,0,0,0,21,18], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac96829d2c2cb76feb1549f0fac72c69e":[11,0,0,0,21,26], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dac9c5b4e80aa858cfe2763656db1f16e3":[11,0,0,0,21,25], "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad000a2e30c534c201201dd74fac8d2f9":[11,0,0,0,21,1], "group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad34cd21de350cd4fa83b8099e3993b91":[11,0,0,0,21,0], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad771b2a0ab88db11b2719c8e5086fb48":[11,0,0,0,21,6], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dadd02813da14cfdc7fe83029b8779ea4b":[11,0,0,0,21,28], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dae301c12d0cf56920659cb7b947a95267":[11,0,0,0,21,4], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daefdfc7b525c87b911d6e92a30e36cfec":[11,0,0,0,21,27], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daf06c31278cb67d7eec4b2b8157b9ad25":[11,0,0,0,21,9], -"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dafac24097912a70f224166528ce44b83b":[11,0,0,0,21,7], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dad771b2a0ab88db11b2719c8e5086fb48":[11,0,0,0,21,7], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dadd02813da14cfdc7fe83029b8779ea4b":[11,0,0,0,21,29], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dae301c12d0cf56920659cb7b947a95267":[11,0,0,0,21,5], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daefdfc7b525c87b911d6e92a30e36cfec":[11,0,0,0,21,28], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8daf06c31278cb67d7eec4b2b8157b9ad25":[11,0,0,0,21,10], +"group__html-chunked-substitution.html#ggabc3b93f68c8bdd857ad32913628dfa8dafac24097912a70f224166528ce44b83b":[11,0,0,0,21,8], "group__http.html":[9,6], "group__http.html#ga8fbf01e473ac421fc33ad9f8da8b8a25":[9,6,7], "group__http.html#ga8fbf01e473ac421fc33ad9f8da8b8a25":[11,0,0,0,110], @@ -199,8 +200,8 @@ var NAVTREEINDEX1 = "group__misc.html#ga9f37d0e357de2ab4170723fcdb665d21":[9,8,10], "group__misc.html#gaa194584fff9698f3b280658f770ccd0f":[11,0,0,0,165], "group__misc.html#gaa194584fff9698f3b280658f770ccd0f":[9,8,11], -"group__misc.html#gab321ed812f46f6dc7ef9e3ca6f00cf1b":[9,8,9], "group__misc.html#gab321ed812f46f6dc7ef9e3ca6f00cf1b":[11,0,0,0,141], +"group__misc.html#gab321ed812f46f6dc7ef9e3ca6f00cf1b":[9,8,9], "group__misc.html#gac6abfc0b2bd5b2f09281a4432bb2f5f0":[9,8,4], "group__misc.html#gac6abfc0b2bd5b2f09281a4432bb2f5f0":[11,0,0,0,92], "group__misc.html#gacae4d7b6a8d22e4c2d82ff8b12c1e234":[9,8,1], @@ -219,8 +220,8 @@ var NAVTREEINDEX1 = "group__pur.html":[9,12], "group__pur.html#ga9cc82f06e5ae7e71458626d7a39a5865":[11,0,0,0,154], "group__pur.html#ga9cc82f06e5ae7e71458626d7a39a5865":[9,12,1], -"group__pur.html#gab15187efcfa256b7c928562c182b92a3":[11,0,0,0,119], "group__pur.html#gab15187efcfa256b7c928562c182b92a3":[9,12,0], +"group__pur.html#gab15187efcfa256b7c928562c182b92a3":[11,0,0,0,119], "group__sending-data.html":[9,13], "group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d":[9,13,0], "group__sending-data.html#ga98b099cf8c1c7e38ad78501f270e193d":[11,0,0,0,35], @@ -248,6 +249,5 @@ var NAVTREEINDEX1 = "group__service.html#ga29c246707997ab7a466aa709aecd2d7b":[11,0,0,0,61], "group__service.html#ga4fd9d714434ca499e2b3f7dbba86f241":[11,0,0,0,137], "group__service.html#ga4fd9d714434ca499e2b3f7dbba86f241":[9,0,3], -"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2":[9,0,0], -"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2":[11,0,0,0,60] +"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2":[9,0,0] }; diff --git a/doc/html/navtreeindex2.js b/doc/html/navtreeindex2.js index ceb9d61..e0505f2 100644 --- a/doc/html/navtreeindex2.js +++ b/doc/html/navtreeindex2.js @@ -1,11 +1,12 @@ var NAVTREEINDEX2 = { +"group__service.html#ga53e3d0801dfda7960a7249dd559e68a2":[11,0,0,0,60], "group__service.html#ga9b3cc4473fd8848e5bbee7f310712939":[11,0,0,0,140], "group__service.html#ga9b3cc4473fd8848e5bbee7f310712939":[9,0,6], "group__service.html#gad82efa5466d14a9f05aa06416375b28d":[11,0,0,0,138], "group__service.html#gad82efa5466d14a9f05aa06416375b28d":[9,0,4], -"group__service.html#gaebf426eda371ba23642fc11d8e0ace6b":[9,0,5], "group__service.html#gaebf426eda371ba23642fc11d8e0ace6b":[11,0,0,0,139], +"group__service.html#gaebf426eda371ba23642fc11d8e0ace6b":[9,0,5], "group__service.html#gaf95bd0c663d6516a0c80047d9b1167a8":[11,0,0,0,136], "group__service.html#gaf95bd0c663d6516a0c80047d9b1167a8":[9,0,2], "group__sha.html":[9,11], @@ -32,10 +33,10 @@ var NAVTREEINDEX2 = "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a2c2ed16ffc572326e3040684084b21d5":[9,14,1,8], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a38fba41f28d754e38079b31418a86a69":[9,14,1,7], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a38fba41f28d754e38079b31418a86a69":[11,0,0,0,37,7], -"group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a85e3c452950c09a79086bff4b9be5c14":[11,0,0,0,37,6], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a85e3c452950c09a79086bff4b9be5c14":[9,14,1,6], -"group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a929bb4623ff3f585108aba2a1b047fab":[9,14,1,4], +"group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a85e3c452950c09a79086bff4b9be5c14":[11,0,0,0,37,6], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a929bb4623ff3f585108aba2a1b047fab":[11,0,0,0,37,4], +"group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0a929bb4623ff3f585108aba2a1b047fab":[9,14,1,4], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0aae20a0cb95b97a70f6b45d0ed2d5be83":[11,0,0,0,37,5], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0aae20a0cb95b97a70f6b45d0ed2d5be83":[9,14,1,5], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0ab61778f70ecac007b334bb14942eb41d":[9,14,1,2], @@ -43,8 +44,8 @@ var NAVTREEINDEX2 = "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0ab89442b7a3ca2b94c3cdcf33756eb933":[9,14,1,1], "group__smtp.html#gga116be79bf44f9dc2a97f46e051fe4dc0ab89442b7a3ca2b94c3cdcf33756eb933":[11,0,0,0,37,1], "group__sock-adopt.html":[9,15], -"group__sock-adopt.html#gab2d045df0f81afe00891aaed312d552b":[11,0,0,0,50], "group__sock-adopt.html#gab2d045df0f81afe00891aaed312d552b":[9,15,1], +"group__sock-adopt.html#gab2d045df0f81afe00891aaed312d552b":[11,0,0,0,50], "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af":[11,0,0,0,49], "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af":[9,15,0], "group__timeout.html":[9,3], @@ -78,8 +79,8 @@ var NAVTREEINDEX2 = "group__usercb.html":[9,16], "group__usercb.html#gad4fcb82e68d60ffacca61a3f783a0a2f":[11,0,0,0,8], "group__usercb.html#gad4fcb82e68d60ffacca61a3f783a0a2f":[9,16,0], -"group__usercb.html#gad62860e19975ba4c4af401c3cdb6abf7":[9,16,1], "group__usercb.html#gad62860e19975ba4c4af401c3cdb6abf7":[11,0,0,0,22], +"group__usercb.html#gad62860e19975ba4c4af401c3cdb6abf7":[9,16,1], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a026502768778b8d79d62dd0fe4375fc6":[11,0,0,0,22,17], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a026502768778b8d79d62dd0fe4375fc6":[9,16,1,17], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a0418587d5083bb4850faa438648496ba":[11,0,0,0,22,49], @@ -95,8 +96,8 @@ var NAVTREEINDEX2 = "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a1df60f314710236f9b53efbf468da768":[11,0,0,0,22,33], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a1df60f314710236f9b53efbf468da768":[9,16,1,33], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a23b90b5e5146e760bc3123ae1fd2a6e5":[11,0,0,0,22,40], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a24d39bf1cfc0bad9d92da9ac1717e439":[9,16,1,0], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a24d39bf1cfc0bad9d92da9ac1717e439":[11,0,0,0,22,0], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a24d39bf1cfc0bad9d92da9ac1717e439":[9,16,1,0], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a2db02fc6e1c17ab62b52109d1aa9d738":[11,0,0,0,22,7], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a2db02fc6e1c17ab62b52109d1aa9d738":[9,16,1,7], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a2fce9a8608220f32abbf1422a5498804":[11,0,0,0,22,14], @@ -118,8 +119,8 @@ var NAVTREEINDEX2 = "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a7e12418eec9bce85735e6460176ab604":[11,0,0,0,22,3], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a7ec8e2e9557ee02a4fc9f7dec7e2babc":[11,0,0,0,22,11], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a7ec8e2e9557ee02a4fc9f7dec7e2babc":[9,16,1,11], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a838b18d255c1b94a533287ba302a2eba":[9,16,1,5], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a838b18d255c1b94a533287ba302a2eba":[11,0,0,0,22,5], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a838b18d255c1b94a533287ba302a2eba":[9,16,1,5], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a8909732521d379179003d97ab7a05428":[11,0,0,0,22,35], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a8909732521d379179003d97ab7a05428":[9,16,1,35], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a89862929a72bff65257ca1d51a0fce4d":[11,0,0,0,22,52], @@ -131,8 +132,8 @@ var NAVTREEINDEX2 = "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7a982579753e70e59a9ea13ce628ac891a":[9,16,1,41], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa46f705dcf97502e95627ffde614f98b":[11,0,0,0,22,37], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa46f705dcf97502e95627ffde614f98b":[9,16,1,37], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa536e574a642ff3ab9e12bff7ba2c6a2":[9,16,1,2], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa536e574a642ff3ab9e12bff7ba2c6a2":[11,0,0,0,22,2], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa536e574a642ff3ab9e12bff7ba2c6a2":[9,16,1,2], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa5cc921b7697743017a533822a3d556a":[11,0,0,0,22,56], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa5cc921b7697743017a533822a3d556a":[9,16,1,39], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aa627548e1296e654fcfab463ec3c9587":[11,0,0,0,22,15], @@ -150,8 +151,8 @@ var NAVTREEINDEX2 = "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac3fc5bbb55e69f90396526287ee84a51":[11,0,0,0,22,38], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac3fc5bbb55e69f90396526287ee84a51":[9,16,1,38], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac432e9f891c733ba8f968c1bf57c0ddc":[11,0,0,0,22,45], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac4c68e00efcf1ff7bda7ada462aff8ae":[9,16,1,13], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac4c68e00efcf1ff7bda7ada462aff8ae":[11,0,0,0,22,13], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac4c68e00efcf1ff7bda7ada462aff8ae":[9,16,1,13], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ac8c0ae966ef1877e0020c0077ff2e4a4":[11,0,0,0,22,41], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aca834dc035b7f7486f9ce40fde54fe9e":[11,0,0,0,22,30], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7aca834dc035b7f7486f9ce40fde54fe9e":[9,16,1,30], @@ -161,14 +162,14 @@ var NAVTREEINDEX2 = "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad5d34583e3556e153eda91620b48cc49":[9,16,1,27], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad724974204d51d688f569c5d387b967d":[11,0,0,0,22,43], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad87774f1c7784cf632e1e2f5b51036e1":[11,0,0,0,22,48], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad8c6207b0c4e732f3d507f0fb79370e8":[11,0,0,0,22,1], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad8c6207b0c4e732f3d507f0fb79370e8":[9,16,1,1], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ad8c6207b0c4e732f3d507f0fb79370e8":[11,0,0,0,22,1], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7adfb41c92e2522712207ef7f2462b5e34":[11,0,0,0,22,31], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7adfb41c92e2522712207ef7f2462b5e34":[9,16,1,31], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae4986291b7a810fe290851d73bebeb1c":[11,0,0,0,22,21], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae4986291b7a810fe290851d73bebeb1c":[9,16,1,21], -"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae5ad65d779b7eab32ab67ceff91a3bac":[9,16,1,23], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae4986291b7a810fe290851d73bebeb1c":[11,0,0,0,22,21], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae5ad65d779b7eab32ab67ceff91a3bac":[11,0,0,0,22,23], +"group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae5ad65d779b7eab32ab67ceff91a3bac":[9,16,1,23], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae8d1de0bb56e03aa58cb4d44b18edd2e":[11,0,0,0,22,12], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae8d1de0bb56e03aa58cb4d44b18edd2e":[9,16,1,12], "group__usercb.html#ggad62860e19975ba4c4af401c3cdb6abf7ae9734e1d7af2abf291665ce9e4a728d3":[11,0,0,0,22,19], @@ -197,8 +198,8 @@ var NAVTREEINDEX2 = "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a1e9f0842b0e85db50fe648ed4ba9a4b0":[9,4,0,2,0], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a42f2361cfe76cd287fa8fcfc502357e2":[9,4,0,2,2], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a42f2361cfe76cd287fa8fcfc502357e2":[11,0,0,0,32,2], -"group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a8894d16316863077dfe530963ca59f67":[11,0,0,0,32,5], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a8894d16316863077dfe530963ca59f67":[9,4,0,2,5], +"group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a8894d16316863077dfe530963ca59f67":[11,0,0,0,32,5], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a946a88cf9c852eed2c0317f4115d19da":[9,4,0,2,6], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437a946a88cf9c852eed2c0317f4115d19da":[11,0,0,0,32,6], "group__vhost-mounts.html#gga31eca18e50cb4357480f2fcad36ff437aec137a2434851bd856ceebfb697b9970":[9,4,0,2,4], @@ -212,28 +213,28 @@ var NAVTREEINDEX2 = "group__wsclose.html#gae399c571df32ba532c0ca67da9284985":[9,17,0], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a1bb501d212fa4d57053db681b1dfab98":[9,17,0,2], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a1bb501d212fa4d57053db681b1dfab98":[11,0,0,0,25,3], -"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a2e1f0113494a58e762eed3d22e7080d8":[11,0,0,0,25,10], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a2e1f0113494a58e762eed3d22e7080d8":[9,17,0,9], +"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a2e1f0113494a58e762eed3d22e7080d8":[11,0,0,0,25,10], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a32c38edab10d1379febac0c479ab2e9c":[11,0,0,0,25,14], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a3ffa38d5081b85fb739e02a747ccf2c4":[11,0,0,0,25,1], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a3ffa38d5081b85fb739e02a747ccf2c4":[9,17,0,0], -"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a462c99b05459df700919cfd3f53c8276":[9,17,0,3], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a462c99b05459df700919cfd3f53c8276":[11,0,0,0,25,4], -"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a4b8a3b7ce6f731e5248e4b0fb64a5044":[11,0,0,0,25,6], +"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a462c99b05459df700919cfd3f53c8276":[9,17,0,3], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a4b8a3b7ce6f731e5248e4b0fb64a5044":[9,17,0,5], +"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a4b8a3b7ce6f731e5248e4b0fb64a5044":[11,0,0,0,25,6], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a68b3d34bebd88547dcfa5cadba0acd6c":[11,0,0,0,25,7], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a68b3d34bebd88547dcfa5cadba0acd6c":[9,17,0,6], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a7aef2da0062da606eeb35aaca5cf9050":[11,0,0,0,25,8], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a7aef2da0062da606eeb35aaca5cf9050":[9,17,0,7], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a9737a68759e739856b150ff9dfa30218":[11,0,0,0,25,2], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985a9737a68759e739856b150ff9dfa30218":[9,17,0,1], -"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ac6a161822783ee873be1c66f48d14e0e":[9,17,0,10], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ac6a161822783ee873be1c66f48d14e0e":[11,0,0,0,25,11], +"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ac6a161822783ee873be1c66f48d14e0e":[9,17,0,10], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985acc9a317c70363dd88e823e066b2c73b7":[11,0,0,0,25,0], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad0869604d79e13700ae5d196a431b350":[9,17,0,11], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad0869604d79e13700ae5d196a431b350":[11,0,0,0,25,12], -"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad09e68295eabdddcba4e332fbea70ae5":[9,17,0,8], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad09e68295eabdddcba4e332fbea70ae5":[11,0,0,0,25,9], +"group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad09e68295eabdddcba4e332fbea70ae5":[9,17,0,8], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad2b477a91c8445bf34ecd43977f9b390":[11,0,0,0,25,13], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985ad2b477a91c8445bf34ecd43977f9b390":[9,17,0,12], "group__wsclose.html#ggae399c571df32ba532c0ca67da9284985af90cb98d983ad3d4c79df9b6f3d4a4d2":[11,0,0,0,25,5], @@ -243,11 +244,10 @@ var NAVTREEINDEX2 = "group__wsstatus.html#ga08e9ee165fca503fd9427d55cfecac37":[11,0,0,0,115], "group__wsstatus.html#ga26a140623d202dd2bf2004deb6994baa":[9,18,4], "group__wsstatus.html#ga26a140623d202dd2bf2004deb6994baa":[11,0,0,0,116], -"group__wsstatus.html#ga2bb3655329b4651cd06f79ee3a764421":[9,18,6], "group__wsstatus.html#ga2bb3655329b4651cd06f79ee3a764421":[11,0,0,0,133], +"group__wsstatus.html#ga2bb3655329b4651cd06f79ee3a764421":[9,18,6], "group__wsstatus.html#ga3df5045656dfb6b0e63a38de2dca79d2":[11,0,0,0,100], "group__wsstatus.html#ga3df5045656dfb6b0e63a38de2dca79d2":[9,18,1], "group__wsstatus.html#ga4ad226d5e01024b4046f4a5a37199aa1":[9,18,2], -"group__wsstatus.html#ga4ad226d5e01024b4046f4a5a37199aa1":[11,0,0,0,114], -"group__wsstatus.html#gaccd9c59336efad8af0554f79cc5966fd":[11,0,0,0,87] +"group__wsstatus.html#ga4ad226d5e01024b4046f4a5a37199aa1":[11,0,0,0,114] }; diff --git a/doc/html/navtreeindex3.js b/doc/html/navtreeindex3.js index 8700d77..2f6fbe4 100644 --- a/doc/html/navtreeindex3.js +++ b/doc/html/navtreeindex3.js @@ -1,6 +1,7 @@ var NAVTREEINDEX3 = { "group__wsstatus.html#gaccd9c59336efad8af0554f79cc5966fd":[9,18,0], +"group__wsstatus.html#gaccd9c59336efad8af0554f79cc5966fd":[11,0,0,0,87], "group__wsstatus.html#gaeca4afc94b1f026034f99cbba37e2f85":[9,18,5], "group__wsstatus.html#gaeca4afc94b1f026034f99cbba37e2f85":[11,0,0,0,124], "hierarchy.html":[10,2], @@ -248,6 +249,5 @@ var NAVTREEINDEX3 = "structlws__http__mount.html#a05347d92c3d379809564bd4f3eab259b":[9,4,0,1,17], "structlws__http__mount.html#a11ea62b952710d59733dbcf9794a5773":[9,4,0,1,11], "structlws__http__mount.html#a21d86fd6043ec00e121ababbc29af39a":[9,4,0,1,15], -"structlws__http__mount.html#a2f6c7dbc2d714b7259c67b7744d4ff98":[9,4,0,1,2], -"structlws__http__mount.html#a4283e30ea89d27ae7d061ad760d1d146":[9,4,0,1,4] +"structlws__http__mount.html#a2f6c7dbc2d714b7259c67b7744d4ff98":[9,4,0,1,2] }; diff --git a/doc/html/navtreeindex4.js b/doc/html/navtreeindex4.js index 3f1669c..6a12090 100644 --- a/doc/html/navtreeindex4.js +++ b/doc/html/navtreeindex4.js @@ -1,5 +1,6 @@ var NAVTREEINDEX4 = { +"structlws__http__mount.html#a4283e30ea89d27ae7d061ad760d1d146":[9,4,0,1,4], "structlws__http__mount.html#a4437423df85ee3dbcae0e15974c89ec7":[9,4,0,1,10], "structlws__http__mount.html#a4a7239d6d4c03986e6e1a72abb6c83aa":[9,4,0,1,7], "structlws__http__mount.html#a614364c770b0bd4db464ad65cddab477":[9,4,0,1,1], @@ -55,14 +56,14 @@ var NAVTREEINDEX4 = "structlws__process__html__state.html#adcafd17704775b4bbeea9561fb340968":[9,6,1,1,0], "structlws__process__html__state.html#af0732884ef891e24fe5fa237ebaa21a3":[9,6,1,1,4], "structlws__process__html__state.html#af21119890fdfebe28fb5c4dabfc1bdf5":[9,6,1,1,1], -"structlws__protocol__vhost__options.html":[9,4,0,0], "structlws__protocol__vhost__options.html":[9,4,2], +"structlws__protocol__vhost__options.html":[9,4,0,0], "structlws__protocol__vhost__options.html#a0640a92513c70ee6b9b295a9ad1658e7":[9,4,2,3], "structlws__protocol__vhost__options.html#a0640a92513c70ee6b9b295a9ad1658e7":[9,4,0,0,3], -"structlws__protocol__vhost__options.html#abc714ddb4171756fc8196e9823a1e21c":[9,4,0,0,1], "structlws__protocol__vhost__options.html#abc714ddb4171756fc8196e9823a1e21c":[9,4,2,1], -"structlws__protocol__vhost__options.html#acf9db77f8eb64cd4e314be9b43d8a8b9":[9,4,2,0], +"structlws__protocol__vhost__options.html#abc714ddb4171756fc8196e9823a1e21c":[9,4,0,0,1], "structlws__protocol__vhost__options.html#acf9db77f8eb64cd4e314be9b43d8a8b9":[9,4,0,0,0], +"structlws__protocol__vhost__options.html#acf9db77f8eb64cd4e314be9b43d8a8b9":[9,4,2,0], "structlws__protocol__vhost__options.html#afd99fbc90be51ea2465b550c2ec47822":[9,4,2,2], "structlws__protocol__vhost__options.html#afd99fbc90be51ea2465b550c2ec47822":[9,4,0,0,2], "structlws__protocols.html":[9,10,1], @@ -80,12 +81,12 @@ var NAVTREEINDEX4 = "structlws__session__info.html#afb924864b70f40372920688a5c1c895e":[9,10,0,2,2], "structlws__token__limits.html":[9,6,4,1], "structlws__token__limits.html#a6ec712306cbf8585bce7a56758a3ceff":[9,6,4,1,0], -"structlws__tokens.html":[9,6,4,0], "structlws__tokens.html":[9,6,6], -"structlws__tokens.html#a855b7375d1d58516c0ecd4b60e9a7766":[9,6,6,1], +"structlws__tokens.html":[9,6,4,0], "structlws__tokens.html#a855b7375d1d58516c0ecd4b60e9a7766":[9,6,4,0,1], -"structlws__tokens.html#a9f3635412bc71a5cb78e9862b55f10cd":[9,6,6,0], +"structlws__tokens.html#a855b7375d1d58516c0ecd4b60e9a7766":[9,6,6,1], "structlws__tokens.html#a9f3635412bc71a5cb78e9862b55f10cd":[9,6,4,0,0], +"structlws__tokens.html#a9f3635412bc71a5cb78e9862b55f10cd":[9,6,6,0], "structlwsgw__hash.html":[9,10,0,1], "structlwsgw__hash.html#a29435f5cf78747d4257695b0f141d164":[9,10,0,1,0], "structlwsgw__hash__bin.html":[9,10,0,0], diff --git a/lib/libwebsockets.h b/lib/libwebsockets.h index 614f125..361bc99 100644 --- a/lib/libwebsockets.h +++ b/lib/libwebsockets.h @@ -2423,6 +2423,7 @@ lws_serve_http_file_fragment(struct lws *wsi); enum http_status { HTTP_STATUS_OK = 200, HTTP_STATUS_NO_CONTENT = 204, + HTTP_STATUS_PARTIAL_CONTENT = 206, HTTP_STATUS_MOVED_PERMANENTLY = 301, HTTP_STATUS_FOUND = 302, diff --git a/lib/output.c b/lib/output.c index 3fa9f52..ef70f23 100644 --- a/lib/output.c +++ b/lib/output.c @@ -241,7 +241,7 @@ LWS_VISIBLE int lws_write(struct lws *wsi, unsigned char *buf, size_t len, wsi->access_log.sent += len; #endif if (wsi->vhost) - wsi->vhost->tx += len; + wsi->vhost->conn_stats.tx += len; if (wsi->state == LWSS_ESTABLISHED && wsi->u.ws.tx_draining_ext) { /* remove us from the list */ @@ -558,12 +558,16 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi]; struct lws_process_html_args args; unsigned long amount, poss; - unsigned char *p = pt->serv_buf; + unsigned char *p; +#if defined(LWS_WITH_RANGES) + unsigned char finished = 0; +#endif int n, m; - + // lwsl_notice("%s (trunc len %d)\n", __func__, wsi->trunc_len); while (wsi->http2_substream || !lws_send_pipe_choked(wsi)) { + if (wsi->trunc_len) { if (lws_issue_raw(wsi, wsi->trunc_alloc + wsi->trunc_offset, @@ -577,8 +581,50 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) if (wsi->u.http.filepos == wsi->u.http.filelen) goto all_sent; - poss = context->pt_serv_buf_size; + n = 0; + + p = pt->serv_buf; + +#if defined(LWS_WITH_RANGES) + if (wsi->u.http.range.count_ranges && !wsi->u.http.range.inside) { + + lwsl_notice("%s: doing range start %llu\n", __func__, wsi->u.http.range.start); + if ((long)lws_plat_file_seek_cur(wsi, wsi->u.http.fd, + wsi->u.http.range.start - + wsi->u.http.filepos) < 0) + return -1; + + wsi->u.http.filepos = wsi->u.http.range.start; + + if (wsi->u.http.range.count_ranges > 1) { + n = lws_snprintf((char *)p, context->pt_serv_buf_size, + "_lws\x0d\x0a" + "Content-Type: %s\x0d\x0a" + "Content-Range: bytes %llu-%llu/%llu\x0d\x0a" + "\x0d\x0a", + wsi->u.http.multipart_content_type, + wsi->u.http.range.start, + wsi->u.http.range.end, + wsi->u.http.range.extent); + p += n; + } + + wsi->u.http.range.budget = wsi->u.http.range.end - + wsi->u.http.range.start + 1; + wsi->u.http.range.inside = 1; + } +#endif + + poss = context->pt_serv_buf_size - n; +#if defined(LWS_WITH_RANGES) + if (wsi->u.http.range.count_ranges) { + if (wsi->u.http.range.count_ranges > 1) + poss -= 7; /* allow for final boundary */ + if (poss > wsi->u.http.range.budget) + poss = wsi->u.http.range.budget; + } +#endif if (wsi->sending_chunked) { /* we need to drop the chunk size in here */ p += 10; @@ -591,7 +637,10 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) //lwsl_notice("amount %ld\n", amount); - n = (int)amount; + if (wsi->sending_chunked) + n = (int)amount; + else + n = (p - pt->serv_buf) + (int)amount; if (n) { lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT, context->timeout_secs); @@ -609,8 +658,19 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) return -1; n = args.len; p = (unsigned char *)args.p; + } else + p = pt->serv_buf; + +#if defined(LWS_WITH_RANGES) + if (wsi->u.http.range.send_ctr + 1 == + wsi->u.http.range.count_ranges && // last range + wsi->u.http.range.count_ranges > 1 && // was 2+ ranges (ie, multipart) + wsi->u.http.range.budget - amount == 0) {// final part + n += lws_snprintf((char *)pt->serv_buf + n, 6, + "_lws\x0d\x0a"); // append trailing boundary + lwsl_debug("added trailing boundary\n"); } - +#endif m = lws_write(wsi, p, n, wsi->u.http.filepos == wsi->u.http.filelen ? LWS_WRITE_HTTP_FINAL : @@ -620,6 +680,23 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) return -1; wsi->u.http.filepos += amount; + +#if defined(LWS_WITH_RANGES) + if (wsi->u.http.range.count_ranges >= 1) { + wsi->u.http.range.budget -= amount; + if (wsi->u.http.range.budget == 0) { + lwsl_notice("range budget exhausted\n"); + wsi->u.http.range.inside = 0; + wsi->u.http.range.send_ctr++; + + if (lws_ranges_next(&wsi->u.http.range) < 1) { + finished = 1; + goto all_sent; + } + } + } +#endif + if (m != n) { /* adjust for what was not sent */ if (lws_plat_file_seek_cur(wsi, wsi->u.http.fd, @@ -629,8 +706,13 @@ LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi) } } all_sent: - if (!wsi->trunc_len && - wsi->u.http.filepos == wsi->u.http.filelen) { + if ((!wsi->trunc_len && wsi->u.http.filepos == wsi->u.http.filelen) +#if defined(LWS_WITH_RANGES) + || finished) +#else + ) +#endif + { wsi->state = LWSS_HTTP; /* we might be in keepalive, so close it off here */ lws_plat_file_close(wsi, wsi->u.http.fd); @@ -664,7 +746,7 @@ lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len) n = recv(wsi->sock, (char *)buf, len, 0); if (n >= 0) { if (wsi->vhost) - wsi->vhost->rx += n; + wsi->vhost->conn_stats.rx += n; lws_restart_ws_ping_pong_timer(wsi); return n; } diff --git a/lib/private-libwebsockets.h b/lib/private-libwebsockets.h index 346abbd..a1abe45 100644 --- a/lib/private-libwebsockets.h +++ b/lib/private-libwebsockets.h @@ -652,6 +652,7 @@ struct allocated_headers { */ unsigned char frag_index[WSI_TOKEN_COUNT]; unsigned char rx[2048]; + unsigned int rxpos; unsigned int rxlen; unsigned int pos; @@ -1061,6 +1062,33 @@ struct _lws_header_related { char redirects; }; +#if defined(LWS_WITH_RANGES) +enum range_states { + LWSRS_NO_ACTIVE_RANGE, + LWSRS_BYTES_EQ, + LWSRS_FIRST, + LWSRS_STARTING, + LWSRS_ENDING, + LWSRS_COMPLETED, + LWSRS_SYNTAX, +}; + +struct lws_range_parsing { + unsigned long long start, end, extent, agg, budget; + const char buf[128]; + int pos; + enum range_states state; + char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr; +}; + +int +lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent); +int +lws_ranges_next(struct lws_range_parsing *rp); +void +lws_ranges_reset(struct lws_range_parsing *rp); +#endif + struct _lws_http_mode_related { /* MUST be first in struct */ struct allocated_headers *ah; /* mirroring _lws_header_related */ @@ -1075,6 +1103,11 @@ struct _lws_http_mode_related { unsigned long filelen; lws_filefd_type fd; +#if defined(LWS_WITH_RANGES) + struct lws_range_parsing range; + char multipart_content_type[64]; +#endif + enum http_version request_version; enum http_connection_type connection_type; unsigned int content_length; diff --git a/lib/ranges.c b/lib/ranges.c new file mode 100644 index 0000000..4d29540 --- /dev/null +++ b/lib/ranges.c @@ -0,0 +1,211 @@ +/* + * libwebsockets - small server side websockets and web server implementation + * + * RFC7233 ranges parser + * + * Copyright (C) 2016 Andy Green + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation: + * version 2.1 of the License. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301 USA + */ + +#include "private-libwebsockets.h" + +/* + * RFC7233 examples + * + * o The first 500 bytes (byte offsets 0-499, inclusive): + * + * bytes=0-499 + * + * o The second 500 bytes (byte offsets 500-999, inclusive): + * + * bytes=500-999 + * + * o The final 500 bytes (byte offsets 9500-9999, inclusive): + * + * bytes=-500 + * + * Or: + * + * bytes=9500- + * + * o The first and last bytes only (bytes 0 and 9999): + * + * bytes=0-0,-1 + * + * o Other valid (but not canonical) specifications of the second 500 + * bytes (byte offsets 500-999, inclusive): + * + * bytes=500-600,601-999 + * bytes=500-700,601-999 + */ + +/* + * returns 1 if the range struct represents a usable range + * if no ranges header, you get one of these for the whole + * file. Otherwise you get one for each valid range in the + * header. + * + * returns 0 if no further valid range forthcoming; rp->state + * may be LWSRS_SYNTAX or LWSRS_COMPLETED + */ + +int +lws_ranges_next(struct lws_range_parsing *rp) +{ + static const char * const beq = "bytes="; + char c; + + while (1) { + + c = rp->buf[rp->pos]; + + switch (rp->state) { + case LWSRS_SYNTAX: + case LWSRS_COMPLETED: + return 0; + + case LWSRS_NO_ACTIVE_RANGE: + rp->state = LWSRS_COMPLETED; + return 0; + + case LWSRS_BYTES_EQ: // looking for "bytes=" + if (c != beq[rp->pos]) { + rp->state = LWSRS_SYNTAX; + return -1; + } + if (rp->pos == 5) + rp->state = LWSRS_FIRST; + break; + + case LWSRS_FIRST: + rp->start = 0; + rp->end = 0; + rp->start_valid = 0; + rp->end_valid = 0; + + rp->state = LWSRS_STARTING; + + // fallthru + + case LWSRS_STARTING: + if (c == '-') { + rp->state = LWSRS_ENDING; + break; + } + + if (!(c >= '0' && c <= '9')) { + rp->state = LWSRS_SYNTAX; + return 0; + } + rp->start = (rp->start * 10) + (c - '0'); + rp->start_valid = 1; + break; + + case LWSRS_ENDING: + if (c == ',' || c == '\0') { + rp->state = LWSRS_FIRST; + if (c == ',') + rp->pos++; + + /* by the end of this, start and end are always valid if the range still is */ + + if (!rp->start_valid) { /* eg, -500 */ + if (rp->end > rp->extent) + rp->end = rp->extent; + + rp->start = rp->extent - rp->end; + rp->end = rp->extent - 1; + } else + if (!rp->end_valid) + rp->end = rp->extent - 1; + + rp->did_try = 1; + + /* end must be >= start or ignore it */ + if (rp->end < rp->start) { + if (c == ',') + break; + rp->state = LWSRS_COMPLETED; + return 0; + } + + return 1; /* issue range */ + } + + if (!(c >= '0' && c <= '9')) { + rp->state = LWSRS_SYNTAX; + return 0; + } + rp->end = (rp->end * 10) + (c - '0'); + rp->end_valid = 1; + break; + } + + rp->pos++; + } +} + +void +lws_ranges_reset(struct lws_range_parsing *rp) +{ + rp->pos = 0; + rp->ctr = 0; + rp->start = 0; + rp->end = 0; + rp->start_valid = 0; + rp->end_valid = 0; + rp->state = LWSRS_BYTES_EQ; +} + +/* + * returns count of valid ranges + */ +int +lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, + unsigned long long extent) +{ + rp->agg = 0; + rp->send_ctr = 0; + rp->inside = 0; + rp->count_ranges = 0; + rp->did_try = 0; + lws_ranges_reset(rp); + rp->state = LWSRS_COMPLETED; + + rp->extent = extent; + + if (lws_hdr_copy(wsi, (char *)rp->buf, sizeof(rp->buf), + WSI_TOKEN_HTTP_RANGE) <= 0) + return 0; + + rp->state = LWSRS_BYTES_EQ; + + while (lws_ranges_next(rp)) { + rp->count_ranges++; + rp->agg += rp->end - rp->start + 1; + } + + lwsl_debug("%s: count %d\n", __func__, rp->count_ranges); + lws_ranges_reset(rp); + + if (rp->did_try && !rp->count_ranges) + return -1; /* "not satisfiable */ + + lws_ranges_next(rp); + + return rp->count_ranges; +} diff --git a/lib/server.c b/lib/server.c index 3d0d4cd..2c8cf7d 100644 --- a/lib/server.c +++ b/lib/server.c @@ -403,6 +403,13 @@ lws_http_serve(struct lws *wsi, char *uri, const char *origin, n = sprintf(sym, "%08lX%08lX", (unsigned long)st.st_size, (unsigned long)st.st_mtime); + /* disable ranges if IF_RANGE token invalid */ + + if (lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_IF_RANGE)) + if (strcmp(sym, lws_hdr_simple_ptr(wsi, WSI_TOKEN_HTTP_IF_RANGE))) + /* differs - defeat Range: */ + wsi->u.http.ah->frag_index[WSI_TOKEN_HTTP_RANGE] = 0; + if (lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_IF_NONE_MATCH)) { /* * he thinks he has some version of it already, @@ -2116,11 +2123,18 @@ lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type, static const char * const intermediates[] = { "private", "public" }; struct lws_context *context = lws_get_context(wsi); struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi]; +#if defined(LWS_WITH_RANGES) + struct lws_range_parsing *rp = &wsi->u.http.range; +#endif char cache_control[50], *cc = "no-store"; unsigned char *response = pt->serv_buf + LWS_PRE; unsigned char *p = response; unsigned char *end = p + context->pt_serv_buf_size - LWS_PRE; - int ret = 0, cclen = 8; + unsigned long computed_total_content_length; + int ret = 0, cclen = 8, n = HTTP_STATUS_OK; +#if defined(LWS_WITH_RANGES) + int ranges; +#endif wsi->u.http.fd = lws_plat_file_open(wsi, file, &wsi->u.http.filelen, O_RDONLY); @@ -2130,18 +2144,105 @@ lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type, return -1; } + computed_total_content_length = wsi->u.http.filelen; + +#if defined(LWS_WITH_RANGES) + ranges = lws_ranges_init(wsi, rp, wsi->u.http.filelen); - if (lws_add_http_header_status(wsi, 200, &p, end)) + lwsl_debug("Range count %d\n", ranges); + /* + * no ranges -> 200; + * 1 range -> 206 + Content-Type: normal; Content-Range; + * more -> 206 + Content-Type: multipart/byteranges + * Repeat the true Content-Type in each multipart header + * along with Content-Range + */ + if (ranges < 0) { + /* it means he expressed a range in Range:, but it was illegal */ + lws_return_http_status(wsi, HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE, NULL); + if (lws_http_transaction_completed(wsi)) + return -1; /* <0 means just hang up */ + + return 0; /* == 0 means we dealt with the transaction complete */ + } + if (ranges) + n = HTTP_STATUS_PARTIAL_CONTENT; +#endif + + if (lws_add_http_header_status(wsi, n, &p, end)) return -1; - if (content_type && content_type[0]) { + +#if defined(LWS_WITH_RANGES) + if (ranges < 2 && content_type && content_type[0]) if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_TYPE, (unsigned char *)content_type, strlen(content_type), &p, end)) return -1; + + if (ranges >= 2) { /* multipart byteranges */ + strncpy(wsi->u.http.multipart_content_type, content_type, + sizeof(wsi->u.http.multipart_content_type) - 1); + wsi->u.http.multipart_content_type[ + sizeof(wsi->u.http.multipart_content_type) - 1] = '\0'; + if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_TYPE, + (unsigned char *)"multipart/byteranges; boundary=_lws", + 20, &p, end)) + return -1; + + /* + * our overall content length has to include + * + * - (n + 1) x "_lws\r\n" + * - n x Content-Type: xxx/xxx\r\n + * - n x Content-Range: bytes xxx-yyy/zzz\r\n + * - n x /r/n + * - the actual payloads (aggregated in rp->agg) + * + * Precompute it for the main response header + */ + + computed_total_content_length = (unsigned long)rp->agg + + 6 /* final _lws\r\n */; + + lws_ranges_reset(rp); + while (lws_ranges_next(rp)) { + n = lws_snprintf(cache_control, sizeof(cache_control), + "bytes %llu-%llu/%llu", + rp->start, rp->end, rp->extent); + + computed_total_content_length += + 6 /* header _lws\r\n */ + + 14 + strlen(content_type) + 2 + /* Content-Type: xxx/xxx\r\n */ + 15 + n + 2 + /* Content-Range: xxxx\r\n */ + 2; /* /r/n */ + } + + lws_ranges_reset(rp); + lws_ranges_next(rp); } + if (ranges == 1) { + computed_total_content_length = (unsigned long)rp->agg; + n = lws_snprintf(cache_control, sizeof(cache_control), "bytes %llu-%llu/%llu", + rp->start, rp->end, rp->extent); + + if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_RANGE, + (unsigned char *)cache_control, + n, &p, end)) + return -1; + } + + wsi->u.http.range.inside = 0; + + if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_ACCEPT_RANGES, + (unsigned char *)"bytes", 5, &p, end)) + return -1; +#endif + if (!wsi->sending_chunked) { - if (lws_add_http_header_content_length(wsi, wsi->u.http.filelen, &p, end)) + if (lws_add_http_header_content_length(wsi, + computed_total_content_length, + &p, end)) return -1; } else { if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_TRANSFER_ENCODING, diff --git a/lws_config.h.in b/lws_config.h.in index 7cce17e..6b0f5b2 100644 --- a/lws_config.h.in +++ b/lws_config.h.in @@ -99,6 +99,9 @@ /* HTTP Proxy support */ #cmakedefine LWS_WITH_HTTP_PROXY +/* HTTP Ranges support */ +#cmakedefine LWS_WITH_RANGES + /* Http access log support */ #cmakedefine LWS_WITH_ACCESS_LOG #cmakedefine LWS_WITH_SERVER_STATUS -- 2.7.4