libwebsockets
Lightweight C library for HTML5 websockets
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 
73 public:
75  srv(SOCKET_STACK_LWIP_IPV4)
76  {
77  srv.setOnError(TCPStream::ErrorHandler_t(this,
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 #ifdef MBED_OPERATORS
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 <stdint.h>
120 #include <fcntl.h>
121 #else
122 #define _O_RDONLY 0x0000
123 #define O_RDONLY _O_RDONLY
124 #endif
125 
126 // Visual studio older than 2015 and WIN_CE has only _stricmp
127 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
128 #define strcasecmp _stricmp
129 #else
130 #define strcasecmp stricmp
131 #endif
132 #define getdtablesize() 30000
133 
134 #define LWS_INLINE __inline
135 #define LWS_VISIBLE
136 #define LWS_WARN_UNUSED_RESULT
137 #define LWS_WARN_DEPRECATED
138 
139 #ifdef LWS_DLL
140 #ifdef LWS_INTERNAL
141 #define LWS_EXTERN extern __declspec(dllexport)
142 #else
143 #define LWS_EXTERN extern __declspec(dllimport)
144 #endif
145 #else
146 #define LWS_EXTERN
147 #endif
148 
149 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
150 #define LWS_O_RDONLY _O_RDONLY
151 
152 #if !defined(_MSC_VER) || _MSC_VER < 1900 /* Visual Studio 2015 already defines this in <stdio.h> */
153 #define snprintf _snprintf
154 #endif
155 
156 #ifndef __func__
157 #define __func__ __FUNCTION__
158 #endif
159 
160 #else /* NOT WIN32 */
161 #include <unistd.h>
162 
163 #if defined(__NetBSD__) || defined(__FreeBSD__)
164 #include <netinet/in.h>
165 #endif
166 
167 #define LWS_INLINE inline
168 #define LWS_O_RDONLY O_RDONLY
169 
170 #ifndef MBED_OPERATORS
171 #include <poll.h>
172 #include <netdb.h>
173 #define LWS_INVALID_FILE -1
174 #else
175 #define getdtablesize() (20)
176 #define LWS_INVALID_FILE NULL
177 #endif
178 
179 #if defined(__GNUC__)
180 
181 /* warn_unused_result attribute only supported by GCC 3.4 or later */
182 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
183 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
184 #else
185 #define LWS_WARN_UNUSED_RESULT
186 #endif
187 
188 #define LWS_VISIBLE __attribute__((visibility("default")))
189 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
190 #else
191 #define LWS_VISIBLE
192 #define LWS_WARN_UNUSED_RESULT
193 #define LWS_WARN_DEPRECATED
194 #endif
195 
196 #if defined(__ANDROID__)
197 #include <unistd.h>
198 #define getdtablesize() sysconf(_SC_OPEN_MAX)
199 #endif
200 
201 #endif
202 
203 #ifdef LWS_USE_LIBEV
204 #include <ev.h>
205 #endif /* LWS_USE_LIBEV */
206 #ifdef LWS_USE_LIBUV
207 #include <uv.h>
208 #endif /* LWS_USE_LIBUV */
209 
210 #ifndef LWS_EXTERN
211 #define LWS_EXTERN extern
212 #endif
213 
214 #ifdef _WIN32
215 #define random rand
216 #else
217 #include <sys/time.h>
218 #include <unistd.h>
219 #endif
220 
221 #ifdef LWS_OPENSSL_SUPPORT
222 
223 #ifdef USE_WOLFSSL
224 #ifdef USE_OLD_CYASSL
225 #include <cyassl/openssl/ssl.h>
226 #include <cyassl/error-ssl.h>
227 #else
228 #include <wolfssl/openssl/ssl.h>
229 #include <wolfssl/error-ssl.h>
230 #endif /* not USE_OLD_CYASSL */
231 #else
232 #if defined(LWS_USE_POLARSSL)
233 #include <polarssl/ssl.h>
235  x509_crt ca;
236  x509_crt certificate;
237  rsa_context key;
238 };
239 typedef struct lws_polarssl_context SSL_CTX;
240 typedef ssl_context SSL;
241 #else
242 #if defined(LWS_USE_MBEDTLS)
243 #include <mbedtls/ssl.h>
244 #else
245 #include <openssl/ssl.h>
246 #include <openssl/err.h>
247 #endif /* not USE_MBEDTLS */
248 #endif /* not USE_POLARSSL */
249 #endif /* not USE_WOLFSSL */
250 #endif
251 
252 
253 #define CONTEXT_PORT_NO_LISTEN -1
254 
265 
267 enum lws_log_levels {
268  LLL_ERR = 1 << 0,
269  LLL_WARN = 1 << 1,
270  LLL_NOTICE = 1 << 2,
271  LLL_INFO = 1 << 3,
272  LLL_DEBUG = 1 << 4,
273  LLL_PARSER = 1 << 5,
274  LLL_HEADER = 1 << 6,
275  LLL_EXT = 1 << 7,
276  LLL_CLIENT = 1 << 8,
277  LLL_LATENCY = 1 << 9,
278 
279  LLL_COUNT = 10 /* set to count of valid flags */
280 };
281 
282 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...);
283 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
293 LWS_VISIBLE LWS_EXTERN int
294 lwsl_timestamp(int level, char *p, int len);
295 
296 /* notice, warn and log are always compiled in */
297 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
298 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
299 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
300 /*
301  * weaker logging can be deselected at configure time using --disable-debug
302  * that gets rid of the overhead of checking while keeping _warn and _err
303  * active
304  */
305 #ifdef _DEBUG
306 
307 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
308 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
309 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
310 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
311 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
312 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
313 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
314 
320 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
321 
322 #else /* no debug */
323 
324 #define lwsl_info(...) {}
325 #define lwsl_debug(...) {}
326 #define lwsl_parser(...) {}
327 #define lwsl_header(...) {}
328 #define lwsl_ext(...) {}
329 #define lwsl_client(...) {}
330 #define lwsl_latency(...) {}
331 #define lwsl_hexdump(a, b)
332 
333 #endif
334 
345 LWS_VISIBLE LWS_EXTERN void
346 lws_set_log_level(int level,
347  void (*log_emit_function)(int level, const char *line));
348 
358 LWS_VISIBLE LWS_EXTERN void
359 lwsl_emit_syslog(int level, const char *line);
360 
362 
363 
364 #include <stddef.h>
365 
366 #ifndef lws_container_of
367 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
368 #endif
369 
370 
371 struct lws;
372 #ifndef ARRAY_SIZE
373 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
374 #endif
375 
376 /* api change list for user code to test against */
377 
378 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
379 
380 /* the struct lws_protocols has the id field present */
381 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
382 
383 /* you can call lws_get_peer_write_allowance */
384 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
385 
386 /* extra parameter introduced in 917f43ab821 */
387 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
388 
389 /* File operations stuff exists */
390 #define LWS_FEATURE_FOPS
391 
392 
393 #if defined(_WIN32)
394 typedef SOCKET lws_sockfd_type;
395 typedef HANDLE lws_filefd_type;
396 #define lws_sockfd_valid(sfd) (!!sfd)
397 struct lws_pollfd {
398  lws_sockfd_type fd;
399  SHORT events;
400  SHORT revents;
401 };
402 #else
403 
404 #if defined(MBED_OPERATORS)
405 /* it's a class lws_conn * */
406 typedef void * lws_sockfd_type;
407 typedef void * lws_filefd_type;
408 #define lws_sockfd_valid(sfd) (!!sfd)
409 struct pollfd {
410  lws_sockfd_type fd;
411  short events;
412  short revents;
413 };
414 #define POLLIN 0x0001
415 #define POLLPRI 0x0002
416 #define POLLOUT 0x0004
417 #define POLLERR 0x0008
418 #define POLLHUP 0x0010
419 #define POLLNVAL 0x0020
420 
421 struct lws;
422 
423 void * mbed3_create_tcp_stream_socket(void);
424 void mbed3_delete_tcp_stream_socket(void *sockfd);
425 void mbed3_tcp_stream_bind(void *sock, int port, struct lws *);
426 void mbed3_tcp_stream_accept(void *sock, struct lws *);
427 #else
428 typedef int lws_sockfd_type;
429 typedef int lws_filefd_type;
430 #define lws_sockfd_valid(sfd) (sfd >= 0)
431 #endif
432 
433 #define lws_pollfd pollfd
434 #endif
435 
438 struct lws_pollargs {
439  lws_sockfd_type fd;
440  int events;
442 };
443 
444 struct lws_tokens;
445 struct lws_token_limits;
446 
454 
456 /*
457  * NOTE: These public enums are part of the abi. If you want to add one,
458  * add it at where specified so existing users are unaffected.
459  */
462  LWS_CLOSE_STATUS_NOSTATUS = 0,
524  /****** add new things just above ---^ ******/
525 
526  LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
527 };
528 
541 LWS_VISIBLE LWS_EXTERN void
542 lws_close_reason(struct lws *wsi, enum lws_close_status status,
543  unsigned char *buf, size_t len);
544 
546 
547 struct lws;
548 struct lws_context;
549 /* needed even with extensions disabled for create context */
550 struct lws_extension;
551 
563 
565 
566 /*
567  * NOTE: These public enums are part of the abi. If you want to add one,
568  * add it at where specified so existing users are unaffected.
569  */
813  /* external poll() management support */
876  LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
879  LWS_CALLBACK_CGI = 40,
881  LWS_CALLBACK_CGI_TERMINATED = 41,
883  LWS_CALLBACK_CGI_STDIN_DATA = 42,
885  LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
887  LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
889  LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
891  LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
893  LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
895  LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
897  LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
899  LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
901  LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
903  LWS_CALLBACK_PROCESS_HTML = 52,
905  LWS_CALLBACK_ADD_HEADERS = 53,
907  LWS_CALLBACK_SESSION_INFO = 54,
910  LWS_CALLBACK_GS_EVENT = 55,
913  /****** add new things just above ---^ ******/
914 
917 };
918 
919 
920 
936 typedef int
937 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
938  void *user, void *in, size_t len);
940 
950 
952 /*
953  * NOTE: These public enums are part of the abi. If you want to add one,
954  * add it at where specified so existing users are unaffected.
955  */
956 enum lws_extension_callback_reasons {
957  LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
958  LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
959  LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
960  LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
961  LWS_EXT_CB_CONSTRUCT = 4,
962  LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
963  LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
964  LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
965  LWS_EXT_CB_DESTROY = 8,
966  LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
967  LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
968  LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
969  LWS_EXT_CB_PACKET_TX_PRESEND = 12,
970  LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
971  LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
972  LWS_EXT_CB_FLUSH_PENDING_TX = 15,
973  LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
974  LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
975  LWS_EXT_CB_1HZ = 18,
976  LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
977  LWS_EXT_CB_IS_WRITEABLE = 20,
978  LWS_EXT_CB_PAYLOAD_TX = 21,
979  LWS_EXT_CB_PAYLOAD_RX = 22,
980  LWS_EXT_CB_OPTION_DEFAULT = 23,
981  LWS_EXT_CB_OPTION_SET = 24,
982  LWS_EXT_CB_OPTION_CONFIRM = 25,
983  LWS_EXT_CB_NAMED_OPTION_SET = 26,
984 
985  /****** add new things just above ---^ ******/
986 };
987 
994  /* Add new things just above here ---^
995  * This is part of the ABI, don't needlessly break compatibility */
996 };
997 
1003  const char *name;
1006  /* Add new things just above here ---^
1007  * This is part of the ABI, don't needlessly break compatibility */
1008 };
1009 
1012  const char *option_name;
1014  const char *start;
1015  int len;
1016 };
1017 
1078 typedef int
1079 lws_extension_callback_function(struct lws_context *context,
1080  const struct lws_extension *ext, struct lws *wsi,
1081  enum lws_extension_callback_reasons reason,
1082  void *user, void *in, size_t len);
1083 
1086  const char *name;
1088  const char *client_offer;
1090  /* Add new things just above here ---^
1091  * This is part of the ABI, don't needlessly break compatibility */
1092 };
1093 
1102 LWS_VISIBLE LWS_EXTERN int
1103 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1104  const char *opt_name, const char *opt_val);
1105 
1106 #ifndef LWS_NO_EXTENSIONS
1107 /* lws_get_internal_extensions() - DEPRECATED
1108  *
1109  * \Deprecated There is no longer a set internal extensions table. The table is provided
1110  * by user code along with application-specific settings. See the test
1111  * client and server for how to do.
1112  */
1113 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1114 lws_get_internal_extensions() { return NULL; }
1115 
1126 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1127 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1128  void *ext_user, const struct lws_ext_options *opts,
1129  const char *o, int len);
1130 #endif
1131 
1144 LWS_EXTERN
1146  struct lws_context *context, const struct lws_extension *ext,
1147  struct lws *wsi, enum lws_extension_callback_reasons reason,
1148  void *user, void *in, size_t len);
1149 
1150 /*
1151  * The internal exts are part of the public abi
1152  * If we add more extensions, publish the callback here ------v
1153  */
1155 
1171 
1176  const char *name;
1197  unsigned int id;
1204  void *user;
1207  /* Add new things just above here ---^
1208  * This is part of the ABI, don't needlessly break compatibility */
1209 };
1210 
1211 struct lws_vhost;
1212 
1221 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1222 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1223 
1233 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1234 lws_get_protocol(struct lws *wsi);
1235 
1237 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1238 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1239 
1250 LWS_VISIBLE LWS_EXTERN void *
1251 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1252  int size);
1253 
1263 LWS_VISIBLE LWS_EXTERN void *
1264 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1265 
1274 LWS_VISIBLE LWS_EXTERN int
1275 lws_finalize_startup(struct lws_context *context);
1276 
1277 #ifdef LWS_WITH_PLUGINS
1278 
1279 /* PLUGINS implies LIBUV */
1280 
1281 #define LWS_PLUGIN_API_MAGIC 180
1282 
1285  unsigned int api_magic;
1286  const struct lws_protocols *protocols;
1288  const struct lws_extension *extensions;
1290 };
1291 
1292 typedef int (*lws_plugin_init_func)(struct lws_context *,
1293  struct lws_plugin_capability *);
1294 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1295 
1297 struct lws_plugin {
1298  struct lws_plugin *list;
1299 #if (UV_VERSION_MAJOR > 0)
1300  uv_lib_t lib;
1301 #else
1302  void *l;
1303 #endif
1304  char name[64];
1306 };
1307 
1308 #endif
1309 
1311 
1312 
1321 
1323 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1324 
1326 /* SHA-1 binary and hexified versions */
1328 typedef struct { unsigned char bin[20]; } lwsgw_hash_bin;
1330 typedef struct { char id[41]; } lwsgw_hash;
1331 
1338 };
1339 
1342  char username[32];
1343  char email[100];
1344  char ip[72];
1345  unsigned int mask;
1347  char session[42];
1348 };
1349 
1354 };
1355 
1358  enum lws_gs_event event;
1359  const char *username;
1360  const char *email;
1361 };
1362 
1364 
1365 
1379 
1381 /*
1382  * NOTE: These public enums are part of the abi. If you want to add one,
1383  * add it at where specified so existing users are unaffected.
1384  */
1385 
1389  (1 << 12),
1396  (1 << 12),
1412  (1 << 12),
1417  (1 << 3) |
1418  (1 << 12),
1436  /****** add new things just above ---^ ******/
1437 };
1438 
1439 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1440 
1451  int port;
1456  const char *iface;
1463  const struct lws_protocols *protocols;
1467  const struct lws_extension *extensions;
1475  const char *ssl_cert_filepath;
1485  const char *ssl_ca_filepath;
1487  const char *ssl_cipher_list;
1491  const char *http_proxy_address;
1494  unsigned int http_proxy_port;
1496  int gid;
1498  int uid;
1500  unsigned int options;
1502  void *user;
1505  int ka_time;
1515 #ifdef LWS_OPENSSL_SUPPORT
1521 #else /* maintain structure layout either way */
1523 #endif
1524 
1535  unsigned int count_threads;
1537  unsigned int fd_limit_per_thread;
1541  unsigned int timeout_secs;
1546  const char *ecdh_curve;
1548  const char *vhost_name;
1552  const char * const *plugin_dirs;
1561  const char *log_filepath;
1564  const struct lws_http_mount *mounts;
1566  const char *server_string;
1569  unsigned int pt_serv_buf_size;
1585  /* Add new things just above here ---^
1586  * This is part of the ABI, don't needlessly break compatibility
1587  *
1588  * The below is to ensure later library versions with new
1589  * members added above will see 0 (default) even if the app
1590  * was not built against the newer headers.
1591  */
1592 
1593  void *_unused[8];
1594 };
1595 
1630 LWS_VISIBLE LWS_EXTERN struct lws_context *
1632 
1641 LWS_VISIBLE LWS_EXTERN void
1642 lws_context_destroy(struct lws_context *context);
1643 
1661 LWS_VISIBLE LWS_EXTERN int
1662 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
1663 
1664 
1665 struct lws_vhost;
1666 
1676 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
1677 lws_create_vhost(struct lws_context *context,
1678  struct lws_context_creation_info *info);
1679 
1694 LWS_VISIBLE LWS_EXTERN int
1695 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
1696  char **config_strings, int *len);
1697 
1713 LWS_VISIBLE LWS_EXTERN int
1714 lwsws_get_config_vhosts(struct lws_context *context,
1715  struct lws_context_creation_info *info, const char *d,
1716  char **config_strings, int *len);
1717 
1719 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1720 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1721 
1727 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
1728 lws_get_vhost(struct lws *wsi);
1729 
1737 LWS_VISIBLE LWS_EXTERN int
1738 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
1739 
1747 LWS_VISIBLE LWS_EXTERN int
1748 lws_json_dump_context(const struct lws_context *context, char *buf, int len);
1749 
1759 LWS_VISIBLE LWS_EXTERN void *
1760 lws_context_user(struct lws_context *context);
1761 
1767 
1777  const char *name;
1778  const char *value;
1779 };
1780 
1793 };
1794 
1802  const char *mountpoint;
1804  const char *origin;
1806  const char *def;
1808  const char *protocol;
1824  unsigned int auth_mask;
1827  unsigned int cache_reusable:1;
1828  unsigned int cache_revalidate:1;
1829  unsigned int cache_intermediaries:1;
1831  unsigned char origin_protocol;
1832  unsigned char mountpoint_len;
1833 };
1836 
1842 
1848  struct lws_context *context;
1850  const char *address;
1852  int port;
1856  const char *path;
1858  const char *host;
1860  const char *origin;
1862  const char *protocol;
1866  void *userdata;
1870  const char *method;
1873  struct lws *parent_wsi;
1877  const char *uri_replace_from;
1880  const char *uri_replace_to;
1882  struct lws_vhost *vhost;
1884  struct lws **pwsi;
1896  /* Add new things just above here ---^
1897  * This is part of the ABI, don't needlessly break compatibility
1898  *
1899  * The below is to ensure later library versions with new
1900  * members added above will see 0 (default) even if the app
1901  * was not built against the newer headers.
1902  */
1903 
1904  void *_unused[4];
1905 };
1906 
1914 LWS_VISIBLE LWS_EXTERN struct lws *
1916 
1937 /* deprecated, use lws_client_connect_via_info() */
1938 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1939 lws_client_connect(struct lws_context *clients, const char *address,
1940  int port, int ssl_connection, const char *path,
1941  const char *host, const char *origin, const char *protocol,
1942  int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
1943 /* deprecated, use lws_client_connect_via_info() */
1964 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1965 lws_client_connect_extended(struct lws_context *clients, const char *address,
1966  int port, int ssl_connection, const char *path,
1967  const char *host, const char *origin,
1968  const char *protocol, int ietf_version_or_minus_one,
1969  void *userdata) LWS_WARN_DEPRECATED;
1970 
1996 LWS_VISIBLE LWS_EXTERN int
1998  struct lws_vhost *vhost);
1999 
2000 LWS_VISIBLE LWS_EXTERN int
2001 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2003 
2011 
2044 LWS_VISIBLE LWS_EXTERN int
2045 lws_service(struct lws_context *context, int timeout_ms);
2046 
2058 LWS_VISIBLE LWS_EXTERN int
2059 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2060 
2076 LWS_VISIBLE LWS_EXTERN void
2077 lws_cancel_service_pt(struct lws *wsi);
2078 
2090 LWS_VISIBLE LWS_EXTERN void
2091 lws_cancel_service(struct lws_context *context);
2092 
2115 LWS_VISIBLE LWS_EXTERN int
2116 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2117 
2127 LWS_VISIBLE LWS_EXTERN int
2128 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2129  int tsi);
2130 
2132 
2138 
2145 
2157 LWS_VISIBLE LWS_EXTERN const char *
2158 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2159 
2178 LWS_VISIBLE LWS_EXTERN int
2179 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2180  const char *other_headers, int other_headers_len);
2181 LWS_VISIBLE LWS_EXTERN int
2182 lws_serve_http_file_fragment(struct lws *wsi);
2184 
2195 
2196 enum http_status {
2197  HTTP_STATUS_OK = 200,
2198  HTTP_STATUS_NO_CONTENT = 204,
2199 
2200  HTTP_STATUS_MOVED_PERMANENTLY = 301,
2201  HTTP_STATUS_FOUND = 302,
2202  HTTP_STATUS_SEE_OTHER = 303,
2203 
2204  HTTP_STATUS_BAD_REQUEST = 400,
2205  HTTP_STATUS_UNAUTHORIZED,
2206  HTTP_STATUS_PAYMENT_REQUIRED,
2207  HTTP_STATUS_FORBIDDEN,
2208  HTTP_STATUS_NOT_FOUND,
2209  HTTP_STATUS_METHOD_NOT_ALLOWED,
2210  HTTP_STATUS_NOT_ACCEPTABLE,
2211  HTTP_STATUS_PROXY_AUTH_REQUIRED,
2212  HTTP_STATUS_REQUEST_TIMEOUT,
2213  HTTP_STATUS_CONFLICT,
2214  HTTP_STATUS_GONE,
2215  HTTP_STATUS_LENGTH_REQUIRED,
2216  HTTP_STATUS_PRECONDITION_FAILED,
2217  HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2218  HTTP_STATUS_REQ_URI_TOO_LONG,
2219  HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2220  HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2221  HTTP_STATUS_EXPECTATION_FAILED,
2222 
2223  HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2224  HTTP_STATUS_NOT_IMPLEMENTED,
2225  HTTP_STATUS_BAD_GATEWAY,
2226  HTTP_STATUS_SERVICE_UNAVAILABLE,
2227  HTTP_STATUS_GATEWAY_TIMEOUT,
2228  HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2229 };
2230 
2232  char *p;
2233  int len;
2234  int max_len;
2235  int final;
2236 };
2237 
2238 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2239 
2241  char *start;
2242  char swallow[16];
2243  int pos;
2244  void *data;
2245  const char * const *vars;
2248  lws_process_html_state_cb replace;
2249 };
2250 
2255 LWS_VISIBLE LWS_EXTERN int
2257  struct lws_process_html_state *s);
2259 
2292 
2300 struct lws_tokens {
2301  char *token;
2303 };
2304 
2305 /* enum lws_token_indexes
2306  * these have to be kept in sync with lextable.h / minilex.c
2307  *
2308  * NOTE: These public enums are part of the abi. If you want to add one,
2309  * add it at where specified so existing users are unaffected.
2310  */
2311 enum lws_token_indexes {
2312  WSI_TOKEN_GET_URI = 0,
2313  WSI_TOKEN_POST_URI = 1,
2314  WSI_TOKEN_OPTIONS_URI = 2,
2315  WSI_TOKEN_HOST = 3,
2316  WSI_TOKEN_CONNECTION = 4,
2317  WSI_TOKEN_UPGRADE = 5,
2318  WSI_TOKEN_ORIGIN = 6,
2319  WSI_TOKEN_DRAFT = 7,
2320  WSI_TOKEN_CHALLENGE = 8,
2321  WSI_TOKEN_EXTENSIONS = 9,
2322  WSI_TOKEN_KEY1 = 10,
2323  WSI_TOKEN_KEY2 = 11,
2324  WSI_TOKEN_PROTOCOL = 12,
2325  WSI_TOKEN_ACCEPT = 13,
2326  WSI_TOKEN_NONCE = 14,
2327  WSI_TOKEN_HTTP = 15,
2328  WSI_TOKEN_HTTP2_SETTINGS = 16,
2329  WSI_TOKEN_HTTP_ACCEPT = 17,
2330  WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2331  WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2332  WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2333  WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2334  WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2335  WSI_TOKEN_HTTP_PRAGMA = 23,
2336  WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2337  WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2338  WSI_TOKEN_HTTP_COOKIE = 26,
2339  WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2340  WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2341  WSI_TOKEN_HTTP_DATE = 29,
2342  WSI_TOKEN_HTTP_RANGE = 30,
2343  WSI_TOKEN_HTTP_REFERER = 31,
2344  WSI_TOKEN_KEY = 32,
2345  WSI_TOKEN_VERSION = 33,
2346  WSI_TOKEN_SWORIGIN = 34,
2347 
2348  WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2349  WSI_TOKEN_HTTP_COLON_METHOD = 36,
2350  WSI_TOKEN_HTTP_COLON_PATH = 37,
2351  WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2352  WSI_TOKEN_HTTP_COLON_STATUS = 39,
2353 
2354  WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2355  WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2356  WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2357  WSI_TOKEN_HTTP_AGE = 43,
2358  WSI_TOKEN_HTTP_ALLOW = 44,
2359  WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2360  WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2361  WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2362  WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2363  WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2364  WSI_TOKEN_HTTP_ETAG = 50,
2365  WSI_TOKEN_HTTP_EXPECT = 51,
2366  WSI_TOKEN_HTTP_EXPIRES = 52,
2367  WSI_TOKEN_HTTP_FROM = 53,
2368  WSI_TOKEN_HTTP_IF_MATCH = 54,
2369  WSI_TOKEN_HTTP_IF_RANGE = 55,
2370  WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2371  WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2372  WSI_TOKEN_HTTP_LINK = 58,
2373  WSI_TOKEN_HTTP_LOCATION = 59,
2374  WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2375  WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2376  WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2377  WSI_TOKEN_HTTP_REFRESH = 63,
2378  WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2379  WSI_TOKEN_HTTP_SERVER = 65,
2380  WSI_TOKEN_HTTP_SET_COOKIE = 66,
2381  WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2382  WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
2383  WSI_TOKEN_HTTP_USER_AGENT = 69,
2384  WSI_TOKEN_HTTP_VARY = 70,
2385  WSI_TOKEN_HTTP_VIA = 71,
2386  WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
2387 
2388  WSI_TOKEN_PATCH_URI = 73,
2389  WSI_TOKEN_PUT_URI = 74,
2390  WSI_TOKEN_DELETE_URI = 75,
2391 
2392  WSI_TOKEN_HTTP_URI_ARGS = 76,
2393  WSI_TOKEN_PROXY = 77,
2394  WSI_TOKEN_HTTP_X_REAL_IP = 78,
2395  WSI_TOKEN_HTTP1_0 = 79,
2396 
2397  /****** add new things just above ---^ ******/
2398 
2399  /* use token storage to stash these internally, not for
2400  * user use */
2401 
2402  _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
2403  _WSI_TOKEN_CLIENT_PEER_ADDRESS,
2404  _WSI_TOKEN_CLIENT_URI,
2405  _WSI_TOKEN_CLIENT_HOST,
2406  _WSI_TOKEN_CLIENT_ORIGIN,
2407  _WSI_TOKEN_CLIENT_METHOD,
2408 
2409  /* always last real token index*/
2410  WSI_TOKEN_COUNT,
2411 
2412  /* parser state additions, no storage associated */
2413  WSI_TOKEN_NAME_PART,
2414  WSI_TOKEN_SKIPPING,
2415  WSI_TOKEN_SKIPPING_SAW_CR,
2416  WSI_PARSING_COMPLETE,
2417  WSI_INIT_TOKEN_MUXURL,
2418 };
2419 
2421  unsigned short token_limit[WSI_TOKEN_COUNT];
2422 };
2423 
2429 LWS_VISIBLE LWS_EXTERN const unsigned char *
2430 lws_token_to_string(enum lws_token_indexes token);
2431 
2432 
2441 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2442 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
2443 
2453 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2454 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
2455 
2469 LWS_VISIBLE LWS_EXTERN int
2470 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
2471 
2489 LWS_VISIBLE LWS_EXTERN int
2490 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
2491  enum lws_token_indexes h, int frag_idx);
2492 
2503 LWS_VISIBLE LWS_EXTERN const char *
2504 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
2506 
2521 
2532 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2533 lws_add_http_header_status(struct lws *wsi,
2534  unsigned int code, unsigned char **p,
2535  unsigned char *end);
2548 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2549 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
2550  const unsigned char *value, int length,
2551  unsigned char **p, unsigned char *end);
2565 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2566 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
2567  const unsigned char *value, int length,
2568  unsigned char **p, unsigned char *end);
2579 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2580 lws_add_http_header_content_length(struct lws *wsi,
2581  unsigned long content_length,
2582  unsigned char **p, unsigned char *end);
2592 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2593 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
2594  unsigned char *end);
2596 
2615 
2625 };
2626 
2640 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
2641  const char *filename, char *buf, int len,
2642  enum lws_spa_fileupload_states state);
2643 
2646 struct lws_spa;
2647 
2666 LWS_VISIBLE LWS_EXTERN struct lws_spa *
2667 lws_spa_create(struct lws *wsi, const char * const *param_names,
2668  int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
2669  void *opt_data);
2670 
2678 LWS_VISIBLE LWS_EXTERN int
2679 lws_spa_process(struct lws_spa *spa, const char *in, int len);
2680 
2686 LWS_VISIBLE LWS_EXTERN int
2687 lws_spa_finalize(struct lws_spa *spa);
2688 
2695 LWS_VISIBLE LWS_EXTERN int
2696 lws_spa_get_length(struct lws_spa *spa, int n);
2697 
2703 LWS_VISIBLE LWS_EXTERN const char *
2704 lws_spa_get_string(struct lws_spa *spa, int n);
2705 
2711 LWS_VISIBLE LWS_EXTERN int
2712 lws_spa_destroy(struct lws_spa *spa);
2714 
2725 
2736 LWS_VISIBLE LWS_EXTERN const char *
2737 lws_urlencode(char *escaped, const char *string, int len);
2738 
2739 /*
2740  * URLDECODE 1 / 2
2741  *
2742  * This simple urldecode only operates until the first '\0' and requires the
2743  * data to exist all at once
2744  */
2757 LWS_VISIBLE LWS_EXTERN int
2758 lws_urldecode(char *string, const char *escaped, int len);
2760 
2769 LWS_VISIBLE LWS_EXTERN int
2770 lws_return_http_status(struct lws *wsi, unsigned int code,
2771  const char *html_body);
2772 
2783 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2784 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
2785  unsigned char **p, unsigned char *end);
2786 
2795 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2796 lws_http_transaction_completed(struct lws *wsi);
2798 
2806 
2817 LWS_VISIBLE LWS_EXTERN const char *
2818 lws_sql_purify(char *escaped, const char *string, int len);
2819 
2830 LWS_VISIBLE LWS_EXTERN const char *
2831 lws_json_purify(char *escaped, const char *string, int len);
2833 
2840 
2842 #ifdef LWS_USE_LIBEV
2843 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
2844 
2845 LWS_VISIBLE LWS_EXTERN int
2846 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
2847  lws_ev_signal_cb_t *cb);
2848 
2849 LWS_VISIBLE LWS_EXTERN int
2850 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
2851 
2852 LWS_VISIBLE LWS_EXTERN void
2853 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
2854 #endif /* LWS_USE_LIBEV */
2855 
2857 
2864 #ifdef LWS_USE_LIBUV
2866 LWS_VISIBLE LWS_EXTERN int
2867 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
2868  uv_signal_cb cb);
2869 
2870 LWS_VISIBLE LWS_EXTERN void
2871 lws_libuv_run(const struct lws_context *context, int tsi);
2872 
2873 LWS_VISIBLE LWS_EXTERN void
2874 lws_libuv_stop(struct lws_context *context);
2875 
2876 LWS_VISIBLE LWS_EXTERN int
2877 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
2878 
2879 LWS_VISIBLE LWS_EXTERN uv_loop_t *
2880 lws_uv_getloop(struct lws_context *context, int tsi);
2881 
2882 LWS_VISIBLE LWS_EXTERN void
2883 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
2884 #endif /* LWS_USE_LIBUV */
2885 
2892 
2893 /*
2894  * NOTE: These public enums are part of the abi. If you want to add one,
2895  * add it at where specified so existing users are unaffected.
2896  */
2897 enum pending_timeout {
2898  NO_PENDING_TIMEOUT = 0,
2899  PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
2900  PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
2901  PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
2902  PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
2903  PENDING_TIMEOUT_AWAITING_PING = 5,
2904  PENDING_TIMEOUT_CLOSE_ACK = 6,
2905  PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
2906  PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
2907  PENDING_TIMEOUT_SSL_ACCEPT = 9,
2908  PENDING_TIMEOUT_HTTP_CONTENT = 10,
2909  PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
2910  PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
2911  PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
2912  PENDING_TIMEOUT_CGI = 14,
2913  PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
2914 
2915  /****** add new things just above ---^ ******/
2916 };
2917 
2927 LWS_VISIBLE LWS_EXTERN void
2928 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
2930 
2936 #if !defined(LWS_SIZEOFPTR)
2937 #define LWS_SIZEOFPTR (sizeof (void *))
2938 #endif
2939 #if !defined(u_int64_t)
2940 #define u_int64_t unsigned long long
2941 #endif
2942 
2943 #if defined(__x86_64__)
2944 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
2945 #else
2946 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
2947 #endif
2948 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
2949  ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
2950 #define LWS_PRE _LWS_PAD(4 + 10)
2951 /* used prior to 1.7 and retained for backward compatibility */
2952 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
2953 #define LWS_SEND_BUFFER_POST_PADDING 0
2954 
2955 /*
2956  * NOTE: These public enums are part of the abi. If you want to add one,
2957  * add it at where specified so existing users are unaffected.
2958  */
2973  /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
2974  LWS_WRITE_PING = 5,
2975  LWS_WRITE_PONG = 6,
2976 
2977  /* Same as write_http but we know this write ends the transaction */
2978  LWS_WRITE_HTTP_FINAL = 7,
2979 
2980  /* HTTP2 */
2981 
2989  /****** add new things just above ---^ ******/
2990 
2991  /* flags */
2992 
3000 };
3001 
3002 
3074 LWS_VISIBLE LWS_EXTERN int
3075 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3076  enum lws_write_protocol protocol);
3077 
3078 /* helper for case where buffer may be const */
3079 #define lws_write_http(wsi, buf, len) \
3080  lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3081 
3083 
3102 
3115 LWS_VISIBLE LWS_EXTERN int
3116 lws_callback_on_writable(struct lws *wsi);
3117 
3131 LWS_VISIBLE LWS_EXTERN int
3132 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3133  const struct lws_protocols *protocol);
3134 
3148 LWS_VISIBLE LWS_EXTERN int
3149 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3150  const struct lws_protocols *protocol);
3151 
3164 LWS_VISIBLE LWS_EXTERN int
3165 lws_callback_all_protocol(struct lws_context *context,
3166  const struct lws_protocols *protocol, int reason);
3167 
3180 LWS_VISIBLE LWS_EXTERN int
3181 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3182  const struct lws_protocols *protocol, int reason);
3183 
3197 LWS_VISIBLE LWS_EXTERN int
3198 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3199 
3207 LWS_VISIBLE LWS_EXTERN int
3208 lws_get_socket_fd(struct lws *wsi);
3209 
3231 LWS_VISIBLE LWS_EXTERN size_t
3232 lws_get_peer_write_allowance(struct lws *wsi);
3234 
3245 LWS_VISIBLE LWS_EXTERN int
3246 lws_rx_flow_control(struct lws *wsi, int enable);
3247 
3257 LWS_VISIBLE LWS_EXTERN void
3258 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3259  const struct lws_protocols *protocol);
3260 
3277 LWS_VISIBLE LWS_EXTERN size_t
3278 lws_remaining_packet_payload(struct lws *wsi);
3279 
3280 
3289 
3302 LWS_VISIBLE LWS_EXTERN struct lws *
3303 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3326 LWS_VISIBLE LWS_EXTERN struct lws *
3327 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
3328  const char *readbuf, size_t len);
3330 
3336 
3347 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3348 lws_canonical_hostname(struct lws_context *context);
3349 
3364 LWS_VISIBLE LWS_EXTERN void
3365 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
3366  int name_len, char *rip, int rip_len);
3367 
3378 LWS_VISIBLE LWS_EXTERN const char *
3379 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
3380 
3392 LWS_VISIBLE LWS_EXTERN int
3393 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
3394  size_t addrlen);
3396 
3402 
3415 LWS_VISIBLE LWS_EXTERN int
3416 lws_get_random(struct lws_context *context, void *buf, int len);
3424 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3425 lws_daemonize(const char *_lock_path);
3431 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3433 
3440 LWS_VISIBLE LWS_EXTERN void *
3441 lws_wsi_user(struct lws *wsi);
3442 
3454 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3455 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
3456  const char **path);
3457 
3461 LWS_VISIBLE LWS_EXTERN unsigned long
3462 lws_now_secs(void);
3463 
3473 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
3474 lws_get_context(const struct lws *wsi);
3475 
3485 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3486 lws_get_count_threads(struct lws_context *context);
3487 
3495 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3496 lws_get_parent(const struct lws *wsi);
3497 
3504 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
3505 lws_get_child(const struct lws *wsi);
3506 
3507 
3508 /*
3509  * \deprecated DEPRECATED Note: this is not normally needed as a user api.
3510  * It's provided in case it is
3511  * useful when integrating with other app poll loop service code.
3512  */
3513 LWS_VISIBLE LWS_EXTERN int
3514 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
3515 
3523 LWS_VISIBLE LWS_EXTERN void
3524 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
3526 
3532 
3539 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3540 lws_send_pipe_choked(struct lws *wsi);
3541 
3546 LWS_VISIBLE LWS_EXTERN int
3547 lws_is_final_fragment(struct lws *wsi);
3548 
3553 LWS_VISIBLE LWS_EXTERN unsigned char
3554 lws_get_reserved_bits(struct lws *wsi);
3555 
3572 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3573 lws_partial_buffered(struct lws *wsi);
3574 
3584 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3585 lws_frame_is_binary(struct lws *wsi);
3586 
3595 LWS_VISIBLE LWS_EXTERN int
3596 lws_is_ssl(struct lws *wsi);
3601 LWS_VISIBLE LWS_EXTERN int
3602 lws_is_cgi(struct lws *wsi);
3604 
3605 
3611 #ifdef LWS_SHA1_USE_OPENSSL_NAME
3613 #define lws_SHA1 SHA1
3614 #else
3615 
3624 LWS_VISIBLE LWS_EXTERN unsigned char *
3625 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
3626 #endif
3627 
3637 LWS_VISIBLE LWS_EXTERN int
3638 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
3648 LWS_VISIBLE LWS_EXTERN int
3649 lws_b64_decode_string(const char *in, char *out, int out_size);
3651 
3652 
3662 #ifdef LWS_WITH_CGI
3663 enum lws_enum_stdinouterr {
3664  LWS_STDIN = 0,
3665  LWS_STDOUT = 1,
3666  LWS_STDERR = 2,
3667 };
3668 
3669 enum lws_cgi_hdr_state {
3670  LCHS_HEADER,
3671  LCHS_CR1,
3672  LCHS_LF1,
3673  LCHS_CR2,
3674  LCHS_LF2,
3675  LHCS_PAYLOAD,
3676  LCHS_SINGLE_0A,
3677 };
3678 
3680  struct lws **stdwsi;
3681  enum lws_enum_stdinouterr ch;
3682  unsigned char *data;
3683  enum lws_cgi_hdr_state hdr_state;
3684  int len;
3685 };
3686 
3687 
3697 LWS_VISIBLE LWS_EXTERN int
3698 lws_cgi(struct lws *wsi, const char * const *exec_array,
3699  int script_uri_path_len, int timeout_secs,
3700  const struct lws_protocol_vhost_options *mp_cgienv);
3701 
3707 LWS_VISIBLE LWS_EXTERN int
3708 lws_cgi_write_split_stdout_headers(struct lws *wsi);
3709 
3715 LWS_VISIBLE LWS_EXTERN int
3716 lws_cgi_kill(struct lws *wsi);
3717 #endif
3718 
3720 
3737 
3744  lws_filefd_type (*open)(struct lws *wsi, const char *filename,
3745  unsigned long *filelen, int flags);
3749  int (*close)(struct lws *wsi, lws_filefd_type fd);
3751  unsigned long (*seek_cur)(struct lws *wsi, lws_filefd_type fd,
3752  long offset_from_cur_pos);
3754  int (*read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
3755  unsigned char *buf, unsigned long len);
3757  int (*write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
3758  unsigned char *buf, unsigned long len);
3761  /* Add new things just above here ---^
3762  * This is part of the ABI, don't needlessly break compatibility */
3763 };
3764 
3770 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
3771 lws_get_fops(struct lws_context *context);
3772 
3781 static LWS_INLINE lws_filefd_type LWS_WARN_UNUSED_RESULT
3782 lws_plat_file_open(struct lws *wsi, const char *filename,
3783  unsigned long *filelen, int flags)
3784 {
3785  return lws_get_fops(lws_get_context(wsi))->open(wsi, filename,
3786  filelen, flags);
3787 }
3788 
3795 static LWS_INLINE int
3796 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
3797 {
3798  return lws_get_fops(lws_get_context(wsi))->close(wsi, fd);
3799 }
3800 
3808 static LWS_INLINE unsigned long
3809 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
3810 {
3811  return lws_get_fops(lws_get_context(wsi))->seek_cur(wsi, fd, offset);
3812 }
3822 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
3823 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
3824  unsigned char *buf, unsigned long len)
3825 {
3826  return lws_get_fops(lws_get_context(wsi))->read(wsi, fd, amount, buf,
3827  len);
3828 }
3838 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
3839 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
3840  unsigned char *buf, unsigned long len)
3841 {
3842  return lws_get_fops(lws_get_context(wsi))->write(wsi, fd, amount, buf,
3843  len);
3844 }
3846 
3878 #ifdef LWS_WITH_SMTP
3879 
3891 };
3892 
3894 struct lws_email {
3895  void *data;
3897  uv_loop_t *loop;
3900  char email_smtp_ip[32];
3901  char email_helo[32];
3902  char email_from[100];
3903  char email_to[100];
3905  unsigned int max_content_size;
3908  /* Fill all the callbacks before init */
3909 
3910  int (*on_next)(struct lws_email *email);
3915  int (*on_sent)(struct lws_email *email);
3920  int (*on_get_body)(struct lws_email *email, char *buf, int len);
3926  /* private things */
3927  uv_timer_t timeout_email;
3929  uv_connect_t email_connect_req;
3930  uv_tcp_t email_client;
3932  char email_buf[256];
3933  char *content;
3934 };
3935 
3945 LWS_VISIBLE LWS_EXTERN int
3946 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
3947 
3956 LWS_VISIBLE LWS_EXTERN void
3957 lws_email_check(struct lws_email *email);
3965 LWS_VISIBLE LWS_EXTERN void
3966 lws_email_destroy(struct lws_email *email);
3967 
3968 #endif
3969 
3970 
3971 #ifdef __cplusplus
3972 }
3973 #endif
3974 
3975 #endif
LWS_VISIBLE LWS_EXTERN int lws_spa_destroy(struct lws_spa *spa)
LWS_VISIBLE LWS_EXTERN const char * lws_json_purify(char *escaped, const char *string, int len)
Definition: libwebsockets.h:3679
size_t rx_buffer_size
Definition: libwebsockets.h:1188
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_VISIBLE LWS_EXTERN struct lws_vhost * lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED
Definition: libwebsockets.h:678
Definition: libwebsockets.h:806
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_daemonize(const char *_lock_path)
Definition: libwebsockets.h:1789
Definition: libwebsockets.h:2970
Definition: libwebsockets.h:3884
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)
Definition: libwebsockets.h:234
unsigned int auth_mask
Definition: libwebsockets.h:1824
Definition: libwebsockets.h:2993
void * data
Definition: libwebsockets.h:3895
const char * uri_replace_from
Definition: libwebsockets.h:1877
int(* write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:3757
lws_callback_reasons
Definition: libwebsockets.h:571
LWS_VISIBLE LWS_EXTERN int lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len, enum lws_token_indexes h, int frag_idx)
lwsgs_auth_bits
Definition: libwebsockets.h:1333
LWS_VISIBLE LWS_EXTERN void lws_close_reason(struct lws *wsi, enum lws_close_status status, unsigned char *buf, size_t len)
LWS_VISIBLE LWS_EXTERN void lws_email_destroy(struct lws_email *email)
LWS_VISIBLE LWS_EXTERN int lws_urldecode(char *string, const char *escaped, int len)
Definition: libwebsockets.h:804
Definition: libwebsockets.h:992
unsigned int id
Definition: libwebsockets.h:1197
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h)
Definition: libwebsockets.h:990
Definition: libwebsockets.h:709
LWS_VISIBLE LWS_EXTERN int lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd, int tsi)
LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT lws_get_parent(const struct lws *wsi)
LWS_VISIBLE LWS_EXTERN size_t lws_get_peer_write_allowance(struct lws *wsi)
Definition: libwebsockets.h:655
LWS_VISIBLE LWS_EXTERN const char *LWS_WARN_UNUSED_RESULT lws_get_library_version(void)
int(* on_sent)(struct lws_email *email)
Definition: libwebsockets.h:3915
Definition: libwebsockets.h:1328
struct lws ** pwsi
Definition: libwebsockets.h:1884
Definition: libwebsockets.h:689
const char * path
Definition: libwebsockets.h:1856
LWS_VISIBLE LWS_EXTERN size_t lws_remaining_packet_payload(struct lws *wsi)
Definition: libwebsockets.h:490
Definition: libwebsockets.h:1284
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)
time_t email_connect_started
Definition: libwebsockets.h:3931
lws_close_status
Definition: libwebsockets.h:461
LWS_VISIBLE LWS_EXTERN int lws_callback_all_protocol(struct lws_context *context, const struct lws_protocols *protocol, int reason)
Definition: libwebsockets.h:501
int token_len
Definition: libwebsockets.h:2302
const struct lws_http_mount * mounts
Definition: libwebsockets.h:1564
Definition: libwebsockets.h:830
LWS_VISIBLE LWS_EXTERN struct lws_context *LWS_WARN_UNUSED_RESULT lws_get_context(const struct lws *wsi)
const char * value
Definition: libwebsockets.h:1778
Definition: libwebsockets.h:2621
Definition: libwebsockets.h:3889
const char * username
Definition: libwebsockets.h:1359
LWS_VISIBLE LWS_EXTERN struct lws * lws_client_connect_via_info(struct lws_client_connect_info *ccinfo)
const char * protocol
Definition: libwebsockets.h:1808
struct lws ** stdwsi
Definition: libwebsockets.h:3680
LWS_VISIBLE LWS_EXTERN int lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len)
Definition: libwebsockets.h:776
LWS_VISIBLE LWS_EXTERN const char * lws_get_mimetype(const char *file, const struct lws_http_mount *m)
Definition: libwebsockets.h:1330
int cache_max_age
Definition: libwebsockets.h:1822
long ssl_options_clear
Definition: libwebsockets.h:1582
Definition: libwebsockets.h:669
Definition: libwebsockets.h:1450
LWS_VISIBLE LWS_EXTERN void lws_context_destroy(struct lws_context *context)
Definition: libwebsockets.h:517
char * start
Definition: libwebsockets.h:2241
LWS_VISIBLE LWS_EXTERN void lws_set_allocator(void *(*realloc)(void *ptr, size_t size))
lws_callback_function * callback
Definition: libwebsockets.h:1179
Definition: libwebsockets.h:2960
LWS_VISIBLE LWS_EXTERN int lws_get_socket_fd(struct lws *wsi)
Definition: libwebsockets.h:867
const char * protocol
Definition: libwebsockets.h:1862
Definition: libwebsockets.h:856
unsigned int pt_serv_buf_size
Definition: libwebsockets.h:1569
LWS_VISIBLE LWS_EXTERN struct lws * lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
int len
Definition: libwebsockets.h:2233
int ka_time
Definition: libwebsockets.h:1505
Definition: libwebsockets.h:1404
LWS_VISIBLE LWS_EXTERN int lws_callback_on_writable_all_protocol(const struct lws_context *context, const struct lws_protocols *protocol)
LWS_VISIBLE LWS_EXTERN void lws_set_log_level(int level, void(*log_emit_function)(int level, const char *line))
int count_extensions
Definition: libwebsockets.h:1289
Definition: libwebsockets.h:2964
int port
Definition: libwebsockets.h:1852
struct lws_context * context
Definition: libwebsockets.h:1848
Definition: libwebsockets.h:1336
int ietf_version_or_minus_one
Definition: libwebsockets.h:1864
LWS_VISIBLE LWS_EXTERN int lws_callback_all_protocol_vhost(struct lws_vhost *vh, const struct lws_protocols *protocol, int reason)
Definition: libwebsockets.h:3882
Definition: libwebsockets.h:1774
LWS_VISIBLE LWS_EXTERN int lws_callback_on_writable(struct lws *wsi)
const char *const * vars
Definition: libwebsockets.h:2245
Definition: libwebsockets.h:469
Definition: libwebsockets.h:1847
int lws_extension_callback_function(struct lws_context *context, const struct lws_extension *ext, struct lws *wsi, enum lws_extension_callback_reasons reason, void *user, void *in, size_t len)
Definition: libwebsockets.h:1079
int len
Definition: libwebsockets.h:1015
Definition: libwebsockets.h:1799
const char * def
Definition: libwebsockets.h:1806
Definition: libwebsockets.h:630
Definition: libwebsockets.h:1416
lws_context_options
Definition: libwebsockets.h:1387
Definition: libwebsockets.h:808
Definition: libwebsockets.h:1353
Definition: libwebsockets.h:1423
Definition: libwebsockets.h:796
const char * option_name
Definition: libwebsockets.h:1012
Definition: libwebsockets.h:1787
lws_sockfd_type fd
Definition: libwebsockets.h:439
const char * ssl_private_key_password
Definition: libwebsockets.h:1473
short events
Definition: libwebsockets.h:411
Definition: libwebsockets.h:1297
const struct lws_extension * extensions
Definition: libwebsockets.h:1288
LWS_VISIBLE LWS_EXTERN void lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs)
void * userdata
Definition: libwebsockets.h:1866
Definition: libwebsockets.h:627
Definition: libwebsockets.h:814
LWS_VISIBLE LWS_EXTERN int lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi)
unsigned char * data
Definition: libwebsockets.h:3682
const struct lws_protocol_vhost_options * extra_mimetypes
Definition: libwebsockets.h:1815
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_finalize_http_header(struct lws *wsi, unsigned char **p, unsigned char *end)
Definition: libwebsockets.h:620
LWS_VISIBLE LWS_EXTERN const char * lws_urlencode(char *escaped, const char *string, int len)
Definition: libwebsockets.h:701
uv_loop_t * loop
Definition: libwebsockets.h:3897
Definition: libwebsockets.h:799
Definition: libwebsockets.h:72
Definition: libwebsockets.h:2996
int pos
Definition: libwebsockets.h:2243
struct lws_plugin * list
Definition: libwebsockets.h:1298
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
short max_http_header_data
Definition: libwebsockets.h:1525
LWS_VISIBLE LWS_EXTERN int lws_spa_process(struct lws_spa *spa, const char *in, int len)
void * provided_client_ssl_ctx
Definition: libwebsockets.h:1522
LWS_VISIBLE LWS_EXTERN struct lws_vhost * lws_get_vhost(struct lws *wsi)
Definition: libwebsockets.h:44
LWS_VISIBLE LWS_EXTERN void lwsl_emit_syslog(int level, const char *line)
const struct lws_protocols * protocols
Definition: libwebsockets.h:1286
Definition: libwebsockets.h:991
int ka_probes
Definition: libwebsockets.h:1508
void onError(Socket *s, socket_error_t err)
const char * origin
Definition: libwebsockets.h:1860
SHORT revents
Definition: libwebsockets.h:400
const char * method
Definition: libwebsockets.h:1870
LWS_VISIBLE LWS_EXTERN const char * lws_spa_get_string(struct lws_spa *spa, int n)
Definition: libwebsockets.h:1085
LWS_VISIBLE LWS_EXTERN int lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost, const struct lws_protocols *protocol)
Definition: libwebsockets.h:836
const struct lws_extension * client_exts
Definition: libwebsockets.h:1868
unsigned char origin_protocol
Definition: libwebsockets.h:1831
const char * log_filepath
Definition: libwebsockets.h:1561
Definition: libwebsockets.h:676
unsigned int max_content_size
Definition: libwebsockets.h:3905
int option_index
Definition: libwebsockets.h:1013
LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT lws_get_child(const struct lws *wsi)
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)
Definition: libwebsockets.h:672
const char * uri_replace_to
Definition: libwebsockets.h:1880
struct lws * parent_wsi
Definition: libwebsockets.h:1873
LWS_VISIBLE LWS_EXTERN int lws_b64_decode_string(const char *in, char *out, int out_size)
enum lwsgs_smtp_states estate
Definition: libwebsockets.h:3928
LWS_VISIBLE LWS_EXTERN int lws_spa_finalize(struct lws_spa *spa)
Definition: libwebsockets.h:572
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_get_count_threads(struct lws_context *context)
const char *const * plugin_dirs
Definition: libwebsockets.h:1552
char name[64]
Definition: libwebsockets.h:1304
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_VISIBLE LWS_EXTERN int lws_cgi_kill(struct lws *wsi)
char email_buf[256]
Definition: libwebsockets.h:3932
LWS_VISIBLE LWS_EXTERN int lws_is_ssl(struct lws *wsi)
Definition: libwebsockets.h:1393
int(* close)(struct lws *wsi, lws_filefd_type fd)
Definition: libwebsockets.h:3749
uv_lib_t lib
Definition: libwebsockets.h:1300
x509_crt certificate
Definition: libwebsockets.h:236
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)
Definition: libwebsockets.h:3883
LWS_VISIBLE LWS_EXTERN int lws_is_cgi(struct lws *wsi)
int ssl_connection
Definition: libwebsockets.h:1854
Definition: libwebsockets.h:1352
SSL_CTX * provided_client_ssl_ctx
Definition: libwebsockets.h:1516
LWS_VISIBLE LWS_EXTERN int lws_rx_flow_control(struct lws *wsi, int enable)
Definition: libwebsockets.h:2231
LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops *LWS_WARN_UNUSED_RESULT lws_get_fops(struct lws_context *context)
Definition: libwebsockets.h:438
const struct lws_protocol_vhost_options * cgienv
Definition: libwebsockets.h:1811
const char * name
Definition: libwebsockets.h:1777
unsigned char mountpoint_len
Definition: libwebsockets.h:1832
Definition: libwebsockets.h:2967
Definition: libwebsockets.h:1411
lws_sockfd_type fd
Definition: libwebsockets.h:398
Definition: libwebsockets.h:1788
LWS_VISIBLE LWS_EXTERN int lws_is_final_fragment(struct lws *wsi)
const struct lws_extension * extensions
Definition: libwebsockets.h:1467
Definition: libwebsockets.h:1395
LWS_VISIBLE LWS_EXTERN void * lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot, int size)
Definition: libwebsockets.h:1400
lws_ext_options_types
Definition: libwebsockets.h:989
const struct lws_protocols * protocols
Definition: libwebsockets.h:1463
LWS_VISIBLE LWS_EXTERN int lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d, char **config_strings, int *len)
LWS_VISIBLE LWS_EXTERN void * lws_wsi_user(struct lws *wsi)
LWS_VISIBLE LWS_EXTERN unsigned long lws_now_secs(void)
LWS_VISIBLE LWS_EXTERN const char * lws_get_peer_simple(struct lws *wsi, char *name, int namelen)
const char * start
Definition: libwebsockets.h:1014
const char * ssl_cipher_list
Definition: libwebsockets.h:1487
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name, const unsigned char *value, int length, unsigned char **p, unsigned char *end)
const char * mountpoint
Definition: libwebsockets.h:1802
const char * http_proxy_address
Definition: libwebsockets.h:1491
rsa_context key
Definition: libwebsockets.h:237
const char * ssl_cert_filepath
Definition: libwebsockets.h:1475
const char * ecdh_curve
Definition: libwebsockets.h:1546
int cgi_timeout
Definition: libwebsockets.h:1820
Definition: libwebsockets.h:1790
Definition: libwebsockets.h:1337
Definition: libwebsockets.h:409
Definition: libwebsockets.h:495
LWS_VISIBLE LWS_EXTERN unsigned char lws_get_reserved_bits(struct lws *wsi)
LWS_VISIBLE LWS_EXTERN unsigned char * lws_SHA1(const unsigned char *d, size_t n, unsigned char *md)
LWS_VISIBLE LWS_EXTERN const unsigned char * lws_token_to_string(enum lws_token_indexes token)
LWS_VISIBLE LWS_EXTERN int lws_set_extension_option(struct lws *wsi, const char *ext_name, const char *opt_name, const char *opt_val)
Definition: libwebsockets.h:640
LWS_VISIBLE LWS_EXTERN int lws_cgi(struct lws *wsi, const char *const *exec_array, int script_uri_path_len, int timeout_secs, const struct lws_protocol_vhost_options *mp_cgienv)
LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT lws_client_connect(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) LWS_WARN_DEPRECATED
Definition: libwebsockets.h:674
LWS_VISIBLE LWS_EXTERN int lwsws_get_config_vhosts(struct lws_context *context, struct lws_context_creation_info *info, const char *d, char **config_strings, int *len)
Definition: libwebsockets.h:1421
LWS_VISIBLE LWS_EXTERN int lwsl_timestamp(int level, char *p, int len)
Definition: libwebsockets.h:1433
uv_timer_t timeout_email
Definition: libwebsockets.h:3927
Definition: libwebsockets.h:1402
short max_http_header_pool
Definition: libwebsockets.h:1528
LWS_VISIBLE LWS_EXTERN int lws_chunked_html_process(struct lws_process_html_args *args, struct lws_process_html_state *s)
char * p
Definition: libwebsockets.h:2232
x509_crt ca
Definition: libwebsockets.h:235
size_t per_session_data_size
Definition: libwebsockets.h:1183
Definition: libwebsockets.h:479
lwsgs_smtp_states
Definition: libwebsockets.h:3881
Definition: libwebsockets.h:1414
Definition: libwebsockets.h:752
Definition: libwebsockets.h:638
Definition: libwebsockets.h:1175
Definition: libwebsockets.h:484
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len, unsigned char **p, unsigned char *end)
unsigned int count_threads
Definition: libwebsockets.h:1535
const char * email
Definition: libwebsockets.h:1360
LWS_VISIBLE LWS_EXTERN int lws_get_random(struct lws_context *context, void *buf, int len)
Definition: libwebsockets.h:466
uv_connect_t email_connect_req
Definition: libwebsockets.h:3929
const char * server_string
Definition: libwebsockets.h:1566
Definition: libwebsockets.h:1426
SHORT events
Definition: libwebsockets.h:399
Definition: libwebsockets.h:643
Definition: libwebsockets.h:1409
const char * vhost_name
Definition: libwebsockets.h:1548
Definition: libwebsockets.h:1791
LWS_VISIBLE LWS_EXTERN const struct lws_protocols * lws_get_protocol(struct lws *wsi)
Definition: libwebsockets.h:1335
Definition: libwebsockets.h:1357
unsigned int fd_limit_per_thread
Definition: libwebsockets.h:1537
LWS_VISIBLE LWS_EXTERN int lws_cgi_write_split_stdout_headers(struct lws *wsi)
lws_gs_event
Definition: libwebsockets.h:1351
LWS_VISIBLE LWS_EXTERN int lws_finalize_startup(struct lws_context *context)
int ka_interval
Definition: libwebsockets.h:1512
Definition: libwebsockets.h:1334
int uid
Definition: libwebsockets.h:1498
Definition: libwebsockets.h:2623
LWS_VISIBLE LWS_EXTERN int lws_b64_encode_string(const char *in, int in_len, char *out, int out_size)
LWS_VISIBLE LWS_EXTERN void * lws_context_user(struct lws_context *context)
const char * name
Definition: libwebsockets.h:1176
LWS_VISIBLE LWS_EXTERN int lws_init_vhost_client_ssl(const struct lws_context_creation_info *info, struct lws_vhost *vhost)
Definition: libwebsockets.h:3887
unsigned int http_proxy_port
Definition: libwebsockets.h:1494
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_partial_buffered(struct lws *wsi)
unsigned int timeout_secs
Definition: libwebsockets.h:1541
int port
Definition: libwebsockets.h:1451
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_parse_uri(char *p, const char **prot, const char **ads, int *port, const char **path)
unsigned int options
Definition: libwebsockets.h:1500
LWS_VISIBLE LWS_EXTERN int lws_spa_get_length(struct lws_spa *spa, int n)
const struct lws_protocol_vhost_options * options
Definition: libwebsockets.h:1776
int prev_events
Definition: libwebsockets.h:441
int keepalive_timeout
Definition: libwebsockets.h:1558
Definition: libwebsockets.h:1341
Definition: libwebsockets.h:1002
Definition: libwebsockets.h:2420
LWS_VISIBLE LWS_EXTERN int lws_write(struct lws *wsi, unsigned char *buf, size_t len, enum lws_write_protocol protocol)
const struct lws_protocol_vhost_options * pvo
Definition: libwebsockets.h:1555
const char * host
Definition: libwebsockets.h:1858
Definition: libwebsockets.h:1011
Definition: libwebsockets.h:505
LWS_VISIBLE LWS_EXTERN const struct lws_protocols * lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name)
int len
Definition: libwebsockets.h:3684
struct lws_http_mount * mount_next
Definition: libwebsockets.h:1800
LWS_VISIBLE LWS_EXTERN const char * lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len)
const char * iface
Definition: libwebsockets.h:1456
Definition: libwebsockets.h:3743
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len)
lws_spa_fileupload_states
Definition: libwebsockets.h:2618
LWS_VISIBLE LWS_EXTERN int lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd)
LWS_VISIBLE LWS_EXTERN int lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len)
Definition: libwebsockets.h:463
Definition: libwebsockets.h:472
LWS_VISIBLE LWS_EXTERN const char * lws_sql_purify(char *escaped, const char *string, int len)
uv_tcp_t email_client
Definition: libwebsockets.h:3930
LWS_VISIBLE LWS_EXTERN int lws_json_dump_context(const struct lws_context *context, char *buf, int len)
Definition: libwebsockets.h:397
Definition: libwebsockets.h:576
lws_filefd_type(* open)(struct lws *wsi, const char *filename, unsigned long *filelen, int flags)
Definition: libwebsockets.h:3744
lws_write_protocol
Definition: libwebsockets.h:2959
const char * client_offer
Definition: libwebsockets.h:1088
int(* read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)
Definition: libwebsockets.h:3754
LWS_VISIBLE LWS_EXTERN void lws_cancel_service(struct lws_context *context)
Definition: libwebsockets.h:2619
Definition: libwebsockets.h:477
const char * origin
Definition: libwebsockets.h:1804
const char * name
Definition: libwebsockets.h:1003
LWS_VISIBLE LWS_EXTERN int lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type, const char *other_headers, int other_headers_len)
LWS_VISIBLE LWS_EXTERN void lws_email_check(struct lws_email *email)
LWS_VISIBLE LWS_EXTERN int lws_set_proxy(struct lws_vhost *vhost, const char *proxy)
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_frame_is_binary(struct lws *wsi)
LWS_VISIBLE LWS_EXTERN int lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h)
Definition: libwebsockets.h:653
const char * name
Definition: libwebsockets.h:1086
Definition: libwebsockets.h:3886
short revents
Definition: libwebsockets.h:412
lws_extension_callback_function * callback
Definition: libwebsockets.h:1087
long ssl_options_set
Definition: libwebsockets.h:1580
Definition: libwebsockets.h:915
LWS_VISIBLE LWS_EXTERN const struct lws_protocols * lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED
unsigned int mask
Definition: libwebsockets.h:1345
LWS_VISIBLE LWS_EXTERN int lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content)
lws_mount_protocols
Definition: libwebsockets.h:1785
LWS_EXTERN int lws_extension_callback_pm_deflate(struct lws_context *context, const struct lws_extension *ext, struct lws *wsi, enum lws_extension_callback_reasons reason, void *user, void *in, size_t len)
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_add_http_header_content_length(struct lws *wsi, unsigned long content_length, unsigned char **p, unsigned char *end)
lws_sockfd_type fd
Definition: libwebsockets.h:410
unsigned int max_http_header_data2
Definition: libwebsockets.h:1575
Definition: libwebsockets.h:1786
LWS_VISIBLE LWS_EXTERN int lws_return_http_status(struct lws *wsi, unsigned int code, const char *html_body)
LWS_EXTERN LWS_VISIBLE struct lws_vhost * lws_create_vhost(struct lws_context *context, struct lws_context_creation_info *info)
const struct lws_protocol_vhost_options * interpret
Definition: libwebsockets.h:1817
LWS_VISIBLE LWS_EXTERN int lws_service(struct lws_context *context, int timeout_ms)
Definition: libwebsockets.h:1407
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_http_transaction_completed(struct lws *wsi)
int count_vars
Definition: libwebsockets.h:2246
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)
Definition: libwebsockets.h:2300
LWS_VISIBLE LWS_EXTERN struct lws_context * lws_create_context(struct lws_context_creation_info *info)
Definition: libwebsockets.h:632
void * data
Definition: libwebsockets.h:2244
char * content
Definition: libwebsockets.h:3933
LWS_VISIBLE LWS_EXTERN int lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr, size_t addrlen)
const struct lws_token_limits * token_limits
Definition: libwebsockets.h:1470
lws_process_html_state_cb replace
Definition: libwebsockets.h:2248
Definition: libwebsockets.h:3894
const char * address
Definition: libwebsockets.h:1850
unsigned long(* seek_cur)(struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)
Definition: libwebsockets.h:3751
void * user
Definition: libwebsockets.h:1204
int events
Definition: libwebsockets.h:440
int(* on_get_body)(struct lws_email *email, char *buf, int len)
Definition: libwebsockets.h:3920
Definition: libwebsockets.h:1792
void * user
Definition: libwebsockets.h:1502
Definition: libwebsockets.h:3890
Definition: libwebsockets.h:2982
char * token
Definition: libwebsockets.h:2301
LWS_VISIBLE LWS_EXTERN void * lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot)
int count_protocols
Definition: libwebsockets.h:1287
void * l
Definition: libwebsockets.h:1302
const char * ssl_private_key_filepath
Definition: libwebsockets.h:1479
int max_len
Definition: libwebsockets.h:2234
Definition: libwebsockets.h:634
const struct lws_protocol_vhost_options * next
Definition: libwebsockets.h:1775
Definition: libwebsockets.h:645
LWS_VISIBLE LWS_EXTERN void lws_rx_flow_allow_all_protocol(const struct lws_context *context, const struct lws_protocols *protocol)
Definition: libwebsockets.h:2240
LWS_VISIBLE LWS_EXTERN const char *LWS_WARN_UNUSED_RESULT lws_canonical_hostname(struct lws_context *context)
Definition: libwebsockets.h:844
const char * ssl_ca_filepath
Definition: libwebsockets.h:1485
int gid
Definition: libwebsockets.h:1496
struct lws_vhost * vhost
Definition: libwebsockets.h:1882
int lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len)
Definition: libwebsockets.h:937
LWS_VISIBLE LWS_EXTERN void lws_cancel_service_pt(struct lws *wsi)
Definition: libwebsockets.h:1428
Definition: libwebsockets.h:513
Definition: libwebsockets.h:3885
unsigned int api_magic
Definition: libwebsockets.h:1285
Definition: libwebsockets.h:1431
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_send_pipe_choked(struct lws *wsi)
Definition: libwebsockets.h:3888
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:2640