2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
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.
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.
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,
24 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
25 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
36 #if defined(LWS_WITH_ESP8266)
43 #include "lws_config.h"
45 #if defined(WIN32) || defined(_WIN32)
46 #ifndef WIN32_LEAN_AND_MEAN
47 #define WIN32_LEAN_AND_MEAN
57 #define _O_RDONLY 0x0000
58 #define O_RDONLY _O_RDONLY
61 // Visual studio older than 2015 and WIN_CE has only _stricmp
62 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
63 #define strcasecmp _stricmp
64 #elif !defined(__MINGW32__)
65 #define strcasecmp stricmp
67 #define getdtablesize() 30000
69 #define LWS_INLINE __inline
71 #define LWS_WARN_UNUSED_RESULT
72 #define LWS_WARN_DEPRECATED
73 #define LWS_FORMAT(string_index)
77 #define LWS_EXTERN extern __declspec(dllexport)
79 #define LWS_EXTERN extern __declspec(dllimport)
85 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
86 #define LWS_O_RDONLY _O_RDONLY
87 #define LWS_O_WRONLY _O_WRONLY
88 #define LWS_O_CREAT _O_CREAT
89 #define LWS_O_TRUNC _O_TRUNC
91 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
92 #define lws_snprintf _snprintf
96 #define __func__ __FUNCTION__
99 #if !defined(__MINGW32__) &&(!defined(_MSC_VER) || _MSC_VER < 1900) && !defined(snprintf)
100 #define snprintf(buf,len, format,...) _snprintf_s(buf, len,len, format, __VA_ARGS__)
103 #else /* NOT WIN32 */
105 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
106 #include <sys/capability.h>
109 #if defined(__NetBSD__) || defined(__FreeBSD__)
110 #include <netinet/in.h>
113 #define LWS_INLINE inline
114 #define LWS_O_RDONLY O_RDONLY
115 #define LWS_O_WRONLY O_WRONLY
116 #define LWS_O_CREAT O_CREAT
117 #define LWS_O_TRUNC O_TRUNC
119 #if !defined(LWS_WITH_ESP8266) && !defined(OPTEE_TA) && !defined(LWS_WITH_ESP32)
122 #define LWS_INVALID_FILE -1
124 #define getdtablesize() (30)
125 #if defined(LWS_WITH_ESP32)
126 #define LWS_INVALID_FILE NULL
128 #define LWS_INVALID_FILE NULL
132 #if defined(__GNUC__)
134 /* warn_unused_result attribute only supported by GCC 3.4 or later */
135 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
136 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
138 #define LWS_WARN_UNUSED_RESULT
141 #define LWS_VISIBLE __attribute__((visibility("default")))
142 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
143 #define LWS_FORMAT(string_index) __attribute__ ((format(printf, string_index, string_index+1)))
146 #define LWS_WARN_UNUSED_RESULT
147 #define LWS_WARN_DEPRECATED
148 #define LWS_FORMAT(string_index)
151 #if defined(__ANDROID__)
153 #define getdtablesize() sysconf(_SC_OPEN_MAX)
160 #endif /* LWS_USE_LIBEV */
163 #ifdef LWS_HAVE_UV_VERSION_H
164 #include <uv-version.h>
166 #endif /* LWS_USE_LIBUV */
167 #ifdef LWS_USE_LIBEVENT
168 #include <event2/event.h>
169 #endif /* LWS_USE_LIBEVENT */
172 #define LWS_EXTERN extern
178 #if !defined(OPTEE_TA)
179 #include <sys/time.h>
184 #ifdef LWS_OPENSSL_SUPPORT
187 #ifdef USE_OLD_CYASSL
188 #include <cyassl/openssl/ssl.h>
189 #include <cyassl/error-ssl.h>
191 #include <wolfssl/openssl/ssl.h>
192 #include <wolfssl/error-ssl.h>
193 #endif /* not USE_OLD_CYASSL */
195 #include <openssl/ssl.h>
196 #if !defined(LWS_WITH_ESP32)
197 #include <openssl/err.h>
199 #endif /* not USE_WOLFSSL */
203 #define CONTEXT_PORT_NO_LISTEN -1
204 #define CONTEXT_PORT_NO_LISTEN_SERVER -2
206 /** \defgroup log Logging
210 * Lws provides flexible and filterable logging facilities, which can be
211 * used inside lws and in user code.
213 * Log categories may be individually filtered bitwise, and directed to built-in
214 * sinks for syslog-compatible logging, or a user-defined function.
218 enum lws_log_levels {
228 LLL_LATENCY = 1 << 9,
231 LLL_COUNT = 11 /* set to count of valid flags */
234 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...) LWS_FORMAT(2);
235 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
237 * lwsl_timestamp: generate logging timestamp string
239 * \param level: logging level
240 * \param p: char * buffer to take timestamp
241 * \param len: length of p
243 * returns length written in p
245 LWS_VISIBLE LWS_EXTERN int
246 lwsl_timestamp(int level, char *p, int len);
248 /* these guys are unconditionally included */
250 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
251 #define lwsl_user(...) _lws_log(LLL_USER, __VA_ARGS__)
253 #if !defined(LWS_WITH_NO_LOGS)
254 /* notice and warn are usually included by being compiled in */
255 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
256 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
259 * weaker logging can be deselected by telling CMake to build in RELEASE mode
260 * that gets rid of the overhead of checking while keeping _warn and _err
264 #if defined(LWS_WITH_ESP8266)
269 #if defined(LWS_WITH_NO_LOGS)
270 /* notice, warn and log are always compiled in */
271 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
272 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
274 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
275 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
276 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
277 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
278 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
279 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
280 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
282 * lwsl_hexdump() - helper to hexdump a buffer (DEBUG builds only)
284 * \param buf: buffer start to dump
285 * \param len: length of buffer to dump
287 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
290 #if defined(LWS_WITH_NO_LOGS)
291 #define lwsl_warn(...) do {} while(0)
292 #define lwsl_notice(...) do {} while(0)
294 #define lwsl_info(...) do {} while(0)
295 #define lwsl_debug(...) do {} while(0)
296 #define lwsl_parser(...) do {} while(0)
297 #define lwsl_header(...) do {} while(0)
298 #define lwsl_ext(...) do {} while(0)
299 #define lwsl_client(...) do {} while(0)
300 #define lwsl_latency(...) do {} while(0)
301 #define lwsl_hexdump(a, b)
305 static LWS_INLINE int lws_is_be(void) {
306 const int probe = ~0xff;
308 return *(const char *)&probe;
312 * lws_set_log_level() - Set the logging bitfield
313 * \param level: OR together the LLL_ debug contexts you want output from
314 * \param log_emit_function: NULL to leave it as it is, or a user-supplied
315 * function to perform log string emission instead of
316 * the default stderr one.
318 * log level defaults to "err", "warn" and "notice" contexts enabled and
319 * emission on stderr.
321 LWS_VISIBLE LWS_EXTERN void
322 lws_set_log_level(int level,
323 void (*log_emit_function)(int level, const char *line));
326 * lwsl_emit_syslog() - helper log emit function writes to system log
328 * \param level: one of LLL_ log level indexes
329 * \param line: log string
331 * You use this by passing the function pointer to lws_set_log_level(), to set
332 * it as the log emit function, it is not called directly.
334 LWS_VISIBLE LWS_EXTERN void
335 lwsl_emit_syslog(int level, const char *line);
338 * lwsl_visible() - returns true if the log level should be printed
340 * \param level: one of LLL_ log level indexes
342 * This is useful if you have to do work to generate the log content, you
343 * can skip the work if the log level used to print it is not actually
344 * enabled at runtime.
346 LWS_VISIBLE LWS_EXTERN int
347 lwsl_visible(int level);
354 #ifndef lws_container_of
355 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
361 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
364 /* api change list for user code to test against */
366 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
368 /* the struct lws_protocols has the id field present */
369 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
371 /* you can call lws_get_peer_write_allowance */
372 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
374 /* extra parameter introduced in 917f43ab821 */
375 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
377 /* File operations stuff exists */
378 #define LWS_FEATURE_FOPS
382 typedef SOCKET lws_sockfd_type;
383 typedef HANDLE lws_filefd_type;
384 #define lws_sockfd_valid(sfd) (!!sfd)
386 lws_sockfd_type fd; /**< file descriptor */
387 SHORT events; /**< which events to respond to */
388 SHORT revents; /**< which events happened */
390 #define LWS_POLLHUP (FD_CLOSE)
391 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
392 #define LWS_POLLOUT (FD_WRITE)
396 #if defined(LWS_WITH_ESP8266)
398 #include <user_interface.h>
401 typedef struct espconn * lws_sockfd_type;
402 typedef void * lws_filefd_type;
403 #define lws_sockfd_valid(sfd) (!!sfd)
405 lws_sockfd_type fd; /**< fd related to */
406 short events; /**< which POLL... events to respond to */
407 short revents; /**< which POLL... events occurred */
409 #define POLLIN 0x0001
410 #define POLLPRI 0x0002
411 #define POLLOUT 0x0004
412 #define POLLERR 0x0008
413 #define POLLHUP 0x0010
414 #define POLLNVAL 0x0020
418 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
419 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
425 int ets_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
426 #define snprintf ets_snprintf
428 typedef os_timer_t uv_timer_t;
429 typedef void uv_cb_t(uv_timer_t *);
431 void os_timer_disarm(void *);
432 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
434 void ets_timer_arm_new(os_timer_t *, int, int, int);
436 //void os_timer_arm(os_timer_t *, int, int);
438 #define UV_VERSION_MAJOR 1
440 #define lws_uv_getloop(a, b) (NULL)
442 static inline void uv_timer_init(void *l, uv_timer_t *t)
445 memset(t, 0, sizeof(*t));
449 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
451 os_timer_setfn(t, (os_timer_func_t *)cb, t);
453 os_timer_arm(t, first, !!rep);
456 static inline void uv_timer_stop(uv_timer_t *t)
462 #if defined(LWS_WITH_ESP32)
464 typedef int lws_sockfd_type;
465 typedef int lws_filefd_type;
466 #define lws_sockfd_valid(sfd) (sfd >= 0)
468 lws_sockfd_type fd; /**< fd related to */
469 short events; /**< which POLL... events to respond to */
470 short revents; /**< which POLL... events occurred */
472 #define POLLIN 0x0001
473 #define POLLPRI 0x0002
474 #define POLLOUT 0x0004
475 #define POLLERR 0x0008
476 #define POLLHUP 0x0010
477 #define POLLNVAL 0x0020
479 #include <freertos/FreeRTOS.h>
480 #include <freertos/event_groups.h>
482 #include "esp_wifi.h"
483 #include "esp_system.h"
484 #include "esp_event.h"
485 #include "esp_event_loop.h"
487 #include "driver/gpio.h"
488 #include "esp_spi_flash.h"
489 #include "freertos/timers.h"
491 #if !defined(CONFIG_FREERTOS_HZ)
492 #define CONFIG_FREERTOS_HZ 100
495 typedef TimerHandle_t uv_timer_t;
496 typedef void uv_cb_t(uv_timer_t *);
497 typedef void * uv_handle_t;
499 struct timer_mapping {
504 #define UV_VERSION_MAJOR 1
506 #define lws_uv_getloop(a, b) (NULL)
508 static inline void uv_timer_init(void *l, uv_timer_t *t)
514 extern void esp32_uvtimer_cb(TimerHandle_t t);
516 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
518 struct timer_mapping *tm = (struct timer_mapping *)malloc(sizeof(*tm));
526 *t = xTimerCreate("x", pdMS_TO_TICKS(first), !!rep, tm,
527 (TimerCallbackFunction_t)esp32_uvtimer_cb);
531 static inline void uv_timer_stop(uv_timer_t *t)
536 static inline void uv_close(uv_handle_t *h, void *v)
538 free(pvTimerGetTimerID((uv_timer_t)h));
539 xTimerDelete(*(uv_timer_t *)h, 0);
542 /* ESP32 helper declarations */
545 #include <esp_partition.h>
547 #define LWS_PLUGIN_STATIC
548 #define LWS_MAGIC_REBOOT_TYPE_ADS 0x50001ffc
549 #define LWS_MAGIC_REBOOT_TYPE_REQ_FACTORY 0xb00bcafe
550 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY 0xfaceb00b
551 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY_BUTTON 0xf0cedfac
554 /* user code provides these */
557 lws_esp32_identify_physical_device(void);
559 /* lws-plat-esp32 provides these */
561 typedef void (*lws_cb_scan_done)(uint16_t count, wifi_ap_record_t *recs, void *arg);
564 LWSESP32_GENLED__INIT,
565 LWSESP32_GENLED__LOST_NETWORK,
566 LWSESP32_GENLED__NO_NETWORK,
567 LWSESP32_GENLED__CONN_AP,
568 LWSESP32_GENLED__GOT_IP,
572 struct lws_group_member {
573 struct lws_group_member *next;
580 struct ip4_addr addr;
581 struct ip6_addr addrv6;
585 #define LWS_SYSTEM_GROUP_MEMBER_ADD 1
586 #define LWS_SYSTEM_GROUP_MEMBER_CHANGE 2
587 #define LWS_SYSTEM_GROUP_MEMBER_REMOVE 3
589 #define LWS_GROUP_FLAG_SELF 1
601 char password[4][32];
602 char active_ssid[32];
611 enum genled_state genled;
614 lws_cb_scan_done scan_consumer;
615 void *scan_consumer_arg;
616 struct lws_group_member *first;
617 int extant_group_members;
620 struct lws_esp32_image {
627 extern struct lws_esp32 lws_esp32;
630 lws_esp32_event_passthru(void *ctx, system_event_t *event);
632 lws_esp32_wlan_config(void);
634 lws_esp32_wlan_start_ap(void);
636 lws_esp32_wlan_start_station(void);
637 struct lws_context_creation_info;
639 lws_esp32_set_creation_defaults(struct lws_context_creation_info *info);
640 extern struct lws_context *
641 lws_esp32_init(struct lws_context_creation_info *);
643 lws_esp32_wlan_nvs_get(int retry);
645 lws_nvs_set_str(nvs_handle handle, const char* key, const char* value);
647 lws_esp32_restart_guided(uint32_t type);
648 extern const esp_partition_t *
649 lws_esp_ota_get_boot_partition(void);
651 lws_esp32_get_image_info(const esp_partition_t *part, struct lws_esp32_image *i, char *json, int json_len);
653 lws_esp32_leds_network_indication(void);
655 extern uint32_t lws_esp32_get_reboot_type(void);
656 extern uint16_t lws_esp32_sine_interp(int n);
658 /* required in external code by esp32 plat (may just return if no leds) */
659 extern void lws_esp32_leds_timer_cb(TimerHandle_t th);
661 typedef int lws_sockfd_type;
662 typedef int lws_filefd_type;
663 #define lws_sockfd_valid(sfd) (sfd >= 0)
667 #define lws_pollfd pollfd
668 #define LWS_POLLHUP (POLLHUP|POLLERR)
669 #define LWS_POLLIN (POLLIN)
670 #define LWS_POLLOUT (POLLOUT)
674 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
676 #define ssize_t SSIZE_T
679 #if defined(WIN32) && defined(LWS_HAVE__STAT32I64)
680 #include <sys/types.h>
681 #include <sys/stat.h>
684 #if defined(LWS_HAVE_STDINT_H)
687 #if defined(WIN32) || defined(_WIN32)
689 typedef unsigned __int32 uint32_t;
690 typedef unsigned __int16 uint16_t;
691 typedef unsigned __int8 uint8_t;
693 typedef unsigned int uint32_t;
694 typedef unsigned short uint16_t;
695 typedef unsigned char uint8_t;
699 typedef unsigned long long lws_filepos_t;
700 typedef long long lws_fileofs_t;
701 typedef uint32_t lws_fop_flags_t;
703 /** struct lws_pollargs - argument structure for all external poll related calls
704 * passed in via 'in' */
705 struct lws_pollargs {
706 lws_sockfd_type fd; /**< applicable socket descriptor */
707 int events; /**< the new event mask */
708 int prev_events; /**< the previous event mask */
712 struct lws_token_limits;
714 /*! \defgroup wsclose Websocket Close
716 * ##Websocket close frame control
718 * When we close a ws connection, we can send a reason code and a short
719 * UTF-8 description back with the close packet.
724 * NOTE: These public enums are part of the abi. If you want to add one,
725 * add it at where specified so existing users are unaffected.
727 /** enum lws_close_status - RFC6455 close status codes */
728 enum lws_close_status {
729 LWS_CLOSE_STATUS_NOSTATUS = 0,
730 LWS_CLOSE_STATUS_NORMAL = 1000,
731 /**< 1000 indicates a normal closure, meaning that the purpose for
732 which the connection was established has been fulfilled. */
733 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
734 /**< 1001 indicates that an endpoint is "going away", such as a server
735 going down or a browser having navigated away from a page. */
736 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
737 /**< 1002 indicates that an endpoint is terminating the connection due
738 to a protocol error. */
739 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
740 /**< 1003 indicates that an endpoint is terminating the connection
741 because it has received a type of data it cannot accept (e.g., an
742 endpoint that understands only text data MAY send this if it
743 receives a binary message). */
744 LWS_CLOSE_STATUS_RESERVED = 1004,
745 /**< Reserved. The specific meaning might be defined in the future. */
746 LWS_CLOSE_STATUS_NO_STATUS = 1005,
747 /**< 1005 is a reserved value and MUST NOT be set as a status code in a
748 Close control frame by an endpoint. It is designated for use in
749 applications expecting a status code to indicate that no status
750 code was actually present. */
751 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
752 /**< 1006 is a reserved value and MUST NOT be set as a status code in a
753 Close control frame by an endpoint. It is designated for use in
754 applications expecting a status code to indicate that the
755 connection was closed abnormally, e.g., without sending or
756 receiving a Close control frame. */
757 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
758 /**< 1007 indicates that an endpoint is terminating the connection
759 because it has received data within a message that was not
760 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
761 data within a text message). */
762 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
763 /**< 1008 indicates that an endpoint is terminating the connection
764 because it has received a message that violates its policy. This
765 is a generic status code that can be returned when there is no
766 other more suitable status code (e.g., 1003 or 1009) or if there
767 is a need to hide specific details about the policy. */
768 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
769 /**< 1009 indicates that an endpoint is terminating the connection
770 because it has received a message that is too big for it to
772 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
773 /**< 1010 indicates that an endpoint (client) is terminating the
774 connection because it has expected the server to negotiate one or
775 more extension, but the server didn't return them in the response
776 message of the WebSocket handshake. The list of extensions that
777 are needed SHOULD appear in the /reason/ part of the Close frame.
778 Note that this status code is not used by the server, because it
779 can fail the WebSocket handshake instead */
780 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
781 /**< 1011 indicates that a server is terminating the connection because
782 it encountered an unexpected condition that prevented it from
783 fulfilling the request. */
784 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
785 /**< 1015 is a reserved value and MUST NOT be set as a status code in a
786 Close control frame by an endpoint. It is designated for use in
787 applications expecting a status code to indicate that the
788 connection was closed due to a failure to perform a TLS handshake
789 (e.g., the server certificate can't be verified). */
791 /****** add new things just above ---^ ******/
793 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
797 * lws_close_reason - Set reason and aux data to send with Close packet
798 * If you are going to return nonzero from the callback
799 * requesting the connection to close, you can optionally
800 * call this to set the reason the peer will be told if
803 * \param wsi: The websocket connection to set the close reason on
804 * \param status: A valid close status from websocket standard
805 * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data
806 * \param len: Length of data in \param buf to send
808 LWS_VISIBLE LWS_EXTERN void
809 lws_close_reason(struct lws *wsi, enum lws_close_status status,
810 unsigned char *buf, size_t len);
816 /* needed even with extensions disabled for create context */
817 struct lws_extension;
819 /*! \defgroup usercb User Callback
821 * ##User protocol callback
823 * The protocol callback is the primary way lws interacts with
824 * user code. For one of a list of a few dozen reasons the callback gets
825 * called at some event to be handled.
827 * All of the events can be ignored, returning 0 is taken as "OK" and returning
828 * nonzero in most cases indicates that the connection should be closed.
832 struct lws_ssl_info {
838 * NOTE: These public enums are part of the abi. If you want to add one,
839 * add it at where specified so existing users are unaffected.
841 /** enum lws_callback_reasons - reason you're getting a protocol callback */
842 enum lws_callback_reasons {
843 LWS_CALLBACK_ESTABLISHED = 0,
844 /**< (VH) after the server completes a handshake with an incoming
845 * client. If you built the library with ssl support, in is a
846 * pointer to the ssl struct associated with the connection or NULL.*/
847 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
848 /**< the request client connection has been unable to complete a
849 * handshake with the remote server. If in is non-NULL, you can
850 * find an error string of length len where it points to
852 * Diagnostic strings that may be returned include
854 * "getaddrinfo (ipv6) failed"
855 * "unknown address family"
856 * "getaddrinfo (ipv4) failed"
857 * "set socket opts failed"
858 * "insert wsi failed"
859 * "lws_ssl_client_connect1 failed"
860 * "lws_ssl_client_connect2 failed"
864 * "HS: Redirect code but no Location"
865 * "HS: URI did not parse"
866 * "HS: Redirect failed"
867 * "HS: Server did not return 200"
869 * "HS: disallowed by client filter"
870 * "HS: disallowed at ESTABLISHED"
871 * "HS: ACCEPT missing"
872 * "HS: ws upgrade response not 101"
873 * "HS: UPGRADE missing"
874 * "HS: Upgrade to something other than websocket"
875 * "HS: CONNECTION missing"
876 * "HS: UPGRADE malformed"
877 * "HS: PROTOCOL malformed"
878 * "HS: Cannot match protocol"
879 * "HS: EXT: list too big"
880 * "HS: EXT: failed setting defaults"
881 * "HS: EXT: failed parsing defaults"
882 * "HS: EXT: failed parsing options"
883 * "HS: EXT: Rejects server options"
884 * "HS: EXT: unknown ext"
885 * "HS: Accept hash wrong"
886 * "HS: Rejected by filter cb"
888 * "HS: SO_SNDBUF failed"
889 * "HS: Rejected at CLIENT_ESTABLISHED"
891 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
892 /**< this is the last chance for the client user code to examine the
893 * http headers and decide to reject the connection. If the
894 * content in the headers is interesting to the
895 * client (url, etc) it needs to copy it out at
896 * this point since it will be destroyed before
897 * the CLIENT_ESTABLISHED call */
898 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
899 /**< after your client connection completed
900 * a handshake with the remote server */
901 LWS_CALLBACK_CLOSED = 4,
902 /**< when the websocket session ends */
903 LWS_CALLBACK_CLOSED_HTTP = 5,
904 /**< when a HTTP (non-websocket) session ends */
905 LWS_CALLBACK_RECEIVE = 6,
906 /**< data has appeared for this server endpoint from a
907 * remote client, it can be found at *in and is
909 LWS_CALLBACK_RECEIVE_PONG = 7,
910 /**< servers receive PONG packets with this callback reason */
911 LWS_CALLBACK_CLIENT_RECEIVE = 8,
912 /**< data has appeared from the server for the client connection, it
913 * can be found at *in and is len bytes long */
914 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
915 /**< clients receive PONG packets with this callback reason */
916 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
917 /**< If you call lws_callback_on_writable() on a connection, you will
918 * get one of these callbacks coming when the connection socket
919 * is able to accept another write packet without blocking.
920 * If it already was able to take another packet without blocking,
921 * you'll get this callback at the next call to the service loop
922 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
923 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
924 LWS_CALLBACK_SERVER_WRITEABLE = 11,
925 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
926 LWS_CALLBACK_HTTP = 12,
927 /**< an http request has come from a client that is not
928 * asking to upgrade the connection to a websocket
929 * one. This is a chance to serve http content,
930 * for example, to send a script to the client
931 * which will then open the websockets connection.
932 * in points to the URI path requested and
933 * lws_serve_http_file() makes it very
934 * simple to send back a file to the client.
935 * Normally after sending the file you are done
936 * with the http connection, since the rest of the
937 * activity will come by websockets from the script
938 * that was delivered by http, so you will want to
939 * return 1; to close and free up the connection. */
940 LWS_CALLBACK_HTTP_BODY = 13,
941 /**< the next len bytes data from the http
942 * request body HTTP connection is now available in in. */
943 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
944 /**< the expected amount of http request body has been delivered */
945 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
946 /**< a file requested to be sent down http link has completed. */
947 LWS_CALLBACK_HTTP_WRITEABLE = 16,
948 /**< you can write more down the http protocol link now. */
949 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
950 /**< called when a client connects to
951 * the server at network level; the connection is accepted but then
952 * passed to this callback to decide whether to hang up immediately
953 * or not, based on the client IP. in contains the connection
954 * socket's descriptor. Since the client connection information is
955 * not available yet, wsi still pointing to the main server socket.
956 * Return non-zero to terminate the connection before sending or
957 * receiving anything. Because this happens immediately after the
958 * network connection from the client, there's no websocket protocol
959 * selected yet so this callback is issued only to protocol 0. */
960 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
961 /**< called when the request has
962 * been received and parsed from the client, but the response is
963 * not sent yet. Return non-zero to disallow the connection.
964 * user is a pointer to the connection user space allocation,
965 * in is the URI, eg, "/"
966 * In your handler you can use the public APIs
967 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
968 * headers using the header enums lws_token_indexes from
969 * libwebsockets.h to check for and read the supported header
970 * presence and content before deciding to allow the http
971 * connection to proceed or to kill the connection. */
972 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
973 /**< A new client just had
974 * been connected, accepted, and instantiated into the pool. This
975 * callback allows setting any relevant property to it. Because this
976 * happens immediately after the instantiation of a new client,
977 * there's no websocket protocol selected yet so this callback is
978 * issued only to protocol 0. Only wsi is defined, pointing to the
979 * new client, and the return value is ignored. */
980 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
981 /**< called when the handshake has
982 * been received and parsed from the client, but the response is
983 * not sent yet. Return non-zero to disallow the connection.
984 * user is a pointer to the connection user space allocation,
985 * in is the requested protocol name
986 * In your handler you can use the public APIs
987 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
988 * headers using the header enums lws_token_indexes from
989 * libwebsockets.h to check for and read the supported header
990 * presence and content before deciding to allow the handshake
991 * to proceed or to kill the connection. */
992 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
993 /**< if configured for
994 * including OpenSSL support, this callback allows your user code
995 * to perform extra SSL_CTX_load_verify_locations() or similar
996 * calls to direct OpenSSL where to find certificates the client
997 * can use to confirm the remote server identity. user is the
998 * OpenSSL SSL_CTX* */
999 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
1000 /**< if configured for
1001 * including OpenSSL support, this callback allows your user code
1002 * to load extra certifcates into the server which allow it to
1003 * verify the validity of certificates returned by clients. user
1004 * is the server's OpenSSL SSL_CTX* */
1005 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
1006 /**< if the libwebsockets vhost was created with the option
1007 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
1008 * callback is generated during OpenSSL verification of the cert
1009 * sent from the client. It is sent to protocol[0] callback as
1010 * no protocol has been negotiated on the connection yet.
1011 * Notice that the libwebsockets context and wsi are both NULL
1012 * during this callback. See
1013 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1014 * to understand more detail about the OpenSSL callback that
1015 * generates this libwebsockets callback and the meanings of the
1016 * arguments passed. In this callback, user is the x509_ctx,
1017 * in is the ssl pointer and len is preverify_ok
1018 * Notice that this callback maintains libwebsocket return
1019 * conventions, return 0 to mean the cert is OK or 1 to fail it.
1020 * This also means that if you don't handle this callback then
1021 * the default callback action of returning 0 allows the client
1023 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
1024 /**< this callback happens
1025 * when a client handshake is being compiled. user is NULL,
1026 * in is a char **, it's pointing to a char * which holds the
1027 * next location in the header buffer where you can add
1028 * headers, and len is the remaining space in the header buffer,
1029 * which is typically some hundreds of bytes. So, to add a canned
1030 * cookie, your handler code might look similar to:
1032 * char **p = (char **)in;
1037 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1041 * Notice if you add anything, you just have to take care about
1042 * the CRLF on the line you added. Obviously this callback is
1043 * optional, if you don't handle it everything is fine.
1045 * Notice the callback is coming to protocols[0] all the time,
1046 * because there is no specific protocol negotiated yet. */
1047 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
1048 /**< When the server handshake code
1049 * sees that it does support a requested extension, before
1050 * accepting the extension by additing to the list sent back to
1051 * the client it gives this callback just to check that it's okay
1052 * to use that extension. It calls back to the requested protocol
1053 * and with in being the extension name, len is 0 and user is
1054 * valid. Note though at this time the ESTABLISHED callback hasn't
1055 * happened yet so if you initialize user content there, user
1056 * content during this callback might not be useful for anything. */
1057 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
1059 * connection is being prepared to start a handshake to a server,
1060 * each supported extension is checked with protocols[0] callback
1061 * with this reason, giving the user code a chance to suppress the
1062 * claim to support that extension by returning non-zero. If
1063 * unhandled, by default 0 will be returned and the extension
1064 * support included in the header to the server. Notice this
1065 * callback comes to protocols[0]. */
1066 LWS_CALLBACK_PROTOCOL_INIT = 27,
1067 /**< One-time call per protocol, per-vhost using it, so it can
1068 * do initial setup / allocations etc */
1069 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
1070 /**< One-time call per protocol, per-vhost using it, indicating
1071 * this protocol won't get used at all after this callback, the
1072 * vhost is getting destroyed. Take the opportunity to
1073 * deallocate everything that was allocated by the protocol. */
1074 LWS_CALLBACK_WSI_CREATE = 29,
1075 /**< outermost (earliest) wsi create notification to protocols[0] */
1076 LWS_CALLBACK_WSI_DESTROY = 30,
1077 /**< outermost (latest) wsi destroy notification to protocols[0] */
1078 LWS_CALLBACK_GET_THREAD_ID = 31,
1079 /**< lws can accept callback when writable requests from other
1080 * threads, if you implement this callback and return an opaque
1081 * current thread ID integer. */
1083 /* external poll() management support */
1084 LWS_CALLBACK_ADD_POLL_FD = 32,
1085 /**< lws normally deals with its poll() or other event loop
1086 * internally, but in the case you are integrating with another
1087 * server you will need to have lws sockets share a
1088 * polling array with the other server. This and the other
1089 * POLL_FD related callbacks let you put your specialized
1090 * poll array interface code in the callback for protocol 0, the
1091 * first protocol you support, usually the HTTP protocol in the
1093 * This callback happens when a socket needs to be
1094 * added to the polling loop: in points to a struct
1095 * lws_pollargs; the fd member of the struct is the file
1096 * descriptor, and events contains the active events
1098 * If you are using the internal lws polling / event loop
1099 * you can just ignore these callbacks. */
1100 LWS_CALLBACK_DEL_POLL_FD = 33,
1101 /**< This callback happens when a socket descriptor
1102 * needs to be removed from an external polling array. in is
1103 * again the struct lws_pollargs containing the fd member
1104 * to be removed. If you are using the internal polling
1105 * loop, you can just ignore it. */
1106 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1107 /**< This callback happens when lws wants to modify the events for
1109 * in is the struct lws_pollargs with the fd to change.
1110 * The new event mask is in events member and the old mask is in
1111 * the prev_events member.
1112 * If you are using the internal polling loop, you can just ignore
1114 LWS_CALLBACK_LOCK_POLL = 35,
1115 /**< These allow the external poll changes driven
1116 * by lws to participate in an external thread locking
1117 * scheme around the changes, so the whole thing is threadsafe.
1118 * These are called around three activities in the library,
1119 * - inserting a new wsi in the wsi / fd table (len=1)
1120 * - deleting a wsi from the wsi / fd table (len=1)
1121 * - changing a wsi's POLLIN/OUT state (len=0)
1122 * Locking and unlocking external synchronization objects when
1123 * len == 1 allows external threads to be synchronized against
1124 * wsi lifecycle changes if it acquires the same lock for the
1125 * duration of wsi dereference from the other thread context. */
1126 LWS_CALLBACK_UNLOCK_POLL = 36,
1127 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1129 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1130 /**< if configured for including OpenSSL support but no private key
1131 * file has been specified (ssl_private_key_filepath is NULL), this is
1132 * called to allow the user to set the private key directly via
1133 * libopenssl and perform further operations if required; this might be
1134 * useful in situations where the private key is not directly accessible
1135 * by the OS, for example if it is stored on a smartcard.
1136 * user is the server's OpenSSL SSL_CTX* */
1137 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1138 /**< The peer has sent an unsolicited Close WS packet. in and
1139 * len are the optional close code (first 2 bytes, network
1140 * order) and the optional additional information which is not
1141 * defined in the standard, and may be a string or non-human- readable data.
1142 * If you return 0 lws will echo the close and then close the
1143 * connection. If you return nonzero lws will just close the
1146 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1149 LWS_CALLBACK_CGI = 40,
1151 LWS_CALLBACK_CGI_TERMINATED = 41,
1153 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1155 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1157 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1159 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1161 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1163 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1165 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1167 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1169 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1171 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1173 LWS_CALLBACK_PROCESS_HTML = 52,
1175 LWS_CALLBACK_ADD_HEADERS = 53,
1177 LWS_CALLBACK_SESSION_INFO = 54,
1180 LWS_CALLBACK_GS_EVENT = 55,
1182 LWS_CALLBACK_HTTP_PMO = 56,
1183 /**< per-mount options for this connection, called before
1184 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1187 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1188 /**< when doing an HTTP type client connection, you can call
1189 * lws_client_http_body_pending(wsi, 1) from
1190 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1191 * sending the HTTP headers.
1193 * From this callback, when you have sent everything, you should let
1194 * lws know by calling lws_client_http_body_pending(wsi, 0)
1196 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1197 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1198 * this callback is called during OpenSSL verification of the cert
1199 * sent from the server to the client. It is sent to protocol[0]
1200 * callback as no protocol has been negotiated on the connection yet.
1201 * Notice that the wsi is set because lws_client_connect_via_info was
1204 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1205 * to understand more detail about the OpenSSL callback that
1206 * generates this libwebsockets callback and the meanings of the
1207 * arguments passed. In this callback, user is the x509_ctx,
1208 * in is the ssl pointer and len is preverify_ok.
1210 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1211 * overruled and cert shall be accepted as ok,
1212 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1213 * called and return value must be 0 to mean the cert is OK;
1214 * returning 1 will fail the cert in any case.
1216 * This also means that if you don't handle this callback then
1217 * the default callback action of returning 0 will not accept the
1218 * certificate in case of a validation error decided by the SSL lib.
1220 * This is expected and secure behaviour when validating certificates.
1222 * Note: LCCSCF_ALLOW_SELFSIGNED and
1223 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1224 * callback being implemented.
1226 LWS_CALLBACK_RAW_RX = 59,
1227 /**< RAW mode connection RX */
1228 LWS_CALLBACK_RAW_CLOSE = 60,
1229 /**< RAW mode connection is closing */
1230 LWS_CALLBACK_RAW_WRITEABLE = 61,
1231 /**< RAW mode connection may be written */
1232 LWS_CALLBACK_RAW_ADOPT = 62,
1233 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1234 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1235 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1236 LWS_CALLBACK_RAW_RX_FILE = 64,
1237 /**< RAW mode file has something to read */
1238 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1239 /**< RAW mode file is writeable */
1240 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1241 /**< RAW mode wsi that adopted a file is closing */
1242 LWS_CALLBACK_SSL_INFO = 67,
1243 /**< SSL connections only. An event you registered an
1244 * interest in at the vhost has occurred on a connection
1245 * using the vhost. @in is a pointer to a
1246 * struct lws_ssl_info containing information about the
1249 /****** add new things just above ---^ ******/
1251 LWS_CALLBACK_USER = 1000,
1252 /**< user code can use any including above without fear of clashes */
1258 * typedef lws_callback_function() - User server actions
1259 * \param wsi: Opaque websocket instance pointer
1260 * \param reason: The reason for the call
1261 * \param user: Pointer to per-session user data allocated by library
1262 * \param in: Pointer used for some callback reasons
1263 * \param len: Length set for some callback reasons
1265 * This callback is the way the user controls what is served. All the
1266 * protocol detail is hidden and handled by the library.
1268 * For each connection / session there is user data allocated that is
1269 * pointed to by "user". You set the size of this user data area when
1270 * the library is initialized with lws_create_server.
1273 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1274 void *user, void *in, size_t len);
1277 /*! \defgroup extensions
1279 * ##Extension releated functions
1281 * Ws defines optional extensions, lws provides the ability to implement these
1282 * in user code if so desired.
1284 * We provide one extensions permessage-deflate.
1289 * NOTE: These public enums are part of the abi. If you want to add one,
1290 * add it at where specified so existing users are unaffected.
1292 enum lws_extension_callback_reasons {
1293 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1294 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1295 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1296 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1297 LWS_EXT_CB_CONSTRUCT = 4,
1298 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1299 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1300 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1301 LWS_EXT_CB_DESTROY = 8,
1302 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1303 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1304 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1305 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1306 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1307 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1308 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1309 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1310 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1311 LWS_EXT_CB_1HZ = 18,
1312 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1313 LWS_EXT_CB_IS_WRITEABLE = 20,
1314 LWS_EXT_CB_PAYLOAD_TX = 21,
1315 LWS_EXT_CB_PAYLOAD_RX = 22,
1316 LWS_EXT_CB_OPTION_DEFAULT = 23,
1317 LWS_EXT_CB_OPTION_SET = 24,
1318 LWS_EXT_CB_OPTION_CONFIRM = 25,
1319 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1321 /****** add new things just above ---^ ******/
1324 /** enum lws_ext_options_types */
1325 enum lws_ext_options_types {
1326 EXTARG_NONE, /**< does not take an argument */
1327 EXTARG_DEC, /**< requires a decimal argument */
1328 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1330 /* Add new things just above here ---^
1331 * This is part of the ABI, don't needlessly break compatibility */
1334 /** struct lws_ext_options - Option arguments to the extension. These are
1335 * used in the negotiation at ws upgrade time.
1336 * The helper function lws_ext_parse_options()
1337 * uses these to generate callbacks */
1338 struct lws_ext_options {
1339 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1340 enum lws_ext_options_types type; /**< What kind of args the option can take */
1342 /* Add new things just above here ---^
1343 * This is part of the ABI, don't needlessly break compatibility */
1346 /** struct lws_ext_option_arg */
1347 struct lws_ext_option_arg {
1348 const char *option_name; /**< may be NULL, option_index used then */
1349 int option_index; /**< argument ordinal to use if option_name missing */
1350 const char *start; /**< value */
1351 int len; /**< length of value */
1355 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1356 * \param context: Websockets context
1357 * \param ext: This extension
1358 * \param wsi: Opaque websocket instance pointer
1359 * \param reason: The reason for the call
1360 * \param user: Pointer to ptr to per-session user data allocated by library
1361 * \param in: Pointer used for some callback reasons
1362 * \param len: Length set for some callback reasons
1364 * Each extension that is active on a particular connection receives
1365 * callbacks during the connection lifetime to allow the extension to
1366 * operate on websocket data and manage itself.
1368 * Libwebsockets takes care of allocating and freeing "user" memory for
1369 * each active extension on each connection. That is what is pointed to
1370 * by the user parameter.
1372 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1373 * select this extension from the list provided by the client,
1374 * just before the server will send back the handshake accepting
1375 * the connection with this extension active. This gives the
1376 * extension a chance to initialize its connection context found
1379 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1380 * but called when client is instantiating this extension. Some
1381 * extensions will work the same on client and server side and then
1382 * you can just merge handlers for both CONSTRUCTS.
1384 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1385 * being used on is about to be closed and deallocated. It's the
1386 * last chance for the extension to deallocate anything it has
1387 * allocated in the user data (pointed to by user) before the
1388 * user data is deleted. This same callback is used whether you
1389 * are in client or server instantiation context.
1391 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1392 * a connection, and a packet of data arrived at the connection,
1393 * it is passed to this callback to give the extension a chance to
1394 * change the data, eg, decompress it. user is pointing to the
1395 * extension's private connection context data, in is pointing
1396 * to an lws_tokens struct, it consists of a char * pointer called
1397 * token, and an int called token_len. At entry, these are
1398 * set to point to the received buffer and set to the content
1399 * length. If the extension will grow the content, it should use
1400 * a new buffer allocated in its private user context data and
1401 * set the pointed-to lws_tokens members to point to its buffer.
1403 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1404 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1405 * extension a chance to change websocket data just before it will
1406 * be sent out. Using the same lws_token pointer scheme in in,
1407 * the extension can change the buffer and the length to be
1408 * transmitted how it likes. Again if it wants to grow the
1409 * buffer safely, it should copy the data into its own buffer and
1410 * set the lws_tokens token pointer to it.
1412 * LWS_EXT_CB_ARGS_VALIDATE:
1415 lws_extension_callback_function(struct lws_context *context,
1416 const struct lws_extension *ext, struct lws *wsi,
1417 enum lws_extension_callback_reasons reason,
1418 void *user, void *in, size_t len);
1420 /** struct lws_extension - An extension we support */
1421 struct lws_extension {
1422 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1423 lws_extension_callback_function *callback; /**< Service callback */
1424 const char *client_offer; /**< String containing exts and options client offers */
1426 /* Add new things just above here ---^
1427 * This is part of the ABI, don't needlessly break compatibility */
1431 * lws_set_extension_option(): set extension option if possible
1433 * \param wsi: websocket connection
1434 * \param ext_name: name of ext, like "permessage-deflate"
1435 * \param opt_name: name of option, like "rx_buf_size"
1436 * \param opt_val: value to set option to
1438 LWS_VISIBLE LWS_EXTERN int
1439 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1440 const char *opt_name, const char *opt_val);
1442 #ifndef LWS_NO_EXTENSIONS
1443 /* lws_get_internal_extensions() - DEPRECATED
1445 * \Deprecated There is no longer a set internal extensions table. The table is provided
1446 * by user code along with application-specific settings. See the test
1447 * client and server for how to do.
1449 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1450 lws_get_internal_extensions(void) { return NULL; }
1453 * lws_ext_parse_options() - deal with parsing negotiated extension options
1455 * \param ext: related extension struct
1456 * \param wsi: websocket connection
1457 * \param ext_user: per-connection extension private data
1458 * \param opts: list of supported options
1459 * \param o: option string to parse
1460 * \param len: length
1462 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1463 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1464 void *ext_user, const struct lws_ext_options *opts,
1465 const char *o, int len);
1468 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1470 * \param context: lws context
1471 * \param ext: related lws_extension struct
1472 * \param wsi: websocket connection
1473 * \param reason: incoming callback reason
1474 * \param user: per-connection extension private data
1475 * \param in: pointer parameter
1476 * \param len: length parameter
1478 * Built-in callback implementing RFC7692 permessage-deflate
1481 int lws_extension_callback_pm_deflate(
1482 struct lws_context *context, const struct lws_extension *ext,
1483 struct lws *wsi, enum lws_extension_callback_reasons reason,
1484 void *user, void *in, size_t len);
1487 * The internal exts are part of the public abi
1488 * If we add more extensions, publish the callback here ------v
1492 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1495 * ##Protocol and protocol plugin -related apis
1497 * Protocols bind ws protocol names to a custom callback specific to that
1498 * protocol implementaion.
1500 * A list of protocols can be passed in at context creation time, but it is
1501 * also legal to leave that NULL and add the protocols and their callback code
1504 * Plugins are much preferable compared to cut and pasting code into an
1505 * application each time, since they can be used standalone.
1508 /** struct lws_protocols - List of protocols and handlers client or server
1511 struct lws_protocols {
1513 /**< Protocol name that must match the one given in the client
1514 * Javascript new WebSocket(url, 'protocol') name. */
1515 lws_callback_function *callback;
1516 /**< The service callback used for this protocol. It allows the
1517 * service action for an entire protocol to be encapsulated in
1518 * the protocol-specific callback */
1519 size_t per_session_data_size;
1520 /**< Each new connection using this protocol gets
1521 * this much memory allocated on connection establishment and
1522 * freed on connection takedown. A pointer to this per-connection
1523 * allocation is passed into the callback in the 'user' parameter */
1524 size_t rx_buffer_size;
1525 /**< lws allocates this much space for rx data and informs callback
1526 * when something came. Due to rx flow control, the callback may not
1527 * be able to consume it all without having to return to the event
1528 * loop. That is supported in lws.
1530 * If .tx_packet_size is 0, this also controls how much may be sent at once
1531 * for backwards compatibility.
1534 /**< ignored by lws, but useful to contain user information bound
1535 * to the selected protocol. For example if this protocol was
1536 * called "myprotocol-v2", you might set id to 2, and the user
1537 * code that acts differently according to the version can do so by
1538 * switch (wsi->protocol->id), user code might use some bits as
1539 * capability flags based on selected protocol version, etc. */
1540 void *user; /**< ignored by lws, but user code can pass a pointer
1541 here it can later access from the protocol callback */
1542 size_t tx_packet_size;
1543 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1545 * If greater than zero, a single send() is restricted to this amount
1546 * and any remainder is buffered by lws and sent afterwards also in
1547 * these size chunks. Since that is expensive, it's preferable
1548 * to restrict one fragment you are trying to send to match this
1552 /* Add new things just above here ---^
1553 * This is part of the ABI, don't needlessly break compatibility */
1559 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1561 * \param vh: vhost to search
1562 * \param name: protocol name
1564 * Returns NULL or a pointer to the vhost's protocol of the requested name
1566 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1567 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1570 * lws_get_protocol() - Returns a protocol pointer from a websocket
1572 * \param wsi: pointer to struct websocket you want to know the protocol of
1575 * Some apis can act on all live connections of a given protocol,
1576 * this is how you can get a pointer to the active protocol if needed.
1578 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1579 lws_get_protocol(struct lws *wsi);
1581 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1582 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1583 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1586 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1588 * \param vhost: vhost the instance is related to
1589 * \param prot: protocol the instance is related to
1590 * \param size: bytes to allocate
1592 * Protocols often find it useful to allocate a per-vhost struct, this is a
1593 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1595 LWS_VISIBLE LWS_EXTERN void *
1596 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1600 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1602 * \param vhost: vhost the instance is related to
1603 * \param prot: protocol the instance is related to
1605 * Recover a pointer to the allocated per-vhost storage for the protocol created
1606 * by lws_protocol_vh_priv_zalloc() earlier
1608 LWS_VISIBLE LWS_EXTERN void *
1609 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1612 * lws_finalize_startup() - drop initial process privileges
1614 * \param context: lws context
1616 * This is called after the end of the vhost protocol initializations, but
1617 * you may choose to call it earlier
1619 LWS_VISIBLE LWS_EXTERN int
1620 lws_finalize_startup(struct lws_context *context);
1622 LWS_VISIBLE LWS_EXTERN int
1623 lws_protocol_init(struct lws_context *context);
1625 #ifdef LWS_WITH_PLUGINS
1627 /* PLUGINS implies LIBUV */
1629 #define LWS_PLUGIN_API_MAGIC 180
1631 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1632 struct lws_plugin_capability {
1633 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1634 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1635 int count_protocols; /**< how many protocols */
1636 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1637 int count_extensions; /**< how many extensions */
1640 typedef int (*lws_plugin_init_func)(struct lws_context *,
1641 struct lws_plugin_capability *);
1642 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1644 /** struct lws_plugin */
1646 struct lws_plugin *list; /**< linked list */
1647 #if (UV_VERSION_MAJOR > 0)
1648 uv_lib_t lib; /**< shared library pointer */
1650 void *l; /**< so we can compile on ancient libuv */
1652 char name[64]; /**< name of the plugin */
1653 struct lws_plugin_capability caps; /**< plugin capabilities */
1661 /*! \defgroup generic-sessions plugin: generic-sessions
1662 * \ingroup Protocols-and-Plugins
1664 * ##Plugin Generic-sessions related
1666 * generic-sessions plugin provides a reusable, generic session and login /
1667 * register / forgot password framework including email verification.
1671 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1672 /**< Maximum size of email we might send */
1674 /* SHA-1 binary and hexified versions */
1675 /** typedef struct lwsgw_hash_bin */
1676 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1677 /** typedef struct lwsgw_hash */
1678 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1680 /** enum lwsgs_auth_bits */
1681 enum lwsgs_auth_bits {
1682 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1683 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1684 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1685 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1688 /** struct lws_session_info - information about user session status */
1689 struct lws_session_info {
1690 char username[32]; /**< username logged in as, or empty string */
1691 char email[100]; /**< email address associated with login, or empty string */
1692 char ip[72]; /**< ip address session was started from */
1693 unsigned int mask; /**< access rights mask associated with session
1694 * see enum lwsgs_auth_bits */
1695 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1698 /** enum lws_gs_event */
1700 LWSGSE_CREATED, /**< a new user was created */
1701 LWSGSE_DELETED /**< an existing user was deleted */
1704 /** struct lws_gs_event_args */
1705 struct lws_gs_event_args {
1706 enum lws_gs_event event; /**< which event happened */
1707 const char *username; /**< which username the event happened to */
1708 const char *email; /**< the email address of that user */
1714 /*! \defgroup context-and-vhost
1717 * ##Context and Vhost releated functions
1719 * LWS requires that there is one context, in which you may define multiple
1720 * vhosts. Each vhost is a virtual host, with either its own listen port
1721 * or sharing an existing one. Each vhost has its own SSL context that can
1722 * be set up individually or left disabled.
1724 * If you don't care about multiple "site" support, you can ignore it and
1725 * lws will create a single default vhost at context creation time.
1730 * NOTE: These public enums are part of the abi. If you want to add one,
1731 * add it at where specified so existing users are unaffected.
1734 /** enum lws_context_options - context and vhost options */
1735 enum lws_context_options {
1736 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1738 /**< (VH) Don't allow the connection unless the client has a
1739 * client cert that we recognize; provides
1740 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1741 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1742 /**< (CTX) Don't try to get the server's hostname */
1743 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1745 /**< (VH) Allow non-SSL (plaintext) connections on the same
1746 * port as SSL is listening... undermines the security of SSL;
1747 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1748 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1749 /**< (CTX) Use libev event loop */
1750 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1751 /**< (VH) Disable IPV6 support */
1752 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1753 /**< (VH) Don't load OS CA certs, you will need to load your
1755 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1756 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1757 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1758 /**< (VH) Check UT-8 correctness */
1759 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1761 /**< (VH) initialize ECDH ciphers */
1762 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1763 /**< (CTX) Use libuv event loop */
1764 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1766 /**< (VH) Use http redirect to force http to https
1767 * (deprecated: use mount redirection) */
1768 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1769 /**< (CTX) Initialize the SSL library at all */
1770 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1771 /**< (CTX) Only create the context when calling context
1772 * create api, implies user code will create its own vhosts */
1773 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1774 /**< (VH) Use Unix socket */
1775 LWS_SERVER_OPTION_STS = (1 << 15),
1776 /**< (VH) Send Strict Transport Security header, making
1777 * clients subsequently go to https even if user asked for http */
1778 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1779 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1780 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1781 /**< (VH) if set, only ipv6 allowed on the vhost */
1782 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1783 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1784 * normally makes the lib spin so you can attach a debugger to it
1785 * even if it happened without a debugger in place. You can disable
1786 * that by giving this option.
1788 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1789 /**< For backwards-compatibility reasons, by default
1790 * lws prepends "http://" to the origin you give in the client
1791 * connection info struct. If you give this flag when you create
1792 * the context, only the string you give in the client connect
1793 * info for .origin (if any) will be used directly.
1795 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1796 /**< (VH) if invalid http is coming in the first line, */
1797 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1798 /**< (CTX) Use libevent event loop */
1799 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1800 /**< (VH) All connections to this vhost / port are RAW as soon as
1801 * the connection is accepted, no HTTP is going to be coming.
1804 /****** add new things just above ---^ ******/
1807 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1809 struct lws_plat_file_ops;
1811 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1813 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1814 * is not given, then for backwards compatibility one vhost is created at
1815 * context-creation time using the info from this struct.
1817 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1818 * at the same time as the context, they are expected to be created afterwards.
1820 struct lws_context_creation_info {
1822 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1823 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1824 * writing a server but you are using \ref sock-adopt instead of the
1825 * built-in listener */
1827 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1828 * interface name, eg, "eth2"
1829 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1830 * the pathname of a UNIX domain socket. you can use the UNIX domain
1831 * sockets in abstract namespace, by prepending an at symbol to the
1833 const struct lws_protocols *protocols;
1834 /**< VHOST: Array of structures listing supported protocols and a protocol-
1835 * specific callback for each one. The list is ended with an
1836 * entry that has a NULL callback pointer. */
1837 const struct lws_extension *extensions;
1838 /**< VHOST: NULL or array of lws_extension structs listing the
1839 * extensions this context supports. */
1840 const struct lws_token_limits *token_limits;
1841 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1842 * with a token length limit for each possible WSI_TOKEN_ */
1843 const char *ssl_private_key_password;
1844 /**< VHOST: NULL or the passphrase needed for the private key */
1845 const char *ssl_cert_filepath;
1846 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1847 * to listen using SSL, set to the filepath to fetch the
1848 * server cert from, otherwise NULL for unencrypted */
1849 const char *ssl_private_key_filepath;
1850 /**< VHOST: filepath to private key if wanting SSL mode;
1851 * if this is set to NULL but sll_cert_filepath is set, the
1852 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1853 * to allow setting of the private key directly via openSSL
1855 const char *ssl_ca_filepath;
1856 /**< VHOST: CA certificate filepath or NULL */
1857 const char *ssl_cipher_list;
1858 /**< VHOST: List of valid ciphers to use (eg,
1859 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1860 * or you can leave it as NULL to get "DEFAULT" */
1861 const char *http_proxy_address;
1862 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1863 * If proxy auth is required, use format "username:password\@server:port" */
1864 unsigned int http_proxy_port;
1865 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1867 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1869 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1870 unsigned int options;
1871 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1873 /**< CONTEXT: optional user pointer that can be recovered via the context
1874 * pointer using lws_context_user */
1876 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1877 * timeout to all libwebsocket sockets, client or server */
1879 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1880 * times to try to get a response from the peer before giving up
1881 * and killing the connection */
1883 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1885 #ifdef LWS_OPENSSL_SUPPORT
1886 SSL_CTX *provided_client_ssl_ctx;
1887 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1888 * implementation for the one provided by provided_ssl_ctx.
1889 * Libwebsockets no longer is responsible for freeing the context
1890 * if this option is selected. */
1891 #else /* maintain structure layout either way */
1892 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1895 short max_http_header_data;
1896 /**< CONTEXT: The max amount of header payload that can be handled
1897 * in an http request (unrecognized header payload is dropped) */
1898 short max_http_header_pool;
1899 /**< CONTEXT: The max number of connections with http headers that
1900 * can be processed simultaneously (the corresponding memory is
1901 * allocated for the lifetime of the context). If the pool is
1902 * busy new incoming connections must wait for accept until one
1905 unsigned int count_threads;
1906 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1907 unsigned int fd_limit_per_thread;
1908 /**< CONTEXT: nonzero means restrict each service thread to this
1909 * many fds, 0 means the default which is divide the process fd
1910 * limit by the number of threads. */
1911 unsigned int timeout_secs;
1912 /**< VHOST: various processes involving network roundtrips in the
1913 * library are protected from hanging forever by timeouts. If
1914 * nonzero, this member lets you set the timeout used in seconds.
1915 * Otherwise a default timeout is used. */
1916 const char *ecdh_curve;
1917 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1918 const char *vhost_name;
1919 /**< VHOST: name of vhost, must match external DNS name used to
1920 * access the site, like "warmcat.com" as it's used to match
1921 * Host: header and / or SNI name for SSL. */
1922 const char * const *plugin_dirs;
1923 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1924 * scan for lws protocol plugins at context creation time */
1925 const struct lws_protocol_vhost_options *pvo;
1926 /**< VHOST: pointer to optional linked list of per-vhost
1927 * options made accessible to protocols */
1928 int keepalive_timeout;
1929 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1930 * client to hold on to an idle HTTP/1.1 connection */
1931 const char *log_filepath;
1932 /**< VHOST: filepath to append logs to... this is opened before
1933 * any dropping of initial privileges */
1934 const struct lws_http_mount *mounts;
1935 /**< VHOST: optional linked list of mounts for this vhost */
1936 const char *server_string;
1937 /**< CONTEXT: string used in HTTP headers to identify server
1938 * software, if NULL, "libwebsockets". */
1939 unsigned int pt_serv_buf_size;
1940 /**< CONTEXT: 0 = default of 4096. This buffer is used by
1941 * various service related features including file serving, it
1942 * defines the max chunk of file that can be sent at once.
1943 * At the risk of lws having to buffer failed large sends, it
1944 * can be increased to, eg, 128KiB to improve throughput. */
1945 unsigned int max_http_header_data2;
1946 /**< CONTEXT: if max_http_header_data is 0 and this
1947 * is nonzero, this will be used in place of the default. It's
1948 * like this for compatibility with the original short version,
1949 * this is unsigned int length. */
1950 long ssl_options_set;
1951 /**< VHOST: Any bits set here will be set as SSL options */
1952 long ssl_options_clear;
1953 /**< VHOST: Any bits set here will be cleared as SSL options */
1954 unsigned short ws_ping_pong_interval;
1955 /**< CONTEXT: 0 for none, else interval in seconds between sending
1956 * PINGs on idle websocket connections. When the PING is sent,
1957 * the PONG must come within the normal timeout_secs timeout period
1958 * or the connection will be dropped.
1959 * Any RX or TX traffic on the connection restarts the interval timer,
1960 * so a connection which always sends or receives something at intervals
1961 * less than the interval given here will never send PINGs / expect
1962 * PONGs. Conversely as soon as the ws connection is established, an
1963 * idle connection will do the PING / PONG roundtrip as soon as
1964 * ws_ping_pong_interval seconds has passed without traffic
1966 const struct lws_protocol_vhost_options *headers;
1967 /**< VHOST: pointer to optional linked list of per-vhost
1968 * canned headers that are added to server responses */
1970 const struct lws_protocol_vhost_options *reject_service_keywords;
1971 /**< CONTEXT: Optional list of keywords and rejection codes + text.
1973 * The keywords are checked for existing in the user agent string.
1975 * Eg, "badrobot" "404 Not Found"
1977 void *external_baggage_free_on_destroy;
1978 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
1979 * should be freed when the context is destroyed. This allows you to
1980 * automatically sync the freeing action to the context destruction
1981 * action, so there is no need for an external free() if the context
1982 * succeeded to create.
1985 #ifdef LWS_OPENSSL_SUPPORT
1986 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1987 * with a token length limit for each possible WSI_TOKEN_ */
1988 const char *client_ssl_private_key_password;
1989 /**< VHOST: NULL or the passphrase needed for the private key */
1990 const char *client_ssl_cert_filepath;
1991 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1992 * to listen using SSL, set to the filepath to fetch the
1993 * server cert from, otherwise NULL for unencrypted */
1994 const char *client_ssl_private_key_filepath;
1995 /**< VHOST: filepath to private key if wanting SSL mode;
1996 * if this is set to NULL but sll_cert_filepath is set, the
1997 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1998 * to allow setting of the private key directly via openSSL
2000 const char *client_ssl_ca_filepath;
2001 /**< VHOST: CA certificate filepath or NULL */
2002 const char *client_ssl_cipher_list;
2003 /**< VHOST: List of valid ciphers to use (eg,
2004 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
2005 * or you can leave it as NULL to get "DEFAULT" */
2008 const struct lws_plat_file_ops *fops;
2009 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
2010 * by a sentinel with NULL .open.
2012 * If NULL, lws provides just the platform file operations struct for
2013 * backwards compatibility.
2015 int simultaneous_ssl_restriction;
2016 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
2017 const char *socks_proxy_address;
2018 /**< VHOST: If non-NULL, attempts to proxy via the given address.
2019 * If proxy auth is required, use format "username:password\@server:port" */
2020 unsigned int socks_proxy_port;
2021 /**< VHOST: If socks_proxy_address was non-NULL, uses this port */
2022 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
2023 cap_value_t caps[4];
2024 /**< CONTEXT: array holding Linux capabilities you want to
2025 * continue to be available to the server after it transitions
2026 * to a noprivileged user. Usually none are needed but for, eg,
2027 * .bind_iface, CAP_NET_RAW is required. This gives you a way
2028 * to still have the capability but drop root.
2031 /**< CONTEXT: count of Linux capabilities in .caps[]. 0 means
2032 * no capabilities will be inherited from root (the default) */
2035 /**< VHOST: nonzero to strictly bind sockets to the interface name in
2036 * .iface (eg, "eth2"), using SO_BIND_TO_DEVICE.
2038 * Requires SO_BINDTODEVICE support from your OS and CAP_NET_RAW
2041 * Notice that common things like access network interface IP from
2042 * your local machine use your lo / loopback interface and will be
2043 * disallowed by this.
2046 /* Add new things just above here ---^
2047 * This is part of the ABI, don't needlessly break compatibility
2049 * The below is to ensure later library versions with new
2050 * members added above will see 0 (default) even if the app
2051 * was not built against the newer headers.
2053 int ssl_info_event_mask;
2054 /**< VHOST: mask of ssl events to be reported on LWS_CALLBACK_SSL_INFO
2055 * callback for connections on this vhost. The mask values are of
2056 * the form SSL_CB_ALERT, defined in openssl/ssl.h. The default of
2057 * 0 means no info events will be reported.
2060 void *_unused[8]; /**< dummy */
2064 * lws_create_context() - Create the websocket handler
2065 * \param info: pointer to struct with parameters
2067 * This function creates the listening socket (if serving) and takes care
2068 * of all initialization in one step.
2070 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
2071 * created; you're expected to create your own vhosts afterwards using
2072 * lws_create_vhost(). Otherwise a vhost named "default" is also created
2073 * using the information in the vhost-related members, for compatibility.
2075 * After initialization, it returns a struct lws_context * that
2076 * represents this server. After calling, user code needs to take care
2077 * of calling lws_service() with the context pointer to get the
2078 * server's sockets serviced. This must be done in the same process
2079 * context as the initialization call.
2081 * The protocol callback functions are called for a handful of events
2082 * including http requests coming in, websocket connections becoming
2083 * established, and data arriving; it's also called periodically to allow
2084 * async transmission.
2086 * HTTP requests are sent always to the FIRST protocol in protocol, since
2087 * at that time websocket protocol has not been negotiated. Other
2088 * protocols after the first one never see any HTTP callback activity.
2090 * The server created is a simple http server by default; part of the
2091 * websocket standard is upgrading this http connection to a websocket one.
2093 * This allows the same server to provide files like scripts and favicon /
2094 * images or whatever over http and dynamic data over websockets all in
2095 * one place; they're all handled in the user callback.
2097 LWS_VISIBLE LWS_EXTERN struct lws_context *
2098 lws_create_context(struct lws_context_creation_info *info);
2101 * lws_context_destroy() - Destroy the websocket context
2102 * \param context: Websocket context
2104 * This function closes any active connections and then frees the
2105 * context. After calling this, any further use of the context is
2108 LWS_VISIBLE LWS_EXTERN void
2109 lws_context_destroy(struct lws_context *context);
2111 LWS_VISIBLE LWS_EXTERN void
2112 lws_context_destroy2(struct lws_context *context);
2114 typedef int (*lws_reload_func)(void);
2117 * lws_context_deprecate() - Deprecate the websocket context
2118 * \param context: Websocket context
2120 * This function is used on an existing context before superceding it
2121 * with a new context.
2123 * It closes any listen sockets in the context, so new connections are
2126 * And it marks the context to be deleted when the number of active
2127 * connections into it falls to zero.
2129 * Otherwise if you attach the deprecated context to the replacement
2130 * context when it has been created using lws_context_attach_deprecated()
2131 * both any deprecated and the new context will service their connections.
2133 * This is aimed at allowing seamless configuration reloads.
2135 * The callback cb will be called after the listen sockets are actually
2136 * closed and may be reopened. In the callback the new context should be
2137 * configured and created. (With libuv, socket close happens async after
2138 * more loop events).
2140 LWS_VISIBLE LWS_EXTERN void
2141 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2143 LWS_VISIBLE LWS_EXTERN int
2144 lws_context_is_deprecated(struct lws_context *context);
2147 * lws_set_proxy() - Setups proxy to lws_context.
2148 * \param vhost: pointer to struct lws_vhost you want set proxy for
2149 * \param proxy: pointer to c string containing proxy in format address:port
2151 * Returns 0 if proxy string was parsed and proxy was setup.
2152 * Returns -1 if proxy is NULL or has incorrect format.
2154 * This is only required if your OS does not provide the http_proxy
2155 * environment variable (eg, OSX)
2157 * IMPORTANT! You should call this function right after creation of the
2158 * lws_context and before call to connect. If you call this
2159 * function after connect behavior is undefined.
2160 * This function will override proxy settings made on lws_context
2161 * creation with genenv() call.
2163 LWS_VISIBLE LWS_EXTERN int
2164 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2167 * lws_set_socks() - Setup socks to lws_context.
2168 * \param vhost: pointer to struct lws_vhost you want set socks for
2169 * \param socks: pointer to c string containing socks in format address:port
2171 * Returns 0 if socks string was parsed and socks was setup.
2172 * Returns -1 if socks is NULL or has incorrect format.
2174 * This is only required if your OS does not provide the socks_proxy
2175 * environment variable (eg, OSX)
2177 * IMPORTANT! You should call this function right after creation of the
2178 * lws_context and before call to connect. If you call this
2179 * function after connect behavior is undefined.
2180 * This function will override proxy settings made on lws_context
2181 * creation with genenv() call.
2183 LWS_VISIBLE LWS_EXTERN int
2184 lws_set_socks(struct lws_vhost *vhost, const char *socks);
2189 * lws_create_vhost() - Create a vhost (virtual server context)
2190 * \param context: pointer to result of lws_create_context()
2191 * \param info: pointer to struct with parameters
2193 * This function creates a virtual server (vhost) using the vhost-related
2194 * members of the info struct. You can create many vhosts inside one context
2195 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2197 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
2198 lws_create_vhost(struct lws_context *context,
2199 struct lws_context_creation_info *info);
2202 * lwsws_get_config_globals() - Parse a JSON server config file
2203 * \param info: pointer to struct with parameters
2204 * \param d: filepath of the config file
2205 * \param config_strings: storage for the config strings extracted from JSON,
2206 * the pointer is incremented as strings are stored
2207 * \param len: pointer to the remaining length left in config_strings
2208 * the value is decremented as strings are stored
2210 * This function prepares a n lws_context_creation_info struct with global
2211 * settings from a file d.
2213 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2215 LWS_VISIBLE LWS_EXTERN int
2216 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2217 char **config_strings, int *len);
2220 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2221 * \param context: pointer to result of lws_create_context()
2222 * \param info: pointer to struct with parameters
2223 * \param d: filepath of the config file
2224 * \param config_strings: storage for the config strings extracted from JSON,
2225 * the pointer is incremented as strings are stored
2226 * \param len: pointer to the remaining length left in config_strings
2227 * the value is decremented as strings are stored
2229 * This function creates vhosts into a context according to the settings in
2230 *JSON files found in directory d.
2232 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2234 LWS_VISIBLE LWS_EXTERN int
2235 lwsws_get_config_vhosts(struct lws_context *context,
2236 struct lws_context_creation_info *info, const char *d,
2237 char **config_strings, int *len);
2239 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2240 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2241 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2244 * lws_get_vhost() - return the vhost a wsi belongs to
2246 * \param wsi: which connection
2248 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2249 lws_get_vhost(struct lws *wsi);
2252 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2254 * \param vh: the vhost
2255 * \param buf: buffer to fill with JSON
2256 * \param len: max length of buf
2258 LWS_VISIBLE LWS_EXTERN int
2259 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2262 * lws_json_dump_context() - describe context state and stats in JSON
2264 * \param context: the context
2265 * \param buf: buffer to fill with JSON
2266 * \param len: max length of buf
2268 LWS_VISIBLE LWS_EXTERN int
2269 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2273 * lws_context_user() - get the user data associated with the context
2274 * \param context: Websocket context
2276 * This returns the optional user allocation that can be attached to
2277 * the context the sockets live in at context_create time. It's a way
2278 * to let all sockets serviced in the same context share data without
2279 * using globals statics in the user code.
2281 LWS_VISIBLE LWS_EXTERN void *
2282 lws_context_user(struct lws_context *context);
2284 /*! \defgroup vhost-mounts Vhost mounts and options
2285 * \ingroup context-and-vhost-creation
2287 * ##Vhost mounts and options
2290 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2291 * name=value options
2293 * This provides a general way to attach a linked-list of name=value pairs,
2294 * which can also have an optional child link-list using the options member.
2296 struct lws_protocol_vhost_options {
2297 const struct lws_protocol_vhost_options *next; /**< linked list */
2298 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2299 const char *name; /**< name of name=value pair */
2300 const char *value; /**< value of name=value pair */
2303 /** enum lws_mount_protocols
2304 * This specifies the mount protocol for a mountpoint, whether it is to be
2305 * served from a filesystem, or it is a cgi etc.
2307 enum lws_mount_protocols {
2308 LWSMPRO_HTTP = 0, /**< http reverse proxy */
2309 LWSMPRO_HTTPS = 1, /**< https reverse proxy */
2310 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2311 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2312 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2313 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2314 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2317 /** struct lws_http_mount
2319 * arguments for mounting something in a vhost's url namespace
2321 struct lws_http_mount {
2322 const struct lws_http_mount *mount_next;
2323 /**< pointer to next struct lws_http_mount */
2324 const char *mountpoint;
2325 /**< mountpoint in http pathspace, eg, "/" */
2327 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2329 /**< default target, eg, "index.html" */
2330 const char *protocol;
2331 /**<"protocol-name" to handle mount */
2333 const struct lws_protocol_vhost_options *cgienv;
2334 /**< optional linked-list of cgi options. These are created
2335 * as environment variables for the cgi process
2337 const struct lws_protocol_vhost_options *extra_mimetypes;
2338 /**< optional linked-list of mimetype mappings */
2339 const struct lws_protocol_vhost_options *interpret;
2340 /**< optional linked-list of files to be interpreted */
2343 /**< seconds cgi is allowed to live, if cgi://mount type */
2345 /**< max-age for reuse of client cache of files, seconds */
2346 unsigned int auth_mask;
2347 /**< bits set here must be set for authorized client session */
2349 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2350 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2351 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2353 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2354 unsigned char mountpoint_len; /**< length of mountpoint string */
2356 const char *basic_auth_login_file;
2357 /**<NULL, or filepath to use to check basic auth logins against */
2359 /* Add new things just above here ---^
2360 * This is part of the ABI, don't needlessly break compatibility
2362 * The below is to ensure later library versions with new
2363 * members added above will see 0 (default) even if the app
2364 * was not built against the newer headers.
2367 void *_unused[2]; /**< dummy */
2372 /*! \defgroup client
2375 * ##Client releated functions
2379 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2380 * with struct lws_client_connect_info ssl_connection member to control if
2381 * and how SSL checks apply to the client connection being created
2384 enum lws_client_connect_ssl_connection_flags {
2385 LCCSCF_USE_SSL = (1 << 0),
2386 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2387 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2388 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2391 /** struct lws_client_connect_info - parameters to connect with when using
2392 * lws_client_connect_via_info() */
2394 struct lws_client_connect_info {
2395 struct lws_context *context;
2396 /**< lws context to create connection in */
2397 const char *address;
2398 /**< remote address to connect to */
2400 /**< remote port to connect to */
2402 /**< nonzero for ssl */
2406 /**< content of host header */
2408 /**< content of origin header */
2409 const char *protocol;
2410 /**< list of ws protocols we could accept */
2411 int ietf_version_or_minus_one;
2412 /**< deprecated: currently leave at 0 or -1 */
2414 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2415 const void *client_exts;
2416 /**< UNUSED... provide in info.extensions at context creation time */
2418 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2419 * use "GET" to be a simple http client connection */
2420 struct lws *parent_wsi;
2421 /**< if another wsi is responsible for this connection, give it here.
2422 * this is used to make sure if the parent closes so do any
2423 * child connections first. */
2424 const char *uri_replace_from;
2425 /**< if non-NULL, when this string is found in URIs in
2426 * text/html content-encoding, it's replaced with uri_replace_to */
2427 const char *uri_replace_to;
2428 /**< see uri_replace_from */
2429 struct lws_vhost *vhost;
2430 /**< vhost to bind to (used to determine related SSL_CTX) */
2432 /**< if not NULL, store the new wsi here early in the connection
2433 * process. Although we return the new wsi, the call to create the
2434 * client connection does progress the connection somewhat and may
2435 * meet an error that will result in the connection being scrubbed and
2436 * NULL returned. While the wsi exists though, he may process a
2437 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2438 * user callback a way to identify which wsi it is that faced the error
2439 * even before the new wsi is returned and even if ultimately no wsi
2443 /**< NULL to allow routing on any interface, or interface name or IP
2444 * to bind the socket to */
2446 /* Add new things just above here ---^
2447 * This is part of the ABI, don't needlessly break compatibility
2449 * The below is to ensure later library versions with new
2450 * members added above will see 0 (default) even if the app
2451 * was not built against the newer headers.
2454 void *_unused[4]; /**< dummy */
2458 * lws_client_connect_via_info() - Connect to another websocket server
2459 * \param ccinfo: pointer to lws_client_connect_info struct
2461 * This function creates a connection to a remote server using the
2462 * information provided in ccinfo.
2464 LWS_VISIBLE LWS_EXTERN struct lws *
2465 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2468 * lws_client_connect() - Connect to another websocket server
2469 * \deprecated DEPRECATED use lws_client_connect_via_info
2470 * \param clients: Websocket context
2471 * \param address: Remote server address, eg, "myserver.com"
2472 * \param port: Port to connect to on the remote server, eg, 80
2473 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2475 * \param path: Websocket path on server
2476 * \param host: Hostname on server
2477 * \param origin: Socket origin name
2478 * \param protocol: Comma-separated list of protocols being asked for from
2479 * the server, or just one. The server will pick the one it
2480 * likes best. If you don't want to specify a protocol, which is
2481 * legal, use NULL here.
2482 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2483 * protocol supported, or the specific protocol ordinal
2485 * This function creates a connection to a remote server
2487 /* deprecated, use lws_client_connect_via_info() */
2488 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2489 lws_client_connect(struct lws_context *clients, const char *address,
2490 int port, int ssl_connection, const char *path,
2491 const char *host, const char *origin, const char *protocol,
2492 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2493 /* deprecated, use lws_client_connect_via_info() */
2495 * lws_client_connect_extended() - Connect to another websocket server
2496 * \deprecated DEPRECATED use lws_client_connect_via_info
2497 * \param clients: Websocket context
2498 * \param address: Remote server address, eg, "myserver.com"
2499 * \param port: Port to connect to on the remote server, eg, 80
2500 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2502 * \param path: Websocket path on server
2503 * \param host: Hostname on server
2504 * \param origin: Socket origin name
2505 * \param protocol: Comma-separated list of protocols being asked for from
2506 * the server, or just one. The server will pick the one it
2508 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2509 * protocol supported, or the specific protocol ordinal
2510 * \param userdata: Pre-allocated user data
2512 * This function creates a connection to a remote server
2514 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2515 lws_client_connect_extended(struct lws_context *clients, const char *address,
2516 int port, int ssl_connection, const char *path,
2517 const char *host, const char *origin,
2518 const char *protocol, int ietf_version_or_minus_one,
2519 void *userdata) LWS_WARN_DEPRECATED;
2522 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2524 * \param info: client ssl related info
2525 * \param vhost: which vhost to initialize client ssl operations on
2527 * You only need to call this if you plan on using SSL client connections on
2528 * the vhost. For non-SSL client connections, it's not necessary to call this.
2530 * The following members of info are used during the call
2532 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2533 * otherwise the call does nothing
2534 * - provided_client_ssl_ctx must be NULL to get a generated client
2535 * ssl context, otherwise you can pass a prepared one in by setting it
2536 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2537 * - ssl_ca_filepath may be NULL or client cert filepath
2538 * - ssl_cert_filepath may be NULL or client cert filepath
2539 * - ssl_private_key_filepath may be NULL or client cert private key
2541 * You must create your vhost explicitly if you want to use this, so you have
2542 * a pointer to the vhost. Create the context first with the option flag
2543 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2544 * the same info struct.
2546 LWS_VISIBLE LWS_EXTERN int
2547 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2548 struct lws_vhost *vhost);
2550 * lws_http_client_read() - consume waiting received http client data
2552 * \param wsi: client connection
2553 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2554 * \param len: pointer to chunk length - fill with max length of buffer
2556 * This is called when the user code is notified client http data has arrived.
2557 * The user code may choose to delay calling it to consume the data, for example
2558 * waiting until an onward connection is writeable.
2560 * For non-chunked connections, up to len bytes of buf are filled with the
2561 * received content. len is set to the actual amount filled before return.
2563 * For chunked connections, the linear buffer content contains the chunking
2564 * headers and it cannot be passed in one lump. Instead, this function will
2565 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2566 * chunk start and len set to the chunk length. There will be as many calls
2567 * as there are chunks or partial chunks in the buffer.
2569 LWS_VISIBLE LWS_EXTERN int
2570 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2573 * lws_http_client_http_response() - get last HTTP response code
2575 * \param wsi: client connection
2577 * Returns the last server response code, eg, 200 for client http connections.
2579 LWS_VISIBLE LWS_EXTERN unsigned int
2580 lws_http_client_http_response(struct lws *wsi);
2582 LWS_VISIBLE LWS_EXTERN void
2583 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2586 * lws_client_http_body_pending() - control if client connection neeeds to send body
2588 * \param wsi: client connection
2589 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2590 * if nothing more to send
2592 * If you will send payload data with your HTTP client connection, eg, for POST,
2593 * when you set the related http headers in
2594 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2595 * this API with something_left_to_send nonzero, and call
2596 * lws_callback_on_writable(wsi);
2598 * After sending the headers, lws will call your callback with
2599 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2600 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2601 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2602 * let lws know the last part is sent and the connection can move on.
2607 /** \defgroup service Built-in service loop entry
2609 * ##Built-in service loop entry
2611 * If you're not using libev / libuv, these apis are needed to enter the poll()
2612 * wait in lws and service any connections with pending events.
2617 * lws_service() - Service any pending websocket activity
2618 * \param context: Websocket context
2619 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2620 * service otherwise block and service immediately, returning
2621 * after the timeout if nothing needed service.
2623 * This function deals with any pending websocket traffic, for three
2624 * kinds of event. It handles these events on both server and client
2625 * types of connection the same.
2627 * 1) Accept new connections to our context's server
2629 * 2) Call the receive callback for incoming frame data received by
2630 * server or client connections.
2632 * You need to call this service function periodically to all the above
2633 * functions to happen; if your application is single-threaded you can
2634 * just call it in your main event loop.
2636 * Alternatively you can fork a new process that asynchronously handles
2637 * calling this service in a loop. In that case you are happy if this
2638 * call blocks your thread until it needs to take care of something and
2639 * would call it with a large nonzero timeout. Your loop then takes no
2640 * CPU while there is nothing happening.
2642 * If you are calling it in a single-threaded app, you don't want it to
2643 * wait around blocking other things in your loop from happening, so you
2644 * would call it with a timeout_ms of 0, so it returns immediately if
2645 * nothing is pending, or as soon as it services whatever was pending.
2647 LWS_VISIBLE LWS_EXTERN int
2648 lws_service(struct lws_context *context, int timeout_ms);
2651 * lws_service() - Service any pending websocket activity
2653 * \param context: Websocket context
2654 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2655 * service otherwise block and service immediately, returning
2656 * after the timeout if nothing needed service.
2658 * Same as lws_service(), but for a specific thread service index. Only needed
2659 * if you are spawning multiple service threads.
2661 LWS_VISIBLE LWS_EXTERN int
2662 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2665 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2667 * \param wsi: Cancel service on the thread this wsi is serviced by
2669 * This function lets a call to lws_service() waiting for a timeout
2670 * immediately return.
2672 * It works by creating a phony event and then swallowing it silently.
2674 * The reason it may be needed is when waiting in poll(), changes to
2675 * the event masks are ignored by the OS until poll() is reentered. This
2676 * lets you halt the poll() wait and make the reentry happen immediately
2677 * instead of having the wait out the rest of the poll timeout.
2679 LWS_VISIBLE LWS_EXTERN void
2680 lws_cancel_service_pt(struct lws *wsi);
2683 * lws_cancel_service() - Cancel wait for new pending socket activity
2684 * \param context: Websocket context
2686 * This function let a call to lws_service() waiting for a timeout
2687 * immediately return.
2689 * What it basically does is provide a fake event that will be swallowed,
2690 * so the wait in poll() is ended. That's useful because poll() doesn't
2691 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2693 LWS_VISIBLE LWS_EXTERN void
2694 lws_cancel_service(struct lws_context *context);
2697 * lws_service_fd() - Service polled socket with something waiting
2698 * \param context: Websocket context
2699 * \param pollfd: The pollfd entry describing the socket fd and which events
2700 * happened, or NULL to tell lws to do only timeout servicing.
2702 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2703 * services it according to the state of the associated
2706 * The one call deals with all "service" that might happen on a socket
2707 * including listen accepts, http files as well as websocket protocol.
2709 * If a pollfd says it has something, you can just pass it to
2710 * lws_service_fd() whether it is a socket handled by lws or not.
2711 * If it sees it is a lws socket, the traffic will be handled and
2712 * pollfd->revents will be zeroed now.
2714 * If the socket is foreign to lws, it leaves revents alone. So you can
2715 * see if you should service yourself by checking the pollfd revents
2716 * after letting lws try to service it.
2718 * You should also call this with pollfd = NULL to just allow the
2719 * once-per-second global timeout checks; if less than a second since the last
2720 * check it returns immediately then.
2722 LWS_VISIBLE LWS_EXTERN int
2723 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2726 * lws_service_fd_tsi() - Service polled socket in specific service thread
2727 * \param context: Websocket context
2728 * \param pollfd: The pollfd entry describing the socket fd and which events
2730 * \param tsi: thread service index
2732 * Same as lws_service_fd() but used with multiple service threads
2734 LWS_VISIBLE LWS_EXTERN int
2735 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2739 * lws_service_adjust_timeout() - Check for any connection needing forced service
2740 * \param context: Websocket context
2741 * \param timeout_ms: The original poll timeout value. You can just set this
2742 * to 1 if you don't really have a poll timeout.
2743 * \param tsi: thread service index
2745 * Under some conditions connections may need service even though there is no
2746 * pending network action on them, this is "forced service". For default
2747 * poll() and libuv / libev, the library takes care of calling this and
2748 * dealing with it for you. But for external poll() integration, you need
2749 * access to the apis.
2751 * If anybody needs "forced service", returned timeout is zero. In that case,
2752 * you can call lws_service_tsi() with a timeout of -1 to only service
2753 * guys who need forced service.
2755 LWS_VISIBLE LWS_EXTERN int
2756 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2758 /* Backwards compatibility */
2759 #define lws_plat_service_tsi lws_service_tsi
2763 /*! \defgroup http HTTP
2765 Modules related to handling HTTP
2769 /*! \defgroup httpft HTTP File transfer
2772 APIs for sending local files in response to HTTP requests
2777 * lws_get_mimetype() - Determine mimetype to use from filename
2779 * \param file: filename
2780 * \param m: NULL, or mount context
2782 * This uses a canned list of known filetypes first, if no match and m is
2783 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2785 * Returns either NULL or a pointer to the mimetype matching the file.
2787 LWS_VISIBLE LWS_EXTERN const char *
2788 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2791 * lws_serve_http_file() - Send a file back to the client using http
2792 * \param wsi: Websocket instance (available from user callback)
2793 * \param file: The file to issue over http
2794 * \param content_type: The http content type, eg, text/html
2795 * \param other_headers: NULL or pointer to header string
2796 * \param other_headers_len: length of the other headers if non-NULL
2798 * This function is intended to be called from the callback in response
2799 * to http requests from the client. It allows the callback to issue
2800 * local files down the http link in a single step.
2802 * Returning <0 indicates error and the wsi should be closed. Returning
2803 * >0 indicates the file was completely sent and
2804 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2805 * ==0 indicates the file transfer is started and needs more service later,
2806 * the wsi should be left alone.
2808 LWS_VISIBLE LWS_EXTERN int
2809 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2810 const char *other_headers, int other_headers_len);
2812 LWS_VISIBLE LWS_EXTERN int
2813 lws_serve_http_file_fragment(struct lws *wsi);
2816 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2819 * ##HTML chunked Substitution
2821 * APIs for receiving chunks of text, replacing a set of variable names via
2822 * a callback, and then prepending and appending HTML chunked encoding
2828 HTTP_STATUS_OK = 200,
2829 HTTP_STATUS_NO_CONTENT = 204,
2830 HTTP_STATUS_PARTIAL_CONTENT = 206,
2832 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2833 HTTP_STATUS_FOUND = 302,
2834 HTTP_STATUS_SEE_OTHER = 303,
2835 HTTP_STATUS_NOT_MODIFIED = 304,
2837 HTTP_STATUS_BAD_REQUEST = 400,
2838 HTTP_STATUS_UNAUTHORIZED,
2839 HTTP_STATUS_PAYMENT_REQUIRED,
2840 HTTP_STATUS_FORBIDDEN,
2841 HTTP_STATUS_NOT_FOUND,
2842 HTTP_STATUS_METHOD_NOT_ALLOWED,
2843 HTTP_STATUS_NOT_ACCEPTABLE,
2844 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2845 HTTP_STATUS_REQUEST_TIMEOUT,
2846 HTTP_STATUS_CONFLICT,
2848 HTTP_STATUS_LENGTH_REQUIRED,
2849 HTTP_STATUS_PRECONDITION_FAILED,
2850 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2851 HTTP_STATUS_REQ_URI_TOO_LONG,
2852 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2853 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2854 HTTP_STATUS_EXPECTATION_FAILED,
2856 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2857 HTTP_STATUS_NOT_IMPLEMENTED,
2858 HTTP_STATUS_BAD_GATEWAY,
2859 HTTP_STATUS_SERVICE_UNAVAILABLE,
2860 HTTP_STATUS_GATEWAY_TIMEOUT,
2861 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2864 struct lws_process_html_args {
2865 char *p; /**< pointer to the buffer containing the data */
2866 int len; /**< length of the original data at p */
2867 int max_len; /**< maximum length we can grow the data to */
2868 int final; /**< set if this is the last chunk of the file */
2871 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2873 struct lws_process_html_state {
2874 char *start; /**< pointer to start of match */
2875 char swallow[16]; /**< matched character buffer */
2876 int pos; /**< position in match */
2877 void *data; /**< opaque pointer */
2878 const char * const *vars; /**< list of variable names */
2879 int count_vars; /**< count of variable names */
2881 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2884 /*! lws_chunked_html_process() - generic chunked substitution
2885 * \param args: buffer to process using chunked encoding
2886 * \param s: current processing state
2888 LWS_VISIBLE LWS_EXTERN int
2889 lws_chunked_html_process(struct lws_process_html_args *args,
2890 struct lws_process_html_state *s);
2893 /** \defgroup HTTP-headers-read HTTP headers: read
2896 * ##HTTP header releated functions
2898 * In lws the client http headers are temporarily stored in a pool, only for the
2899 * duration of the http part of the handshake. It's because in most cases,
2900 * the header content is ignored for the whole rest of the connection lifetime
2901 * and would then just be taking up space needlessly.
2903 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2904 * the http headers are still allocated, you can use these apis then to
2905 * look at and copy out interesting header content (cookies, etc)
2907 * Notice that the header total length reported does not include a terminating
2908 * '\0', however you must allocate for it when using the _copy apis. So the
2909 * length reported for a header containing "123" is 3, but you must provide
2910 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2911 * will fail with a nonzero return code.
2913 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2914 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2915 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2916 * length to confirm the method.
2918 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2919 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2920 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2922 * As a convenience, lws has an api that will find the fragment with a
2923 * given name= part, lws_get_urlarg_by_name().
2927 /** struct lws_tokens
2928 * you need these to look at headers that have been parsed if using the
2929 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
2930 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
2931 * points to .token_len chars containing that header content.
2934 char *token; /**< pointer to start of the token */
2935 int token_len; /**< length of the token's value */
2938 /* enum lws_token_indexes
2939 * these have to be kept in sync with lextable.h / minilex.c
2941 * NOTE: These public enums are part of the abi. If you want to add one,
2942 * add it at where specified so existing users are unaffected.
2944 enum lws_token_indexes {
2945 WSI_TOKEN_GET_URI = 0,
2946 WSI_TOKEN_POST_URI = 1,
2947 WSI_TOKEN_OPTIONS_URI = 2,
2949 WSI_TOKEN_CONNECTION = 4,
2950 WSI_TOKEN_UPGRADE = 5,
2951 WSI_TOKEN_ORIGIN = 6,
2952 WSI_TOKEN_DRAFT = 7,
2953 WSI_TOKEN_CHALLENGE = 8,
2954 WSI_TOKEN_EXTENSIONS = 9,
2955 WSI_TOKEN_KEY1 = 10,
2956 WSI_TOKEN_KEY2 = 11,
2957 WSI_TOKEN_PROTOCOL = 12,
2958 WSI_TOKEN_ACCEPT = 13,
2959 WSI_TOKEN_NONCE = 14,
2960 WSI_TOKEN_HTTP = 15,
2961 WSI_TOKEN_HTTP2_SETTINGS = 16,
2962 WSI_TOKEN_HTTP_ACCEPT = 17,
2963 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2964 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2965 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2966 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2967 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2968 WSI_TOKEN_HTTP_PRAGMA = 23,
2969 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2970 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2971 WSI_TOKEN_HTTP_COOKIE = 26,
2972 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2973 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2974 WSI_TOKEN_HTTP_DATE = 29,
2975 WSI_TOKEN_HTTP_RANGE = 30,
2976 WSI_TOKEN_HTTP_REFERER = 31,
2978 WSI_TOKEN_VERSION = 33,
2979 WSI_TOKEN_SWORIGIN = 34,
2981 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2982 WSI_TOKEN_HTTP_COLON_METHOD = 36,
2983 WSI_TOKEN_HTTP_COLON_PATH = 37,
2984 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2985 WSI_TOKEN_HTTP_COLON_STATUS = 39,
2987 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2988 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2989 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2990 WSI_TOKEN_HTTP_AGE = 43,
2991 WSI_TOKEN_HTTP_ALLOW = 44,
2992 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2993 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2994 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2995 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2996 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2997 WSI_TOKEN_HTTP_ETAG = 50,
2998 WSI_TOKEN_HTTP_EXPECT = 51,
2999 WSI_TOKEN_HTTP_EXPIRES = 52,
3000 WSI_TOKEN_HTTP_FROM = 53,
3001 WSI_TOKEN_HTTP_IF_MATCH = 54,
3002 WSI_TOKEN_HTTP_IF_RANGE = 55,
3003 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
3004 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
3005 WSI_TOKEN_HTTP_LINK = 58,
3006 WSI_TOKEN_HTTP_LOCATION = 59,
3007 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
3008 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
3009 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
3010 WSI_TOKEN_HTTP_REFRESH = 63,
3011 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
3012 WSI_TOKEN_HTTP_SERVER = 65,
3013 WSI_TOKEN_HTTP_SET_COOKIE = 66,
3014 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
3015 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
3016 WSI_TOKEN_HTTP_USER_AGENT = 69,
3017 WSI_TOKEN_HTTP_VARY = 70,
3018 WSI_TOKEN_HTTP_VIA = 71,
3019 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
3021 WSI_TOKEN_PATCH_URI = 73,
3022 WSI_TOKEN_PUT_URI = 74,
3023 WSI_TOKEN_DELETE_URI = 75,
3025 WSI_TOKEN_HTTP_URI_ARGS = 76,
3026 WSI_TOKEN_PROXY = 77,
3027 WSI_TOKEN_HTTP_X_REAL_IP = 78,
3028 WSI_TOKEN_HTTP1_0 = 79,
3029 WSI_TOKEN_X_FORWARDED_FOR = 80,
3030 WSI_TOKEN_CONNECT = 81,
3031 /****** add new things just above ---^ ******/
3033 /* use token storage to stash these internally, not for
3036 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
3037 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
3038 _WSI_TOKEN_CLIENT_URI,
3039 _WSI_TOKEN_CLIENT_HOST,
3040 _WSI_TOKEN_CLIENT_ORIGIN,
3041 _WSI_TOKEN_CLIENT_METHOD,
3042 _WSI_TOKEN_CLIENT_IFACE,
3044 /* always last real token index*/
3047 /* parser state additions, no storage associated */
3048 WSI_TOKEN_NAME_PART,
3050 WSI_TOKEN_SKIPPING_SAW_CR,
3051 WSI_PARSING_COMPLETE,
3052 WSI_INIT_TOKEN_MUXURL,
3055 struct lws_token_limits {
3056 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
3060 * lws_token_to_string() - returns a textual representation of a hdr token index
3062 * \param: token index
3064 LWS_VISIBLE LWS_EXTERN const unsigned char *
3065 lws_token_to_string(enum lws_token_indexes token);
3069 * lws_hdr_total_length: report length of all fragments of a header totalled up
3070 * The returned length does not include the space for a
3073 * \param wsi: websocket connection
3074 * \param h: which header index we are interested in
3076 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3077 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
3080 * lws_hdr_fragment_length: report length of a single fragment of a header
3081 * The returned length does not include the space for a
3084 * \param wsi: websocket connection
3085 * \param h: which header index we are interested in
3086 * \param frag_idx: which fragment of h we want to get the length of
3088 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3089 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
3092 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
3093 * The buffer length len must include space for an additional
3094 * terminating '\0', or it will fail returning -1.
3096 * \param wsi: websocket connection
3097 * \param dest: destination buffer
3098 * \param len: length of destination buffer
3099 * \param h: which header index we are interested in
3101 * copies the whole, aggregated header, even if it was delivered in
3102 * several actual headers piece by piece
3104 LWS_VISIBLE LWS_EXTERN int
3105 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
3108 * lws_hdr_copy_fragment() - copy a single fragment of the given header to a buffer
3109 * The buffer length len must include space for an additional
3110 * terminating '\0', or it will fail returning -1.
3111 * If the requested fragment index is not present, it fails
3114 * \param wsi: websocket connection
3115 * \param dest: destination buffer
3116 * \param len: length of destination buffer
3117 * \param h: which header index we are interested in
3118 * \param frag_idx: which fragment of h we want to copy
3120 * Normally this is only useful
3121 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
3122 * fragment 0 will contain "x=1" and fragment 1 "y=2"
3124 LWS_VISIBLE LWS_EXTERN int
3125 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
3126 enum lws_token_indexes h, int frag_idx);
3129 * lws_get_urlarg_by_name() - return pointer to arg value if present
3130 * \param wsi: the connection to check
3131 * \param name: the arg name, like "token="
3132 * \param buf: the buffer to receive the urlarg (including the name= part)
3133 * \param len: the length of the buffer to receive the urlarg
3135 * Returns NULL if not found or a pointer inside buf to just after the
3138 LWS_VISIBLE LWS_EXTERN const char *
3139 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
3142 /*! \defgroup HTTP-headers-create HTTP headers: create
3144 * ## HTTP headers: Create
3146 * These apis allow you to create HTTP response headers in a way compatible with
3147 * both HTTP/1.x and HTTP/2.
3149 * They each append to a buffer taking care about the buffer end, which is
3150 * passed in as a pointer. When data is written to the buffer, the current
3151 * position p is updated accordingly.
3153 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3154 * and fail with nonzero return.
3158 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3159 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3162 * lws_add_http_header_status() - add the HTTP response status code
3164 * \param wsi: the connection to check
3165 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3166 * \param p: pointer to current position in buffer pointer
3167 * \param end: pointer to end of buffer
3169 * Adds the initial response code, so should be called first.
3171 * Code may additionally take OR'd flags:
3173 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3175 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3176 lws_add_http_header_status(struct lws *wsi,
3177 unsigned int code, unsigned char **p,
3178 unsigned char *end);
3180 * lws_add_http_header_by_name() - append named header and value
3182 * \param wsi: the connection to check
3183 * \param name: the hdr name, like "my-header"
3184 * \param value: the value after the = for this header
3185 * \param length: the length of the value
3186 * \param p: pointer to current position in buffer pointer
3187 * \param end: pointer to end of buffer
3189 * Appends name: value to the headers
3191 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3192 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3193 const unsigned char *value, int length,
3194 unsigned char **p, unsigned char *end);
3196 * lws_add_http_header_by_token() - append given header and value
3198 * \param wsi: the connection to check
3199 * \param token: the token index for the hdr
3200 * \param value: the value after the = for this header
3201 * \param length: the length of the value
3202 * \param p: pointer to current position in buffer pointer
3203 * \param end: pointer to end of buffer
3205 * Appends name=value to the headers, but is able to take advantage of better
3206 * HTTP/2 coding mechanisms where possible.
3208 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3209 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3210 const unsigned char *value, int length,
3211 unsigned char **p, unsigned char *end);
3213 * lws_add_http_header_content_length() - append content-length helper
3215 * \param wsi: the connection to check
3216 * \param content_length: the content length to use
3217 * \param p: pointer to current position in buffer pointer
3218 * \param end: pointer to end of buffer
3220 * Appends content-length: content_length to the headers
3222 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3223 lws_add_http_header_content_length(struct lws *wsi,
3224 lws_filepos_t content_length,
3225 unsigned char **p, unsigned char *end);
3227 * lws_finalize_http_header() - terminate header block
3229 * \param wsi: the connection to check
3230 * \param p: pointer to current position in buffer pointer
3231 * \param end: pointer to end of buffer
3233 * Indicates no more headers will be added
3235 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3236 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3237 unsigned char *end);
3240 /** \defgroup form-parsing Form Parsing
3242 * ##POSTed form parsing functions
3244 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3245 * POSTed form arguments, both using simple urlencoded and multipart transfer
3248 * It's capable of handling file uploads as well a named input parsing,
3249 * and the apis are the same for both form upload styles.
3251 * You feed it a list of parameter names and it creates pointers to the
3252 * urldecoded arguments: file upload parameters pass the file data in chunks to
3253 * a user-supplied callback as they come.
3255 * Since it's stateful, it handles the incoming data needing more than one
3256 * POST_BODY callback and has no limit on uploaded file size.
3260 /** enum lws_spa_fileupload_states */
3261 enum lws_spa_fileupload_states {
3263 /**< a chunk of file content has arrived */
3264 LWS_UFS_FINAL_CONTENT,
3265 /**< the last chunk (possibly zero length) of file content has arrived */
3267 /**< a new file is starting to arrive */
3271 * lws_spa_fileupload_cb() - callback to receive file upload data
3273 * \param data: opt_data pointer set in lws_spa_create
3274 * \param name: name of the form field being uploaded
3275 * \param filename: original filename from client
3276 * \param buf: start of data to receive
3277 * \param len: length of data to receive
3278 * \param state: information about how this call relates to file
3280 * Notice name and filename shouldn't be trusted, as they are passed from
3281 * HTTP provided by the client.
3283 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3284 const char *filename, char *buf, int len,
3285 enum lws_spa_fileupload_states state);
3287 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3288 * and file uploads */
3292 * lws_spa_create() - create urldecode parser
3294 * \param wsi: lws connection (used to find Content Type)
3295 * \param param_names: array of form parameter names, like "username"
3296 * \param count_params: count of param_names
3297 * \param max_storage: total amount of form parameter values we can store
3298 * \param opt_cb: NULL, or callback to receive file upload data.
3299 * \param opt_data: NULL, or user pointer provided to opt_cb.
3301 * Creates a urldecode parser and initializes it.
3303 * opt_cb can be NULL if you just want normal name=value parsing, however
3304 * if one or more entries in your form are bulk data (file transfer), you
3305 * can provide this callback and filter on the name callback parameter to
3306 * treat that urldecoded data separately. The callback should return -1
3307 * in case of fatal error, and 0 if OK.
3309 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3310 lws_spa_create(struct lws *wsi, const char * const *param_names,
3311 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3315 * lws_spa_process() - parses a chunk of input data
3317 * \param spa: the parser object previously created
3318 * \param in: incoming, urlencoded data
3319 * \param len: count of bytes valid at \param in
3321 LWS_VISIBLE LWS_EXTERN int
3322 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3325 * lws_spa_finalize() - indicate incoming data completed
3327 * \param spa: the parser object previously created
3329 LWS_VISIBLE LWS_EXTERN int
3330 lws_spa_finalize(struct lws_spa *spa);
3333 * lws_spa_get_length() - return length of parameter value
3335 * \param spa: the parser object previously created
3336 * \param n: parameter ordinal to return length of value for
3338 LWS_VISIBLE LWS_EXTERN int
3339 lws_spa_get_length(struct lws_spa *spa, int n);
3342 * lws_spa_get_string() - return pointer to parameter value
3343 * \param spa: the parser object previously created
3344 * \param n: parameter ordinal to return pointer to value for
3346 LWS_VISIBLE LWS_EXTERN const char *
3347 lws_spa_get_string(struct lws_spa *spa, int n);
3350 * lws_spa_destroy() - destroy parser object
3352 * \param spa: the parser object previously created
3354 LWS_VISIBLE LWS_EXTERN int
3355 lws_spa_destroy(struct lws_spa *spa);
3358 /*! \defgroup urlendec Urlencode and Urldecode
3361 * ##HTML chunked Substitution
3363 * APIs for receiving chunks of text, replacing a set of variable names via
3364 * a callback, and then prepending and appending HTML chunked encoding
3370 * lws_urlencode() - like strncpy but with urlencoding
3372 * \param escaped: output buffer
3373 * \param string: input buffer ('/0' terminated)
3374 * \param len: output buffer max length
3376 * Because urlencoding expands the output string, it's not
3377 * possible to do it in-place, ie, with escaped == string
3379 LWS_VISIBLE LWS_EXTERN const char *
3380 lws_urlencode(char *escaped, const char *string, int len);
3385 * This simple urldecode only operates until the first '\0' and requires the
3386 * data to exist all at once
3389 * lws_urldecode() - like strncpy but with urldecoding
3391 * \param string: output buffer
3392 * \param escaped: input buffer ('\0' terminated)
3393 * \param len: output buffer max length
3395 * This is only useful for '\0' terminated strings
3397 * Since urldecoding only shrinks the output string, it is possible to
3398 * do it in-place, ie, string == escaped
3400 LWS_VISIBLE LWS_EXTERN int
3401 lws_urldecode(char *string, const char *escaped, int len);
3404 * lws_return_http_status() - Return simple http status
3405 * \param wsi: Websocket instance (available from user callback)
3406 * \param code: Status index, eg, 404
3407 * \param html_body: User-readable HTML description < 1KB, or NULL
3409 * Helper to report HTTP errors back to the client cleanly and
3412 LWS_VISIBLE LWS_EXTERN int
3413 lws_return_http_status(struct lws *wsi, unsigned int code,
3414 const char *html_body);
3417 * lws_http_redirect() - write http redirect into buffer
3419 * \param wsi: websocket connection
3420 * \param code: HTTP response code (eg, 301)
3421 * \param loc: where to redirect to
3422 * \param len: length of loc
3423 * \param p: pointer current position in buffer (updated as we write)
3424 * \param end: pointer to end of buffer
3426 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3427 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3428 unsigned char **p, unsigned char *end);
3431 * lws_http_transaction_completed() - wait for new http transaction or close
3432 * \param wsi: websocket connection
3434 * Returns 1 if the HTTP connection must close now
3435 * Returns 0 and resets connection to wait for new HTTP header /
3436 * transaction if possible
3438 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3439 lws_http_transaction_completed(struct lws *wsi);
3442 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3444 * ##Sanitize / purify SQL and JSON helpers
3446 * APIs for escaping untrusted JSON and SQL safely before use
3451 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3453 * \param escaped: output buffer
3454 * \param string: input buffer ('/0' terminated)
3455 * \param len: output buffer max length
3457 * Because escaping expands the output string, it's not
3458 * possible to do it in-place, ie, with escaped == string
3460 LWS_VISIBLE LWS_EXTERN const char *
3461 lws_sql_purify(char *escaped, const char *string, int len);
3464 * lws_json_purify() - like strncpy but with escaping for json chars
3466 * \param escaped: output buffer
3467 * \param string: input buffer ('/0' terminated)
3468 * \param len: output buffer max length
3470 * Because escaping expands the output string, it's not
3471 * possible to do it in-place, ie, with escaped == string
3473 LWS_VISIBLE LWS_EXTERN const char *
3474 lws_json_purify(char *escaped, const char *string, int len);
3477 /*! \defgroup ev libev helpers
3481 * APIs specific to libev event loop itegration
3485 #ifdef LWS_USE_LIBEV
3486 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3488 LWS_VISIBLE LWS_EXTERN int
3489 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3490 lws_ev_signal_cb_t *cb);
3492 LWS_VISIBLE LWS_EXTERN int
3493 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3495 LWS_VISIBLE LWS_EXTERN void
3496 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3497 #endif /* LWS_USE_LIBEV */
3501 /*! \defgroup uv libuv helpers
3505 * APIs specific to libuv event loop itegration
3508 #ifdef LWS_USE_LIBUV
3509 LWS_VISIBLE LWS_EXTERN int
3510 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3513 LWS_VISIBLE LWS_EXTERN void
3514 lws_libuv_run(const struct lws_context *context, int tsi);
3516 LWS_VISIBLE LWS_EXTERN void
3517 lws_libuv_stop(struct lws_context *context);
3519 LWS_VISIBLE LWS_EXTERN void
3520 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3522 LWS_VISIBLE LWS_EXTERN int
3523 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3525 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3526 lws_uv_getloop(struct lws_context *context, int tsi);
3528 LWS_VISIBLE LWS_EXTERN void
3529 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3530 #endif /* LWS_USE_LIBUV */
3533 /*! \defgroup event libevent helpers
3535 * ##libevent helpers
3537 * APIs specific to libevent event loop itegration
3541 #ifdef LWS_USE_LIBEVENT
3542 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3545 LWS_VISIBLE LWS_EXTERN int
3546 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3547 lws_event_signal_cb_t cb);
3549 LWS_VISIBLE LWS_EXTERN int
3550 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3553 LWS_VISIBLE LWS_EXTERN void
3554 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3556 #endif /* LWS_USE_LIBEVENT */
3560 /*! \defgroup timeout Connection timeouts
3562 APIs related to setting connection timeouts
3567 * NOTE: These public enums are part of the abi. If you want to add one,
3568 * add it at where specified so existing users are unaffected.
3570 enum pending_timeout {
3571 NO_PENDING_TIMEOUT = 0,
3572 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3573 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3574 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3575 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3576 PENDING_TIMEOUT_AWAITING_PING = 5,
3577 PENDING_TIMEOUT_CLOSE_ACK = 6,
3578 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3579 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3580 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3581 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3582 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3583 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3584 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3585 PENDING_TIMEOUT_CGI = 14,
3586 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3587 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3588 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3589 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3590 PENDING_TIMEOUT_AWAITING_SOCKS_GREETING_REPLY = 19,
3591 PENDING_TIMEOUT_AWAITING_SOCKS_CONNECT_REPLY = 20,
3592 PENDING_TIMEOUT_AWAITING_SOCKS_AUTH_REPLY = 21,
3593 PENDING_TIMEOUT_KILLED_BY_SSL_INFO = 22,
3595 /****** add new things just above ---^ ******/
3599 * lws_set_timeout() - marks the wsi as subject to a timeout
3601 * You will not need this unless you are doing something special
3603 * \param wsi: Websocket connection instance
3604 * \param reason: timeout reason
3605 * \param secs: how many seconds
3607 LWS_VISIBLE LWS_EXTERN void
3608 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3611 /*! \defgroup sending-data Sending data
3613 APIs related to writing data on a connection
3616 #if !defined(LWS_SIZEOFPTR)
3617 #define LWS_SIZEOFPTR (sizeof (void *))
3619 #if !defined(u_int64_t)
3620 #define u_int64_t unsigned long long
3623 #if defined(__x86_64__)
3624 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3626 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3628 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3629 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3630 #define LWS_PRE _LWS_PAD(4 + 10)
3631 /* used prior to 1.7 and retained for backward compatibility */
3632 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3633 #define LWS_SEND_BUFFER_POST_PADDING 0
3636 * NOTE: These public enums are part of the abi. If you want to add one,
3637 * add it at where specified so existing users are unaffected.
3639 enum lws_write_protocol {
3641 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3642 * memory behind it. The receiver expects only valid utf-8 in the
3644 LWS_WRITE_BINARY = 1,
3645 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3646 * memory behind it. Any sequence of bytes is valid */
3647 LWS_WRITE_CONTINUATION = 2,
3648 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3649 * memory behind it */
3651 /**< Send HTTP content */
3653 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3657 /* Same as write_http but we know this write ends the transaction */
3658 LWS_WRITE_HTTP_FINAL = 7,
3662 LWS_WRITE_HTTP_HEADERS = 8,
3663 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3664 * payload differently, http 1.x links also handle this correctly. so
3665 * to be compatible with both in the future,header response part should
3666 * be sent using this regardless of http version expected)
3669 /****** add new things just above ---^ ******/
3673 LWS_WRITE_NO_FIN = 0x40,
3674 /**< This part of the message is not the end of the message */
3676 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3677 /**< client packet payload goes out on wire unmunged
3678 * only useful for security tests since normal servers cannot
3679 * decode the content if used */
3684 * lws_write() - Apply protocol then write data to client
3685 * \param wsi: Websocket instance (available from user callback)
3686 * \param buf: The data to send. For data being sent on a websocket
3687 * connection (ie, not default http), this buffer MUST have
3688 * LWS_PRE bytes valid BEFORE the pointer.
3689 * This is so the protocol header data can be added in-situ.
3690 * \param len: Count of the data bytes in the payload starting from buf
3691 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3692 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3693 * data on a websockets connection. Remember to allow the extra
3694 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3697 * This function provides the way to issue data back to the client
3698 * for both http and websocket protocols.
3702 * When sending with websocket protocol
3706 * LWS_WRITE_CONTINUATION,
3710 * the send buffer has to have LWS_PRE bytes valid BEFORE
3711 * the buffer pointer you pass to lws_write().
3713 * This allows us to add protocol info before and after the data, and send as
3714 * one packet on the network without payload copying, for maximum efficiency.
3716 * So for example you need this kind of code to use lws_write with a
3719 * char buf[LWS_PRE + 128];
3721 * // fill your part of the buffer... for example here it's all zeros
3722 * memset(&buf[LWS_PRE], 0, 128);
3724 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3726 * When sending HTTP, with
3729 * LWS_WRITE_HTTP_HEADERS
3730 * LWS_WRITE_HTTP_FINAL
3732 * there is no protocol data prepended, and don't need to take care about the
3733 * LWS_PRE bytes valid before the buffer pointer.
3735 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3736 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3737 * The example apps no longer use it.
3739 * Pad LWS_PRE to the CPU word size, so that word references
3740 * to the address immediately after the padding won't cause an unaligned access
3741 * error. Sometimes for performance reasons the recommended padding is even
3742 * larger than sizeof(void *).
3744 * In the case of sending using websocket protocol, be sure to allocate
3745 * valid storage before and after buf as explained above. This scheme
3746 * allows maximum efficiency of sending data and protocol in a single
3747 * packet while not burdening the user code with any protocol knowledge.
3749 * Return may be -1 for a fatal error needing connection close, or the
3750 * number of bytes sent.
3755 * The OS may not accept everything you asked to write on the connection.
3757 * Posix defines POLLOUT indication from poll() to show that the connection
3758 * will accept more write data, but it doesn't specifiy how much. It may just
3759 * accept one byte of whatever you wanted to send.
3761 * LWS will buffer the remainder automatically, and send it out autonomously.
3763 * During that time, WRITABLE callbacks will be suppressed.
3765 * This is to handle corner cases where unexpectedly the OS refuses what we
3766 * usually expect it to accept. You should try to send in chunks that are
3767 * almost always accepted in order to avoid the inefficiency of the buffering.
3769 LWS_VISIBLE LWS_EXTERN int
3770 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3771 enum lws_write_protocol protocol);
3773 /* helper for case where buffer may be const */
3774 #define lws_write_http(wsi, buf, len) \
3775 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3778 /** \defgroup callback-when-writeable Callback when writeable
3780 * ##Callback When Writeable
3782 * lws can only write data on a connection when it is able to accept more
3783 * data without blocking.
3785 * So a basic requirement is we should only use the lws_write() apis when the
3786 * connection we want to write on says that he can accept more data.
3788 * When lws cannot complete your send at the time, it will buffer the data
3789 * and send it in the background, suppressing any further WRITEABLE callbacks
3790 * on that connection until it completes. So it is important to write new
3791 * things in a new writeable callback.
3793 * These apis reflect the various ways we can indicate we would like to be
3794 * called back when one or more connections is writeable.
3799 * lws_callback_on_writable() - Request a callback when this socket
3800 * becomes able to be written to without
3803 * \param wsi: Websocket connection instance to get callback for
3805 * - Which: only this wsi
3806 * - When: when the individual connection becomes writeable
3807 * - What: LWS_CALLBACK_*_WRITEABLE
3809 LWS_VISIBLE LWS_EXTERN int
3810 lws_callback_on_writable(struct lws *wsi);
3813 * lws_callback_on_writable_all_protocol() - Request a callback for all
3814 * connections on same vhost using the given protocol when it
3815 * becomes possible to write to each socket without
3818 * \param context: lws_context
3819 * \param protocol: Protocol whose connections will get callbacks
3821 * - Which: connections using this protocol on ANY VHOST
3822 * - When: when the individual connection becomes writeable
3823 * - What: LWS_CALLBACK_*_WRITEABLE
3825 LWS_VISIBLE LWS_EXTERN int
3826 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3827 const struct lws_protocols *protocol);
3830 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3831 * all connections using the given protocol when it
3832 * becomes possible to write to each socket without
3835 * \param vhost: Only consider connections on this lws_vhost
3836 * \param protocol: Protocol whose connections will get callbacks
3838 * - Which: connections using this protocol on GIVEN VHOST ONLY
3839 * - When: when the individual connection becomes writeable
3840 * - What: LWS_CALLBACK_*_WRITEABLE
3842 LWS_VISIBLE LWS_EXTERN int
3843 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3844 const struct lws_protocols *protocol);
3847 * lws_callback_all_protocol() - Callback all connections using
3848 * the given protocol with the given reason
3850 * \param context: lws_context
3851 * \param protocol: Protocol whose connections will get callbacks
3852 * \param reason: Callback reason index
3854 * - Which: connections using this protocol on ALL VHOSTS
3855 * - When: before returning
3858 * This isn't normally what you want... normally any update of connection-
3859 * specific information can wait until a network-related callback like rx,
3860 * writable, or close.
3862 LWS_VISIBLE LWS_EXTERN int
3863 lws_callback_all_protocol(struct lws_context *context,
3864 const struct lws_protocols *protocol, int reason);
3867 * lws_callback_all_protocol_vhost() - Callback all connections using
3868 * the given protocol with the given reason
3870 * \param vh: Vhost whose connections will get callbacks
3871 * \param protocol: Which protocol to match
3872 * \param reason: Callback reason index
3874 * - Which: connections using this protocol on GIVEN VHOST ONLY
3878 LWS_VISIBLE LWS_EXTERN int
3879 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3880 const struct lws_protocols *protocol, int reason);
3883 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3884 * with the given reason
3886 * \param wsi: wsi whose vhost will get callbacks
3887 * \param reason: Callback reason index
3888 * \param in: in argument to callback
3889 * \param len: len argument to callback
3891 * - Which: connections using this protocol on same VHOST as wsi ONLY
3895 LWS_VISIBLE LWS_EXTERN int
3896 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3898 LWS_VISIBLE LWS_EXTERN int
3899 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3900 void *user, void *in, size_t len);
3903 * lws_get_socket_fd() - returns the socket file descriptor
3905 * You will not need this unless you are doing something special
3907 * \param wsi: Websocket connection instance
3909 LWS_VISIBLE LWS_EXTERN int
3910 lws_get_socket_fd(struct lws *wsi);
3913 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
3916 * \param wsi: Websocket connection instance
3918 * if the protocol does not have any guidance, returns -1. Currently only
3919 * http2 connections get send window information from this API. But your code
3920 * should use it so it can work properly with any protocol.
3922 * If nonzero return is the amount of payload data the peer or intermediary has
3923 * reported it has buffer space for. That has NO relationship with the amount
3924 * of buffer space your OS can accept on this connection for a write action.
3926 * This number represents the maximum you could send to the peer or intermediary
3927 * on this connection right now without the protocol complaining.
3929 * lws manages accounting for send window updates and payload writes
3930 * automatically, so this number reflects the situation at the peer or
3931 * intermediary dynamically.
3933 LWS_VISIBLE LWS_EXTERN size_t
3934 lws_get_peer_write_allowance(struct lws *wsi);
3938 * lws_rx_flow_control() - Enable and disable socket servicing for
3941 * If the output side of a server process becomes choked, this allows flow
3942 * control for the input side.
3944 * \param wsi: Websocket connection instance to get callback for
3945 * \param enable: 0 = disable read servicing for this connection, 1 = enable
3947 LWS_VISIBLE LWS_EXTERN int
3948 lws_rx_flow_control(struct lws *wsi, int enable);
3951 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
3953 * When the user server code realizes it can accept more input, it can
3954 * call this to have the RX flow restriction removed from all connections using
3955 * the given protocol.
3956 * \param context: lws_context
3957 * \param protocol: all connections using this protocol will be allowed to receive
3959 LWS_VISIBLE LWS_EXTERN void
3960 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3961 const struct lws_protocols *protocol);
3964 * lws_remaining_packet_payload() - Bytes to come before "overall"
3965 * rx packet is complete
3966 * \param wsi: Websocket instance (available from user callback)
3968 * This function is intended to be called from the callback if the
3969 * user code is interested in "complete packets" from the client.
3970 * libwebsockets just passes through payload as it comes and issues a buffer
3971 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
3972 * callback handler can use this API to find out if the buffer it has just
3973 * been given is the last piece of a "complete packet" from the client --
3974 * when that is the case lws_remaining_packet_payload() will return
3977 * Many protocols won't care becuse their packets are always small.
3979 LWS_VISIBLE LWS_EXTERN size_t
3980 lws_remaining_packet_payload(struct lws *wsi);
3983 /** \defgroup sock-adopt Socket adoption helpers
3984 * ##Socket adoption helpers
3986 * When integrating with an external app with its own event loop, these can
3987 * be used to accept connections from someone else's listening socket.
3989 * When using lws own event loop, these are not needed.
3994 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
3995 * for the default vhost of context.
3996 * \param context: lws context
3997 * \param accept_fd: fd of already-accepted socket to adopt
3999 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4000 * returns NULL, having cleaned up any new wsi pieces.
4002 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4003 * to ws or just serve http.
4005 LWS_VISIBLE LWS_EXTERN struct lws *
4006 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
4008 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
4010 * \param vhost: lws vhost
4011 * \param accept_fd: fd of already-accepted socket to adopt
4013 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4014 * returns NULL, having cleaned up any new wsi pieces.
4016 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4017 * to ws or just serve http.
4019 LWS_VISIBLE LWS_EXTERN struct lws *
4020 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
4023 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
4024 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
4025 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
4026 LWS_ADOPT_ALLOW_SSL = 4 /* flag: if set requires LWS_ADOPT_SOCKET */
4027 } lws_adoption_type;
4030 lws_sockfd_type sockfd;
4031 lws_filefd_type filefd;
4032 } lws_sock_file_fd_type;
4035 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
4036 * if socket descriptor, should already have been accepted from listen socket
4038 * \param vhost: lws vhost
4039 * \param type: OR-ed combinations of lws_adoption_type flags
4040 * \param fd: union with either .sockfd or .filefd set
4041 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
4042 * \param parent: NULL or struct lws to attach new_wsi to as a child
4044 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4045 * returns NULL, having cleaned up any new wsi pieces.
4047 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
4048 * ready to accept an upgrade to ws or just serve http.
4050 * parent may be NULL, if given it should be an existing wsi that will become the
4051 * parent of the new wsi created by this call.
4053 LWS_VISIBLE struct lws *
4054 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
4055 lws_sock_file_fd_type fd, const char *vh_prot_name,
4056 struct lws *parent);
4059 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
4060 * for the default vhost of context.
4061 * \param context: lws context
4062 * \param accept_fd: fd of already-accepted socket to adopt
4063 * \param readbuf: NULL or pointer to data that must be drained before reading from
4065 * \param len: The length of the data held at \param readbuf
4067 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4068 * returns NULL, having cleaned up any new wsi pieces.
4070 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4071 * to ws or just serve http.
4073 * If your external code did not already read from the socket, you can use
4074 * lws_adopt_socket() instead.
4076 * This api is guaranteed to use the data at \param readbuf first, before reading from
4079 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4081 LWS_VISIBLE LWS_EXTERN struct lws *
4082 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
4083 const char *readbuf, size_t len);
4085 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
4086 * accepted it for vhost.
4087 * \param vhost: lws vhost
4088 * \param accept_fd: fd of already-accepted socket to adopt
4089 * \param readbuf: NULL or pointer to data that must be drained before reading from
4091 * \param len: The length of the data held at \param readbuf
4093 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4094 * returns NULL, having cleaned up any new wsi pieces.
4096 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4097 * to ws or just serve http.
4099 * If your external code did not already read from the socket, you can use
4100 * lws_adopt_socket() instead.
4102 * This api is guaranteed to use the data at \param readbuf first, before reading from
4105 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4107 LWS_VISIBLE LWS_EXTERN struct lws *
4108 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
4109 const char *readbuf, size_t len);
4112 /** \defgroup net Network related helper APIs
4113 * ##Network related helper APIs
4115 * These wrap miscellaneous useful network-related functions
4120 * lws_canonical_hostname() - returns this host's hostname
4122 * This is typically used by client code to fill in the host parameter
4123 * when making a client connection. You can only call it after the context
4126 * \param context: Websocket context
4128 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4129 lws_canonical_hostname(struct lws_context *context);
4132 * lws_get_peer_addresses() - Get client address information
4133 * \param wsi: Local struct lws associated with
4134 * \param fd: Connection socket descriptor
4135 * \param name: Buffer to take client address name
4136 * \param name_len: Length of client address name buffer
4137 * \param rip: Buffer to take client address IP dotted quad
4138 * \param rip_len: Length of client address IP buffer
4140 * This function fills in name and rip with the name and IP of
4141 * the client connected with socket descriptor fd. Names may be
4142 * truncated if there is not enough room. If either cannot be
4143 * determined, they will be returned as valid zero-length strings.
4145 LWS_VISIBLE LWS_EXTERN void
4146 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
4147 int name_len, char *rip, int rip_len);
4150 * lws_get_peer_simple() - Get client address information without RDNS
4152 * \param wsi: Local struct lws associated with
4153 * \param name: Buffer to take client address name
4154 * \param namelen: Length of client address name buffer
4156 * This provides a 123.123.123.123 type IP address in name from the
4157 * peer that has connected to wsi
4159 LWS_VISIBLE LWS_EXTERN const char *
4160 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4161 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4163 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4165 * \param ipv6: Allow IPV6 addresses
4166 * \param ifname: Interface name or IP
4167 * \param addr: struct sockaddr_in * to be written
4168 * \param addrlen: Length of addr
4170 * This converts a textual network interface name to a sockaddr usable by
4171 * other network functions
4173 LWS_VISIBLE LWS_EXTERN int
4174 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4179 /** \defgroup misc Miscellaneous APIs
4180 * ##Miscellaneous APIs
4182 * Various APIs outside of other categories
4187 * lws_snprintf(): snprintf that truncates the returned length too
4189 * \param str: destination buffer
4190 * \param size: bytes left in destination buffer
4191 * \param format: format string
4192 * \param ...: args for format
4194 * This lets you correctly truncate buffers by concatenating lengths, if you
4195 * reach the limit the reported length doesn't exceed the limit.
4197 LWS_VISIBLE LWS_EXTERN int
4198 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4201 * lws_get_random(): fill a buffer with platform random data
4203 * \param context: the lws context
4204 * \param buf: buffer to fill
4205 * \param len: how much to fill
4207 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4208 * it's interested to see if the frame it's dealing with was sent in binary
4211 LWS_VISIBLE LWS_EXTERN int
4212 lws_get_random(struct lws_context *context, void *buf, int len);
4214 * lws_daemonize(): make current process run in the background
4216 * \param _lock_path: the filepath to write the lock file
4218 * Spawn lws as a background process, taking care of various things
4220 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4221 lws_daemonize(const char *_lock_path);
4223 * lws_get_library_version(): return string describing the version of lws
4225 * On unix, also includes the git describe
4227 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4228 lws_get_library_version(void);
4231 * lws_wsi_user() - get the user data associated with the connection
4232 * \param wsi: lws connection
4234 * Not normally needed since it's passed into the callback
4236 LWS_VISIBLE LWS_EXTERN void *
4237 lws_wsi_user(struct lws *wsi);
4240 * lws_wsi_set_user() - set the user data associated with the client connection
4241 * \param wsi: lws connection
4242 * \param user: user data
4244 * By default lws allocates this and it's not legal to externally set it
4245 * yourself. However client connections may have it set externally when the
4246 * connection is created... if so, this api can be used to modify it at
4247 * runtime additionally.
4249 LWS_VISIBLE LWS_EXTERN void
4250 lws_set_wsi_user(struct lws *wsi, void *user);
4253 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4254 * Notice it does so by dropping '\0' into input string
4255 * and the leading / on the path is consequently lost
4257 * \param p: incoming uri string.. will get written to
4258 * \param prot: result pointer for protocol part (https://)
4259 * \param ads: result pointer for address part
4260 * \param port: result pointer for port part
4261 * \param path: result pointer for path part
4263 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4264 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4268 * lws_now_secs(): return seconds since 1970-1-1
4270 LWS_VISIBLE LWS_EXTERN unsigned long
4274 * lws_get_context - Allow geting lws_context from a Websocket connection
4277 * With this function, users can access context in the callback function.
4278 * Otherwise users may have to declare context as a global variable.
4280 * \param wsi: Websocket connection instance
4282 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4283 lws_get_context(const struct lws *wsi);
4286 * lws_get_count_threads(): how many service threads the context uses
4288 * \param context: the lws context
4290 * By default this is always 1, if you asked for more than lws can handle it
4291 * will clip the number of threads. So you can use this to find out how many
4292 * threads are actually in use.
4294 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4295 lws_get_count_threads(struct lws_context *context);
4298 * lws_get_parent() - get parent wsi or NULL
4299 * \param wsi: lws connection
4301 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4302 * this allows you to get their parent.
4304 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4305 lws_get_parent(const struct lws *wsi);
4308 * lws_get_child() - get child wsi or NULL
4309 * \param wsi: lws connection
4311 * Allows you to find a related wsi from the parent wsi.
4313 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4314 lws_get_child(const struct lws *wsi);
4318 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4319 * It's provided in case it is
4320 * useful when integrating with other app poll loop service code.
4322 LWS_VISIBLE LWS_EXTERN int
4323 lws_read(struct lws *wsi, unsigned char *buf, lws_filepos_t len);
4326 * lws_set_allocator() - custom allocator support
4330 * Allows you to replace the allocator (and deallocator) used by lws
4332 LWS_VISIBLE LWS_EXTERN void
4333 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4336 /** \defgroup wsstatus Websocket status APIs
4337 * ##Websocket connection status APIs
4339 * These provide information about ws connection or message status
4343 * lws_send_pipe_choked() - tests if socket is writable or not
4344 * \param wsi: lws connection
4346 * Allows you to check if you can write more on the socket
4348 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4349 lws_send_pipe_choked(struct lws *wsi);
4352 * lws_is_final_fragment() - tests if last part of ws message
4353 * \param wsi: lws connection
4355 LWS_VISIBLE LWS_EXTERN int
4356 lws_is_final_fragment(struct lws *wsi);
4359 * lws_get_reserved_bits() - access reserved bits of ws frame
4360 * \param wsi: lws connection
4362 LWS_VISIBLE LWS_EXTERN unsigned char
4363 lws_get_reserved_bits(struct lws *wsi);
4366 * lws_partial_buffered() - find out if lws buffered the last write
4367 * \param wsi: websocket connection to check
4369 * Returns 1 if you cannot use lws_write because the last
4370 * write on this connection is still buffered, and can't be cleared without
4371 * returning to the service loop and waiting for the connection to be
4374 * If you will try to do >1 lws_write call inside a single
4375 * WRITEABLE callback, you must check this after every write and bail if
4376 * set, ask for a new writeable callback and continue writing from there.
4378 * This is never set at the start of a writeable callback, but any write
4381 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4382 lws_partial_buffered(struct lws *wsi);
4385 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4387 * \param wsi: the connection we are inquiring about
4389 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4390 * it's interested to see if the frame it's dealing with was sent in binary
4393 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4394 lws_frame_is_binary(struct lws *wsi);
4397 * lws_is_ssl() - Find out if connection is using SSL
4398 * \param wsi: websocket connection to check
4400 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4401 * using verified cert, and 2 if using SSL but the cert was not
4402 * checked (appears for client wsi told to skip check on connection)
4404 LWS_VISIBLE LWS_EXTERN int
4405 lws_is_ssl(struct lws *wsi);
4407 * lws_is_cgi() - find out if this wsi is running a cgi process
4408 * \param wsi: lws connection
4410 LWS_VISIBLE LWS_EXTERN int
4411 lws_is_cgi(struct lws *wsi);
4413 #ifdef LWS_OPENSSL_SUPPORT
4415 * lws_get_ssl() - Return wsi's SSL context structure
4416 * \param wsi: websocket connection
4418 * Returns pointer to the SSL library's context structure
4420 LWS_VISIBLE LWS_EXTERN SSL*
4421 lws_get_ssl(struct lws *wsi);
4426 /** \defgroup sha SHA and B64 helpers
4427 * ##SHA and B64 helpers
4429 * These provide SHA-1 and B64 helper apis
4432 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4433 #define lws_SHA1 SHA1
4436 * lws_SHA1(): make a SHA-1 digest of a buffer
4438 * \param d: incoming buffer
4439 * \param n: length of incoming buffer
4440 * \param md: buffer for message digest (must be >= 20 bytes)
4442 * Reduces any size buffer into a 20-byte SHA-1 hash.
4444 LWS_VISIBLE LWS_EXTERN unsigned char *
4445 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4448 * lws_b64_encode_string(): encode a string into base 64
4450 * \param in: incoming buffer
4451 * \param in_len: length of incoming buffer
4452 * \param out: result buffer
4453 * \param out_size: length of result buffer
4455 * Encodes a string using b64
4457 LWS_VISIBLE LWS_EXTERN int
4458 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4460 * lws_b64_decode_string(): decode a string from base 64
4462 * \param in: incoming buffer
4463 * \param out: result buffer
4464 * \param out_size: length of result buffer
4466 * Decodes a string using b64
4468 LWS_VISIBLE LWS_EXTERN int
4469 lws_b64_decode_string(const char *in, char *out, int out_size);
4473 /*! \defgroup cgi cgi handling
4477 * These functions allow low-level control over stdin/out/err of the cgi.
4479 * However for most cases, binding the cgi to http in and out, the default
4480 * lws implementation already does the right thing.
4483 enum lws_enum_stdinouterr {
4489 enum lws_cgi_hdr_state {
4501 struct lws_cgi_args {
4502 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4503 enum lws_enum_stdinouterr ch; /**< channel index */
4504 unsigned char *data; /**< for messages with payload */
4505 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4506 int len; /**< length */
4511 * lws_cgi: spawn network-connected cgi process
4513 * \param wsi: connection to own the process
4514 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4515 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4516 * \param timeout_secs: seconds script should be allowed to run
4517 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4519 LWS_VISIBLE LWS_EXTERN int
4520 lws_cgi(struct lws *wsi, const char * const *exec_array,
4521 int script_uri_path_len, int timeout_secs,
4522 const struct lws_protocol_vhost_options *mp_cgienv);
4525 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4527 * \param wsi: connection to own the process
4529 LWS_VISIBLE LWS_EXTERN int
4530 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4533 * lws_cgi_kill: terminate cgi process associated with wsi
4535 * \param wsi: connection to own the process
4537 LWS_VISIBLE LWS_EXTERN int
4538 lws_cgi_kill(struct lws *wsi);
4543 /*! \defgroup fops file operation wrapping
4545 * ##File operation wrapping
4547 * Use these helper functions if you want to access a file from the perspective
4548 * of a specific wsi, which is usually the case. If you just want contextless
4549 * file access, use the fops callbacks directly with NULL wsi instead of these
4552 * If so, then it calls the platform handler or user overrides where present
4553 * (as defined in info->fops)
4555 * The advantage from all this is user code can be portable for file operations
4556 * without having to deal with differences between platforms.
4560 /** struct lws_plat_file_ops - Platform-specific file operations
4562 * These provide platform-agnostic ways to deal with filesystem access in the
4563 * library and in the user code.
4566 #if defined(LWS_WITH_ESP32)
4567 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4568 #define LWS_FOP_OPEN _open
4569 #define LWS_FOP_CLOSE _close
4570 #define LWS_FOP_SEEK_CUR _seek_cur
4571 #define LWS_FOP_READ _read
4572 #define LWS_FOP_WRITE _write
4574 #define LWS_FOP_OPEN open
4575 #define LWS_FOP_CLOSE close
4576 #define LWS_FOP_SEEK_CUR seek_cur
4577 #define LWS_FOP_READ read
4578 #define LWS_FOP_WRITE write
4581 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4582 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4583 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4584 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4585 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4587 struct lws_plat_file_ops;
4591 /**< real file descriptor related to the file... */
4592 const struct lws_plat_file_ops *fops;
4593 /**< fops that apply to this fop_fd */
4594 void *filesystem_priv;
4595 /**< ignored by lws; owned by the fops handlers */
4597 /**< generic "position in file" */
4599 /**< generic "length of file" */
4600 lws_fop_flags_t flags;
4601 /**< copy of the returned flags */
4603 /**< optional "modification time of file", only valid if .open()
4604 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4606 typedef struct lws_fop_fd *lws_fop_fd_t;
4608 struct lws_fops_index {
4609 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4610 uint8_t len; /* length of above string */
4613 struct lws_plat_file_ops {
4614 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4615 const char *filename, const char *vpath,
4616 lws_fop_flags_t *flags);
4617 /**< Open file (always binary access if plat supports it)
4618 * vpath may be NULL, or if the fops understands it, the point at which
4619 * the filename's virtual part starts.
4620 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4621 * If the file may be gzip-compressed,
4622 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4623 * gzip-compressed, then the open handler should OR
4624 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4626 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4627 /**< close file AND set the pointer to NULL */
4628 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4629 lws_fileofs_t offset_from_cur_pos);
4630 /**< seek from current position */
4631 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4632 uint8_t *buf, lws_filepos_t len);
4633 /**< Read from file, on exit *amount is set to amount actually read */
4634 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4635 uint8_t *buf, lws_filepos_t len);
4636 /**< Write to file, on exit *amount is set to amount actually written */
4638 struct lws_fops_index fi[3];
4639 /**< vfs path signatures implying use of this fops */
4641 const struct lws_plat_file_ops *next;
4642 /**< NULL or next fops in list */
4644 /* Add new things just above here ---^
4645 * This is part of the ABI, don't needlessly break compatibility */
4649 * lws_get_fops() - get current file ops
4651 * \param context: context
4653 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4654 lws_get_fops(struct lws_context *context);
4655 LWS_VISIBLE LWS_EXTERN void
4656 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4658 * lws_vfs_tell() - get current file position
4660 * \param fop_fd: fop_fd we are asking about
4662 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4663 lws_vfs_tell(lws_fop_fd_t fop_fd);
4665 * lws_vfs_get_length() - get current file total length in bytes
4667 * \param fop_fd: fop_fd we are asking about
4669 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4670 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4672 * lws_vfs_get_mod_time() - get time file last modified
4674 * \param fop_fd: fop_fd we are asking about
4676 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4677 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4679 * lws_vfs_file_seek_set() - seek relative to start of file
4681 * \param fop_fd: fop_fd we are seeking in
4682 * \param offset: offset from start of file
4684 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4685 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4687 * lws_vfs_file_seek_end() - seek relative to end of file
4689 * \param fop_fd: fop_fd we are seeking in
4690 * \param offset: offset from start of file
4692 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4693 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4695 extern struct lws_plat_file_ops fops_zip;
4698 * lws_plat_file_open() - open vfs filepath
4700 * \param fops: file ops struct that applies to this descriptor
4701 * \param vfs_path: filename to open
4702 * \param flags: pointer to open flags
4704 * The vfs_path is scanned for known fops signatures, and the open directed
4705 * to any matching fops open.
4707 * User code should use this api to perform vfs opens.
4709 * returns semi-opaque handle
4711 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4712 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4713 lws_fop_flags_t *flags);
4716 * lws_plat_file_close() - close file
4718 * \param fop_fd: file handle to close
4720 static LWS_INLINE int
4721 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4723 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4727 * lws_plat_file_seek_cur() - close file
4730 * \param fop_fd: file handle
4731 * \param offset: position to seek to
4733 static LWS_INLINE lws_fileofs_t
4734 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4736 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4739 * lws_plat_file_read() - read from file
4741 * \param fop_fd: file handle
4742 * \param amount: how much to read (rewritten by call)
4743 * \param buf: buffer to write to
4744 * \param len: max length
4746 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4747 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4748 uint8_t *buf, lws_filepos_t len)
4750 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4753 * lws_plat_file_write() - write from file
4755 * \param fop_fd: file handle
4756 * \param amount: how much to write (rewritten by call)
4757 * \param buf: buffer to read from
4758 * \param len: max length
4760 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4761 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4762 uint8_t *buf, lws_filepos_t len)
4764 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4767 /* these are the platform file operations implementations... they can
4768 * be called directly and used in fops arrays
4771 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4772 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4773 const char *vpath, lws_fop_flags_t *flags);
4774 LWS_VISIBLE LWS_EXTERN int
4775 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4776 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4777 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4778 LWS_VISIBLE LWS_EXTERN int
4779 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4780 uint8_t *buf, lws_filepos_t len);
4781 LWS_VISIBLE LWS_EXTERN int
4782 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4783 uint8_t *buf, lws_filepos_t len);
4785 LWS_VISIBLE LWS_EXTERN int
4786 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4787 lws_filepos_t *amount);
4792 * ##SMTP related functions
4794 * These apis let you communicate with a local SMTP server to send email from
4795 * lws. It handles all the SMTP sequencing and protocol actions.
4797 * Your system should have postfix, sendmail or another MTA listening on port
4798 * 25 and able to send email using the "mail" commandline app. Usually distro
4799 * MTAs are configured for this by default.
4801 * It runs via its own libuv events if initialized (which requires giving it
4802 * a libuv loop to attach to).
4804 * It operates using three callbacks, on_next() queries if there is a new email
4805 * to send, on_get_body() asks for the body of the email, and on_sent() is
4806 * called after the email is successfully sent.
4810 * - create an lws_email struct
4812 * - initialize data, loop, the email_* strings, max_content_size and
4815 * - call lws_email_init()
4817 * When you have at least one email to send, call lws_email_check() to
4818 * schedule starting to send it.
4821 #ifdef LWS_WITH_SMTP
4823 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
4824 enum lwsgs_smtp_states {
4825 LGSSMTP_IDLE, /**< awaiting new email */
4826 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
4827 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
4828 LGSSMTP_SENT_HELO, /**< sent the HELO */
4829 LGSSMTP_SENT_FROM, /**< sent FROM */
4830 LGSSMTP_SENT_TO, /**< sent TO */
4831 LGSSMTP_SENT_DATA, /**< sent DATA request */
4832 LGSSMTP_SENT_BODY, /**< sent the email body */
4833 LGSSMTP_SENT_QUIT, /**< sent the session quit */
4836 /** struct lws_email - abstract context for performing SMTP operations */
4839 /**< opaque pointer set by user code and available to the callbacks */
4841 /**< the libuv loop we will work on */
4843 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
4844 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
4845 char email_from[100]; /**< Fill before init or on_next */
4846 char email_to[100]; /**< Fill before init or on_next */
4848 unsigned int max_content_size;
4849 /**< largest possible email body size */
4851 /* Fill all the callbacks before init */
4853 int (*on_next)(struct lws_email *email);
4854 /**< (Fill in before calling lws_email_init)
4855 * called when idle, 0 = another email to send, nonzero is idle.
4856 * If you return 0, all of the email_* char arrays must be set
4857 * to something useful. */
4858 int (*on_sent)(struct lws_email *email);
4859 /**< (Fill in before calling lws_email_init)
4860 * called when transfer of the email to the SMTP server was
4861 * successful, your callback would remove the current email
4863 int (*on_get_body)(struct lws_email *email, char *buf, int len);
4864 /**< (Fill in before calling lws_email_init)
4865 * called when the body part of the queued email is about to be
4866 * sent to the SMTP server. */
4869 /* private things */
4870 uv_timer_t timeout_email; /**< private */
4871 enum lwsgs_smtp_states estate; /**< private */
4872 uv_connect_t email_connect_req; /**< private */
4873 uv_tcp_t email_client; /**< private */
4874 time_t email_connect_started; /**< private */
4875 char email_buf[256]; /**< private */
4876 char *content; /**< private */
4880 * lws_email_init() - Initialize a struct lws_email
4882 * \param email: struct lws_email to init
4883 * \param loop: libuv loop to use
4884 * \param max_content: max email content size
4886 * Prepares a struct lws_email for use ending SMTP
4888 LWS_VISIBLE LWS_EXTERN int
4889 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4892 * lws_email_check() - Request check for new email
4894 * \param email: struct lws_email context to check
4896 * Schedules a check for new emails in 1s... call this when you have queued an
4899 LWS_VISIBLE LWS_EXTERN void
4900 lws_email_check(struct lws_email *email);
4902 * lws_email_destroy() - stop using the struct lws_email
4904 * \param email: the struct lws_email context
4906 * Stop sending email using email and free allocations
4908 LWS_VISIBLE LWS_EXTERN void
4909 lws_email_destroy(struct lws_email *email);
4915 * Stats are all uint64_t numbers that start at 0.
4916 * Index names here have the convention
4920 * _MS_ millisecond count
4924 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
4925 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
4926 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
4927 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
4928 LWSSTATS_C_API_WRITE, /**< count calls to write API */
4929 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
4930 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
4931 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
4932 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
4933 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
4934 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
4935 LWSSTATS_C_SSL_CONNS_HAD_RX, /**< count of accepted SSL conns that have had some RX */
4936 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
4937 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
4938 LWSSTATS_B_READ, /**< aggregate bytes read */
4939 LWSSTATS_B_WRITE, /**< aggregate bytes written */
4940 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
4941 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
4942 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
4943 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
4944 LWSSTATS_MS_SSL_RX_DELAY, /**< aggregate delay between ssl accept complete and first RX */
4946 /* Add new things just above here ---^
4947 * This is part of the ABI, don't needlessly break compatibility */
4951 #if defined(LWS_WITH_STATS)
4953 LWS_VISIBLE LWS_EXTERN uint64_t
4954 lws_stats_get(struct lws_context *context, int index);
4955 LWS_VISIBLE LWS_EXTERN void
4956 lws_stats_log_dump(struct lws_context *context);
4958 static LWS_INLINE uint64_t
4959 lws_stats_get(struct lws_context *context, int index) { return 0; }
4960 static LWS_INLINE void
4961 lws_stats_log_dump(struct lws_context *context) { }