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.
834 * NOTE: These public enums are part of the abi. If you want to add one,
835 * add it at where specified so existing users are unaffected.
837 /** enum lws_callback_reasons - reason you're getting a protocol callback */
838 enum lws_callback_reasons {
839 LWS_CALLBACK_ESTABLISHED = 0,
840 /**< (VH) after the server completes a handshake with an incoming
841 * client. If you built the library with ssl support, in is a
842 * pointer to the ssl struct associated with the connection or NULL.*/
843 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
844 /**< the request client connection has been unable to complete a
845 * handshake with the remote server. If in is non-NULL, you can
846 * find an error string of length len where it points to
848 * Diagnostic strings that may be returned include
850 * "getaddrinfo (ipv6) failed"
851 * "unknown address family"
852 * "getaddrinfo (ipv4) failed"
853 * "set socket opts failed"
854 * "insert wsi failed"
855 * "lws_ssl_client_connect1 failed"
856 * "lws_ssl_client_connect2 failed"
860 * "HS: Redirect code but no Location"
861 * "HS: URI did not parse"
862 * "HS: Redirect failed"
863 * "HS: Server did not return 200"
865 * "HS: disallowed by client filter"
866 * "HS: disallowed at ESTABLISHED"
867 * "HS: ACCEPT missing"
868 * "HS: ws upgrade response not 101"
869 * "HS: UPGRADE missing"
870 * "HS: Upgrade to something other than websocket"
871 * "HS: CONNECTION missing"
872 * "HS: UPGRADE malformed"
873 * "HS: PROTOCOL malformed"
874 * "HS: Cannot match protocol"
875 * "HS: EXT: list too big"
876 * "HS: EXT: failed setting defaults"
877 * "HS: EXT: failed parsing defaults"
878 * "HS: EXT: failed parsing options"
879 * "HS: EXT: Rejects server options"
880 * "HS: EXT: unknown ext"
881 * "HS: Accept hash wrong"
882 * "HS: Rejected by filter cb"
884 * "HS: SO_SNDBUF failed"
885 * "HS: Rejected at CLIENT_ESTABLISHED"
887 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
888 /**< this is the last chance for the client user code to examine the
889 * http headers and decide to reject the connection. If the
890 * content in the headers is interesting to the
891 * client (url, etc) it needs to copy it out at
892 * this point since it will be destroyed before
893 * the CLIENT_ESTABLISHED call */
894 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
895 /**< after your client connection completed
896 * a handshake with the remote server */
897 LWS_CALLBACK_CLOSED = 4,
898 /**< when the websocket session ends */
899 LWS_CALLBACK_CLOSED_HTTP = 5,
900 /**< when a HTTP (non-websocket) session ends */
901 LWS_CALLBACK_RECEIVE = 6,
902 /**< data has appeared for this server endpoint from a
903 * remote client, it can be found at *in and is
905 LWS_CALLBACK_RECEIVE_PONG = 7,
906 /**< servers receive PONG packets with this callback reason */
907 LWS_CALLBACK_CLIENT_RECEIVE = 8,
908 /**< data has appeared from the server for the client connection, it
909 * can be found at *in and is len bytes long */
910 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
911 /**< clients receive PONG packets with this callback reason */
912 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
913 /**< If you call lws_callback_on_writable() on a connection, you will
914 * get one of these callbacks coming when the connection socket
915 * is able to accept another write packet without blocking.
916 * If it already was able to take another packet without blocking,
917 * you'll get this callback at the next call to the service loop
918 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
919 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
920 LWS_CALLBACK_SERVER_WRITEABLE = 11,
921 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
922 LWS_CALLBACK_HTTP = 12,
923 /**< an http request has come from a client that is not
924 * asking to upgrade the connection to a websocket
925 * one. This is a chance to serve http content,
926 * for example, to send a script to the client
927 * which will then open the websockets connection.
928 * in points to the URI path requested and
929 * lws_serve_http_file() makes it very
930 * simple to send back a file to the client.
931 * Normally after sending the file you are done
932 * with the http connection, since the rest of the
933 * activity will come by websockets from the script
934 * that was delivered by http, so you will want to
935 * return 1; to close and free up the connection. */
936 LWS_CALLBACK_HTTP_BODY = 13,
937 /**< the next len bytes data from the http
938 * request body HTTP connection is now available in in. */
939 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
940 /**< the expected amount of http request body has been delivered */
941 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
942 /**< a file requested to be sent down http link has completed. */
943 LWS_CALLBACK_HTTP_WRITEABLE = 16,
944 /**< you can write more down the http protocol link now. */
945 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
946 /**< called when a client connects to
947 * the server at network level; the connection is accepted but then
948 * passed to this callback to decide whether to hang up immediately
949 * or not, based on the client IP. in contains the connection
950 * socket's descriptor. Since the client connection information is
951 * not available yet, wsi still pointing to the main server socket.
952 * Return non-zero to terminate the connection before sending or
953 * receiving anything. Because this happens immediately after the
954 * network connection from the client, there's no websocket protocol
955 * selected yet so this callback is issued only to protocol 0. */
956 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
957 /**< called when the request has
958 * been received and parsed from the client, but the response is
959 * not sent yet. Return non-zero to disallow the connection.
960 * user is a pointer to the connection user space allocation,
961 * in is the URI, eg, "/"
962 * In your handler you can use the public APIs
963 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
964 * headers using the header enums lws_token_indexes from
965 * libwebsockets.h to check for and read the supported header
966 * presence and content before deciding to allow the http
967 * connection to proceed or to kill the connection. */
968 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
969 /**< A new client just had
970 * been connected, accepted, and instantiated into the pool. This
971 * callback allows setting any relevant property to it. Because this
972 * happens immediately after the instantiation of a new client,
973 * there's no websocket protocol selected yet so this callback is
974 * issued only to protocol 0. Only wsi is defined, pointing to the
975 * new client, and the return value is ignored. */
976 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
977 /**< called when the handshake has
978 * been received and parsed from the client, but the response is
979 * not sent yet. Return non-zero to disallow the connection.
980 * user is a pointer to the connection user space allocation,
981 * in is the requested protocol name
982 * In your handler you can use the public APIs
983 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
984 * headers using the header enums lws_token_indexes from
985 * libwebsockets.h to check for and read the supported header
986 * presence and content before deciding to allow the handshake
987 * to proceed or to kill the connection. */
988 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
989 /**< if configured for
990 * including OpenSSL support, this callback allows your user code
991 * to perform extra SSL_CTX_load_verify_locations() or similar
992 * calls to direct OpenSSL where to find certificates the client
993 * can use to confirm the remote server identity. user is the
994 * OpenSSL SSL_CTX* */
995 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
996 /**< if configured for
997 * including OpenSSL support, this callback allows your user code
998 * to load extra certifcates into the server which allow it to
999 * verify the validity of certificates returned by clients. user
1000 * is the server's OpenSSL SSL_CTX* */
1001 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
1002 /**< if the libwebsockets vhost was created with the option
1003 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
1004 * callback is generated during OpenSSL verification of the cert
1005 * sent from the client. It is sent to protocol[0] callback as
1006 * no protocol has been negotiated on the connection yet.
1007 * Notice that the libwebsockets context and wsi are both NULL
1008 * during this callback. See
1009 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1010 * to understand more detail about the OpenSSL callback that
1011 * generates this libwebsockets callback and the meanings of the
1012 * arguments passed. In this callback, user is the x509_ctx,
1013 * in is the ssl pointer and len is preverify_ok
1014 * Notice that this callback maintains libwebsocket return
1015 * conventions, return 0 to mean the cert is OK or 1 to fail it.
1016 * This also means that if you don't handle this callback then
1017 * the default callback action of returning 0 allows the client
1019 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
1020 /**< this callback happens
1021 * when a client handshake is being compiled. user is NULL,
1022 * in is a char **, it's pointing to a char * which holds the
1023 * next location in the header buffer where you can add
1024 * headers, and len is the remaining space in the header buffer,
1025 * which is typically some hundreds of bytes. So, to add a canned
1026 * cookie, your handler code might look similar to:
1028 * char **p = (char **)in;
1033 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1037 * Notice if you add anything, you just have to take care about
1038 * the CRLF on the line you added. Obviously this callback is
1039 * optional, if you don't handle it everything is fine.
1041 * Notice the callback is coming to protocols[0] all the time,
1042 * because there is no specific protocol negotiated yet. */
1043 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
1044 /**< When the server handshake code
1045 * sees that it does support a requested extension, before
1046 * accepting the extension by additing to the list sent back to
1047 * the client it gives this callback just to check that it's okay
1048 * to use that extension. It calls back to the requested protocol
1049 * and with in being the extension name, len is 0 and user is
1050 * valid. Note though at this time the ESTABLISHED callback hasn't
1051 * happened yet so if you initialize user content there, user
1052 * content during this callback might not be useful for anything. */
1053 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
1055 * connection is being prepared to start a handshake to a server,
1056 * each supported extension is checked with protocols[0] callback
1057 * with this reason, giving the user code a chance to suppress the
1058 * claim to support that extension by returning non-zero. If
1059 * unhandled, by default 0 will be returned and the extension
1060 * support included in the header to the server. Notice this
1061 * callback comes to protocols[0]. */
1062 LWS_CALLBACK_PROTOCOL_INIT = 27,
1063 /**< One-time call per protocol, per-vhost using it, so it can
1064 * do initial setup / allocations etc */
1065 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
1066 /**< One-time call per protocol, per-vhost using it, indicating
1067 * this protocol won't get used at all after this callback, the
1068 * vhost is getting destroyed. Take the opportunity to
1069 * deallocate everything that was allocated by the protocol. */
1070 LWS_CALLBACK_WSI_CREATE = 29,
1071 /**< outermost (earliest) wsi create notification to protocols[0] */
1072 LWS_CALLBACK_WSI_DESTROY = 30,
1073 /**< outermost (latest) wsi destroy notification to protocols[0] */
1074 LWS_CALLBACK_GET_THREAD_ID = 31,
1075 /**< lws can accept callback when writable requests from other
1076 * threads, if you implement this callback and return an opaque
1077 * current thread ID integer. */
1079 /* external poll() management support */
1080 LWS_CALLBACK_ADD_POLL_FD = 32,
1081 /**< lws normally deals with its poll() or other event loop
1082 * internally, but in the case you are integrating with another
1083 * server you will need to have lws sockets share a
1084 * polling array with the other server. This and the other
1085 * POLL_FD related callbacks let you put your specialized
1086 * poll array interface code in the callback for protocol 0, the
1087 * first protocol you support, usually the HTTP protocol in the
1089 * This callback happens when a socket needs to be
1090 * added to the polling loop: in points to a struct
1091 * lws_pollargs; the fd member of the struct is the file
1092 * descriptor, and events contains the active events
1094 * If you are using the internal lws polling / event loop
1095 * you can just ignore these callbacks. */
1096 LWS_CALLBACK_DEL_POLL_FD = 33,
1097 /**< This callback happens when a socket descriptor
1098 * needs to be removed from an external polling array. in is
1099 * again the struct lws_pollargs containing the fd member
1100 * to be removed. If you are using the internal polling
1101 * loop, you can just ignore it. */
1102 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1103 /**< This callback happens when lws wants to modify the events for
1105 * in is the struct lws_pollargs with the fd to change.
1106 * The new event mask is in events member and the old mask is in
1107 * the prev_events member.
1108 * If you are using the internal polling loop, you can just ignore
1110 LWS_CALLBACK_LOCK_POLL = 35,
1111 /**< These allow the external poll changes driven
1112 * by lws to participate in an external thread locking
1113 * scheme around the changes, so the whole thing is threadsafe.
1114 * These are called around three activities in the library,
1115 * - inserting a new wsi in the wsi / fd table (len=1)
1116 * - deleting a wsi from the wsi / fd table (len=1)
1117 * - changing a wsi's POLLIN/OUT state (len=0)
1118 * Locking and unlocking external synchronization objects when
1119 * len == 1 allows external threads to be synchronized against
1120 * wsi lifecycle changes if it acquires the same lock for the
1121 * duration of wsi dereference from the other thread context. */
1122 LWS_CALLBACK_UNLOCK_POLL = 36,
1123 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1125 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1126 /**< if configured for including OpenSSL support but no private key
1127 * file has been specified (ssl_private_key_filepath is NULL), this is
1128 * called to allow the user to set the private key directly via
1129 * libopenssl and perform further operations if required; this might be
1130 * useful in situations where the private key is not directly accessible
1131 * by the OS, for example if it is stored on a smartcard.
1132 * user is the server's OpenSSL SSL_CTX* */
1133 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1134 /**< The peer has sent an unsolicited Close WS packet. in and
1135 * len are the optional close code (first 2 bytes, network
1136 * order) and the optional additional information which is not
1137 * defined in the standard, and may be a string or non-human- readable data.
1138 * If you return 0 lws will echo the close and then close the
1139 * connection. If you return nonzero lws will just close the
1142 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1145 LWS_CALLBACK_CGI = 40,
1147 LWS_CALLBACK_CGI_TERMINATED = 41,
1149 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1151 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1153 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1155 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1157 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1159 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1161 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1163 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1165 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1167 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1169 LWS_CALLBACK_PROCESS_HTML = 52,
1171 LWS_CALLBACK_ADD_HEADERS = 53,
1173 LWS_CALLBACK_SESSION_INFO = 54,
1176 LWS_CALLBACK_GS_EVENT = 55,
1178 LWS_CALLBACK_HTTP_PMO = 56,
1179 /**< per-mount options for this connection, called before
1180 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1183 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1184 /**< when doing an HTTP type client connection, you can call
1185 * lws_client_http_body_pending(wsi, 1) from
1186 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1187 * sending the HTTP headers.
1189 * From this callback, when you have sent everything, you should let
1190 * lws know by calling lws_client_http_body_pending(wsi, 0)
1192 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1193 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1194 * this callback is called during OpenSSL verification of the cert
1195 * sent from the server to the client. It is sent to protocol[0]
1196 * callback as no protocol has been negotiated on the connection yet.
1197 * Notice that the wsi is set because lws_client_connect_via_info was
1200 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1201 * to understand more detail about the OpenSSL callback that
1202 * generates this libwebsockets callback and the meanings of the
1203 * arguments passed. In this callback, user is the x509_ctx,
1204 * in is the ssl pointer and len is preverify_ok.
1206 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1207 * overruled and cert shall be accepted as ok,
1208 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1209 * called and return value must be 0 to mean the cert is OK;
1210 * returning 1 will fail the cert in any case.
1212 * This also means that if you don't handle this callback then
1213 * the default callback action of returning 0 will not accept the
1214 * certificate in case of a validation error decided by the SSL lib.
1216 * This is expected and secure behaviour when validating certificates.
1218 * Note: LCCSCF_ALLOW_SELFSIGNED and
1219 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1220 * callback being implemented.
1222 LWS_CALLBACK_RAW_RX = 59,
1223 /**< RAW mode connection RX */
1224 LWS_CALLBACK_RAW_CLOSE = 60,
1225 /**< RAW mode connection is closing */
1226 LWS_CALLBACK_RAW_WRITEABLE = 61,
1227 /**< RAW mode connection may be written */
1228 LWS_CALLBACK_RAW_ADOPT = 62,
1229 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1230 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1231 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1232 LWS_CALLBACK_RAW_RX_FILE = 64,
1233 /**< RAW mode file has something to read */
1234 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1235 /**< RAW mode file is writeable */
1236 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1237 /**< RAW mode wsi that adopted a file is closing */
1239 /****** add new things just above ---^ ******/
1241 LWS_CALLBACK_USER = 1000,
1242 /**< user code can use any including above without fear of clashes */
1248 * typedef lws_callback_function() - User server actions
1249 * \param wsi: Opaque websocket instance pointer
1250 * \param reason: The reason for the call
1251 * \param user: Pointer to per-session user data allocated by library
1252 * \param in: Pointer used for some callback reasons
1253 * \param len: Length set for some callback reasons
1255 * This callback is the way the user controls what is served. All the
1256 * protocol detail is hidden and handled by the library.
1258 * For each connection / session there is user data allocated that is
1259 * pointed to by "user". You set the size of this user data area when
1260 * the library is initialized with lws_create_server.
1263 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1264 void *user, void *in, size_t len);
1267 /*! \defgroup extensions
1269 * ##Extension releated functions
1271 * Ws defines optional extensions, lws provides the ability to implement these
1272 * in user code if so desired.
1274 * We provide one extensions permessage-deflate.
1279 * NOTE: These public enums are part of the abi. If you want to add one,
1280 * add it at where specified so existing users are unaffected.
1282 enum lws_extension_callback_reasons {
1283 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1284 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1285 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1286 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1287 LWS_EXT_CB_CONSTRUCT = 4,
1288 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1289 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1290 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1291 LWS_EXT_CB_DESTROY = 8,
1292 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1293 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1294 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1295 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1296 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1297 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1298 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1299 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1300 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1301 LWS_EXT_CB_1HZ = 18,
1302 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1303 LWS_EXT_CB_IS_WRITEABLE = 20,
1304 LWS_EXT_CB_PAYLOAD_TX = 21,
1305 LWS_EXT_CB_PAYLOAD_RX = 22,
1306 LWS_EXT_CB_OPTION_DEFAULT = 23,
1307 LWS_EXT_CB_OPTION_SET = 24,
1308 LWS_EXT_CB_OPTION_CONFIRM = 25,
1309 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1311 /****** add new things just above ---^ ******/
1314 /** enum lws_ext_options_types */
1315 enum lws_ext_options_types {
1316 EXTARG_NONE, /**< does not take an argument */
1317 EXTARG_DEC, /**< requires a decimal argument */
1318 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1320 /* Add new things just above here ---^
1321 * This is part of the ABI, don't needlessly break compatibility */
1324 /** struct lws_ext_options - Option arguments to the extension. These are
1325 * used in the negotiation at ws upgrade time.
1326 * The helper function lws_ext_parse_options()
1327 * uses these to generate callbacks */
1328 struct lws_ext_options {
1329 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1330 enum lws_ext_options_types type; /**< What kind of args the option can take */
1332 /* Add new things just above here ---^
1333 * This is part of the ABI, don't needlessly break compatibility */
1336 /** struct lws_ext_option_arg */
1337 struct lws_ext_option_arg {
1338 const char *option_name; /**< may be NULL, option_index used then */
1339 int option_index; /**< argument ordinal to use if option_name missing */
1340 const char *start; /**< value */
1341 int len; /**< length of value */
1345 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1346 * \param context: Websockets context
1347 * \param ext: This extension
1348 * \param wsi: Opaque websocket instance pointer
1349 * \param reason: The reason for the call
1350 * \param user: Pointer to ptr to per-session user data allocated by library
1351 * \param in: Pointer used for some callback reasons
1352 * \param len: Length set for some callback reasons
1354 * Each extension that is active on a particular connection receives
1355 * callbacks during the connection lifetime to allow the extension to
1356 * operate on websocket data and manage itself.
1358 * Libwebsockets takes care of allocating and freeing "user" memory for
1359 * each active extension on each connection. That is what is pointed to
1360 * by the user parameter.
1362 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1363 * select this extension from the list provided by the client,
1364 * just before the server will send back the handshake accepting
1365 * the connection with this extension active. This gives the
1366 * extension a chance to initialize its connection context found
1369 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1370 * but called when client is instantiating this extension. Some
1371 * extensions will work the same on client and server side and then
1372 * you can just merge handlers for both CONSTRUCTS.
1374 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1375 * being used on is about to be closed and deallocated. It's the
1376 * last chance for the extension to deallocate anything it has
1377 * allocated in the user data (pointed to by user) before the
1378 * user data is deleted. This same callback is used whether you
1379 * are in client or server instantiation context.
1381 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1382 * a connection, and a packet of data arrived at the connection,
1383 * it is passed to this callback to give the extension a chance to
1384 * change the data, eg, decompress it. user is pointing to the
1385 * extension's private connection context data, in is pointing
1386 * to an lws_tokens struct, it consists of a char * pointer called
1387 * token, and an int called token_len. At entry, these are
1388 * set to point to the received buffer and set to the content
1389 * length. If the extension will grow the content, it should use
1390 * a new buffer allocated in its private user context data and
1391 * set the pointed-to lws_tokens members to point to its buffer.
1393 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1394 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1395 * extension a chance to change websocket data just before it will
1396 * be sent out. Using the same lws_token pointer scheme in in,
1397 * the extension can change the buffer and the length to be
1398 * transmitted how it likes. Again if it wants to grow the
1399 * buffer safely, it should copy the data into its own buffer and
1400 * set the lws_tokens token pointer to it.
1402 * LWS_EXT_CB_ARGS_VALIDATE:
1405 lws_extension_callback_function(struct lws_context *context,
1406 const struct lws_extension *ext, struct lws *wsi,
1407 enum lws_extension_callback_reasons reason,
1408 void *user, void *in, size_t len);
1410 /** struct lws_extension - An extension we support */
1411 struct lws_extension {
1412 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1413 lws_extension_callback_function *callback; /**< Service callback */
1414 const char *client_offer; /**< String containing exts and options client offers */
1416 /* Add new things just above here ---^
1417 * This is part of the ABI, don't needlessly break compatibility */
1421 * lws_set_extension_option(): set extension option if possible
1423 * \param wsi: websocket connection
1424 * \param ext_name: name of ext, like "permessage-deflate"
1425 * \param opt_name: name of option, like "rx_buf_size"
1426 * \param opt_val: value to set option to
1428 LWS_VISIBLE LWS_EXTERN int
1429 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1430 const char *opt_name, const char *opt_val);
1432 #ifndef LWS_NO_EXTENSIONS
1433 /* lws_get_internal_extensions() - DEPRECATED
1435 * \Deprecated There is no longer a set internal extensions table. The table is provided
1436 * by user code along with application-specific settings. See the test
1437 * client and server for how to do.
1439 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1440 lws_get_internal_extensions(void) { return NULL; }
1443 * lws_ext_parse_options() - deal with parsing negotiated extension options
1445 * \param ext: related extension struct
1446 * \param wsi: websocket connection
1447 * \param ext_user: per-connection extension private data
1448 * \param opts: list of supported options
1449 * \param o: option string to parse
1450 * \param len: length
1452 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1453 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1454 void *ext_user, const struct lws_ext_options *opts,
1455 const char *o, int len);
1458 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1460 * \param context: lws context
1461 * \param ext: related lws_extension struct
1462 * \param wsi: websocket connection
1463 * \param reason: incoming callback reason
1464 * \param user: per-connection extension private data
1465 * \param in: pointer parameter
1466 * \param len: length parameter
1468 * Built-in callback implementing RFC7692 permessage-deflate
1471 int lws_extension_callback_pm_deflate(
1472 struct lws_context *context, const struct lws_extension *ext,
1473 struct lws *wsi, enum lws_extension_callback_reasons reason,
1474 void *user, void *in, size_t len);
1477 * The internal exts are part of the public abi
1478 * If we add more extensions, publish the callback here ------v
1482 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1485 * ##Protocol and protocol plugin -related apis
1487 * Protocols bind ws protocol names to a custom callback specific to that
1488 * protocol implementaion.
1490 * A list of protocols can be passed in at context creation time, but it is
1491 * also legal to leave that NULL and add the protocols and their callback code
1494 * Plugins are much preferable compared to cut and pasting code into an
1495 * application each time, since they can be used standalone.
1498 /** struct lws_protocols - List of protocols and handlers client or server
1501 struct lws_protocols {
1503 /**< Protocol name that must match the one given in the client
1504 * Javascript new WebSocket(url, 'protocol') name. */
1505 lws_callback_function *callback;
1506 /**< The service callback used for this protocol. It allows the
1507 * service action for an entire protocol to be encapsulated in
1508 * the protocol-specific callback */
1509 size_t per_session_data_size;
1510 /**< Each new connection using this protocol gets
1511 * this much memory allocated on connection establishment and
1512 * freed on connection takedown. A pointer to this per-connection
1513 * allocation is passed into the callback in the 'user' parameter */
1514 size_t rx_buffer_size;
1515 /**< lws allocates this much space for rx data and informs callback
1516 * when something came. Due to rx flow control, the callback may not
1517 * be able to consume it all without having to return to the event
1518 * loop. That is supported in lws.
1520 * If .tx_packet_size is 0, this also controls how much may be sent at once
1521 * for backwards compatibility.
1524 /**< ignored by lws, but useful to contain user information bound
1525 * to the selected protocol. For example if this protocol was
1526 * called "myprotocol-v2", you might set id to 2, and the user
1527 * code that acts differently according to the version can do so by
1528 * switch (wsi->protocol->id), user code might use some bits as
1529 * capability flags based on selected protocol version, etc. */
1530 void *user; /**< ignored by lws, but user code can pass a pointer
1531 here it can later access from the protocol callback */
1532 size_t tx_packet_size;
1533 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1535 * If greater than zero, a single send() is restricted to this amount
1536 * and any remainder is buffered by lws and sent afterwards also in
1537 * these size chunks. Since that is expensive, it's preferable
1538 * to restrict one fragment you are trying to send to match this
1542 /* Add new things just above here ---^
1543 * This is part of the ABI, don't needlessly break compatibility */
1549 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1551 * \param vh: vhost to search
1552 * \param name: protocol name
1554 * Returns NULL or a pointer to the vhost's protocol of the requested name
1556 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1557 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1560 * lws_get_protocol() - Returns a protocol pointer from a websocket
1562 * \param wsi: pointer to struct websocket you want to know the protocol of
1565 * Some apis can act on all live connections of a given protocol,
1566 * this is how you can get a pointer to the active protocol if needed.
1568 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1569 lws_get_protocol(struct lws *wsi);
1571 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1572 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1573 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1576 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1578 * \param vhost: vhost the instance is related to
1579 * \param prot: protocol the instance is related to
1580 * \param size: bytes to allocate
1582 * Protocols often find it useful to allocate a per-vhost struct, this is a
1583 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1585 LWS_VISIBLE LWS_EXTERN void *
1586 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1590 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1592 * \param vhost: vhost the instance is related to
1593 * \param prot: protocol the instance is related to
1595 * Recover a pointer to the allocated per-vhost storage for the protocol created
1596 * by lws_protocol_vh_priv_zalloc() earlier
1598 LWS_VISIBLE LWS_EXTERN void *
1599 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1602 * lws_finalize_startup() - drop initial process privileges
1604 * \param context: lws context
1606 * This is called after the end of the vhost protocol initializations, but
1607 * you may choose to call it earlier
1609 LWS_VISIBLE LWS_EXTERN int
1610 lws_finalize_startup(struct lws_context *context);
1612 LWS_VISIBLE LWS_EXTERN int
1613 lws_protocol_init(struct lws_context *context);
1615 #ifdef LWS_WITH_PLUGINS
1617 /* PLUGINS implies LIBUV */
1619 #define LWS_PLUGIN_API_MAGIC 180
1621 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1622 struct lws_plugin_capability {
1623 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1624 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1625 int count_protocols; /**< how many protocols */
1626 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1627 int count_extensions; /**< how many extensions */
1630 typedef int (*lws_plugin_init_func)(struct lws_context *,
1631 struct lws_plugin_capability *);
1632 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1634 /** struct lws_plugin */
1636 struct lws_plugin *list; /**< linked list */
1637 #if (UV_VERSION_MAJOR > 0)
1638 uv_lib_t lib; /**< shared library pointer */
1640 void *l; /**< so we can compile on ancient libuv */
1642 char name[64]; /**< name of the plugin */
1643 struct lws_plugin_capability caps; /**< plugin capabilities */
1651 /*! \defgroup generic-sessions plugin: generic-sessions
1652 * \ingroup Protocols-and-Plugins
1654 * ##Plugin Generic-sessions related
1656 * generic-sessions plugin provides a reusable, generic session and login /
1657 * register / forgot password framework including email verification.
1661 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1662 /**< Maximum size of email we might send */
1664 /* SHA-1 binary and hexified versions */
1665 /** typedef struct lwsgw_hash_bin */
1666 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1667 /** typedef struct lwsgw_hash */
1668 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1670 /** enum lwsgs_auth_bits */
1671 enum lwsgs_auth_bits {
1672 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1673 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1674 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1675 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1678 /** struct lws_session_info - information about user session status */
1679 struct lws_session_info {
1680 char username[32]; /**< username logged in as, or empty string */
1681 char email[100]; /**< email address associated with login, or empty string */
1682 char ip[72]; /**< ip address session was started from */
1683 unsigned int mask; /**< access rights mask associated with session
1684 * see enum lwsgs_auth_bits */
1685 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1688 /** enum lws_gs_event */
1690 LWSGSE_CREATED, /**< a new user was created */
1691 LWSGSE_DELETED /**< an existing user was deleted */
1694 /** struct lws_gs_event_args */
1695 struct lws_gs_event_args {
1696 enum lws_gs_event event; /**< which event happened */
1697 const char *username; /**< which username the event happened to */
1698 const char *email; /**< the email address of that user */
1704 /*! \defgroup context-and-vhost
1707 * ##Context and Vhost releated functions
1709 * LWS requires that there is one context, in which you may define multiple
1710 * vhosts. Each vhost is a virtual host, with either its own listen port
1711 * or sharing an existing one. Each vhost has its own SSL context that can
1712 * be set up individually or left disabled.
1714 * If you don't care about multiple "site" support, you can ignore it and
1715 * lws will create a single default vhost at context creation time.
1720 * NOTE: These public enums are part of the abi. If you want to add one,
1721 * add it at where specified so existing users are unaffected.
1724 /** enum lws_context_options - context and vhost options */
1725 enum lws_context_options {
1726 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1728 /**< (VH) Don't allow the connection unless the client has a
1729 * client cert that we recognize; provides
1730 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1731 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1732 /**< (CTX) Don't try to get the server's hostname */
1733 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1735 /**< (VH) Allow non-SSL (plaintext) connections on the same
1736 * port as SSL is listening... undermines the security of SSL;
1737 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1738 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1739 /**< (CTX) Use libev event loop */
1740 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1741 /**< (VH) Disable IPV6 support */
1742 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1743 /**< (VH) Don't load OS CA certs, you will need to load your
1745 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1746 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1747 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1748 /**< (VH) Check UT-8 correctness */
1749 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1751 /**< (VH) initialize ECDH ciphers */
1752 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1753 /**< (CTX) Use libuv event loop */
1754 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1756 /**< (VH) Use http redirect to force http to https
1757 * (deprecated: use mount redirection) */
1758 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1759 /**< (CTX) Initialize the SSL library at all */
1760 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1761 /**< (CTX) Only create the context when calling context
1762 * create api, implies user code will create its own vhosts */
1763 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1764 /**< (VH) Use Unix socket */
1765 LWS_SERVER_OPTION_STS = (1 << 15),
1766 /**< (VH) Send Strict Transport Security header, making
1767 * clients subsequently go to https even if user asked for http */
1768 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1769 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1770 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1771 /**< (VH) if set, only ipv6 allowed on the vhost */
1772 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1773 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1774 * normally makes the lib spin so you can attach a debugger to it
1775 * even if it happened without a debugger in place. You can disable
1776 * that by giving this option.
1778 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1779 /**< For backwards-compatibility reasons, by default
1780 * lws prepends "http://" to the origin you give in the client
1781 * connection info struct. If you give this flag when you create
1782 * the context, only the string you give in the client connect
1783 * info for .origin (if any) will be used directly.
1785 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1786 /**< (VH) if invalid http is coming in the first line, */
1787 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1788 /**< (CTX) Use libevent event loop */
1789 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1790 /**< (VH) All connections to this vhost / port are RAW as soon as
1791 * the connection is accepted, no HTTP is going to be coming.
1794 /****** add new things just above ---^ ******/
1797 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1799 struct lws_plat_file_ops;
1801 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1803 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1804 * is not given, then for backwards compatibility one vhost is created at
1805 * context-creation time using the info from this struct.
1807 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1808 * at the same time as the context, they are expected to be created afterwards.
1810 struct lws_context_creation_info {
1812 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1813 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1814 * writing a server but you are using \ref sock-adopt instead of the
1815 * built-in listener */
1817 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1818 * interface name, eg, "eth2"
1819 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1820 * the pathname of a UNIX domain socket. you can use the UNIX domain
1821 * sockets in abstract namespace, by prepending an at symbol to the
1823 const struct lws_protocols *protocols;
1824 /**< VHOST: Array of structures listing supported protocols and a protocol-
1825 * specific callback for each one. The list is ended with an
1826 * entry that has a NULL callback pointer. */
1827 const struct lws_extension *extensions;
1828 /**< VHOST: NULL or array of lws_extension structs listing the
1829 * extensions this context supports. */
1830 const struct lws_token_limits *token_limits;
1831 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1832 * with a token length limit for each possible WSI_TOKEN_ */
1833 const char *ssl_private_key_password;
1834 /**< VHOST: NULL or the passphrase needed for the private key */
1835 const char *ssl_cert_filepath;
1836 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1837 * to listen using SSL, set to the filepath to fetch the
1838 * server cert from, otherwise NULL for unencrypted */
1839 const char *ssl_private_key_filepath;
1840 /**< VHOST: filepath to private key if wanting SSL mode;
1841 * if this is set to NULL but sll_cert_filepath is set, the
1842 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1843 * to allow setting of the private key directly via openSSL
1845 const char *ssl_ca_filepath;
1846 /**< VHOST: CA certificate filepath or NULL */
1847 const char *ssl_cipher_list;
1848 /**< VHOST: List of valid ciphers to use (eg,
1849 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1850 * or you can leave it as NULL to get "DEFAULT" */
1851 const char *http_proxy_address;
1852 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1853 * If proxy auth is required, use format "username:password\@server:port" */
1854 unsigned int http_proxy_port;
1855 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1857 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1859 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1860 unsigned int options;
1861 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1863 /**< CONTEXT: optional user pointer that can be recovered via the context
1864 * pointer using lws_context_user */
1866 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1867 * timeout to all libwebsocket sockets, client or server */
1869 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1870 * times to try to get a response from the peer before giving up
1871 * and killing the connection */
1873 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1875 #ifdef LWS_OPENSSL_SUPPORT
1876 SSL_CTX *provided_client_ssl_ctx;
1877 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1878 * implementation for the one provided by provided_ssl_ctx.
1879 * Libwebsockets no longer is responsible for freeing the context
1880 * if this option is selected. */
1881 #else /* maintain structure layout either way */
1882 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1885 short max_http_header_data;
1886 /**< CONTEXT: The max amount of header payload that can be handled
1887 * in an http request (unrecognized header payload is dropped) */
1888 short max_http_header_pool;
1889 /**< CONTEXT: The max number of connections with http headers that
1890 * can be processed simultaneously (the corresponding memory is
1891 * allocated for the lifetime of the context). If the pool is
1892 * busy new incoming connections must wait for accept until one
1895 unsigned int count_threads;
1896 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1897 unsigned int fd_limit_per_thread;
1898 /**< CONTEXT: nonzero means restrict each service thread to this
1899 * many fds, 0 means the default which is divide the process fd
1900 * limit by the number of threads. */
1901 unsigned int timeout_secs;
1902 /**< VHOST: various processes involving network roundtrips in the
1903 * library are protected from hanging forever by timeouts. If
1904 * nonzero, this member lets you set the timeout used in seconds.
1905 * Otherwise a default timeout is used. */
1906 const char *ecdh_curve;
1907 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1908 const char *vhost_name;
1909 /**< VHOST: name of vhost, must match external DNS name used to
1910 * access the site, like "warmcat.com" as it's used to match
1911 * Host: header and / or SNI name for SSL. */
1912 const char * const *plugin_dirs;
1913 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1914 * scan for lws protocol plugins at context creation time */
1915 const struct lws_protocol_vhost_options *pvo;
1916 /**< VHOST: pointer to optional linked list of per-vhost
1917 * options made accessible to protocols */
1918 int keepalive_timeout;
1919 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1920 * client to hold on to an idle HTTP/1.1 connection */
1921 const char *log_filepath;
1922 /**< VHOST: filepath to append logs to... this is opened before
1923 * any dropping of initial privileges */
1924 const struct lws_http_mount *mounts;
1925 /**< VHOST: optional linked list of mounts for this vhost */
1926 const char *server_string;
1927 /**< CONTEXT: string used in HTTP headers to identify server
1928 * software, if NULL, "libwebsockets". */
1929 unsigned int pt_serv_buf_size;
1930 /**< CONTEXT: 0 = default of 4096. This buffer is used by
1931 * various service related features including file serving, it
1932 * defines the max chunk of file that can be sent at once.
1933 * At the risk of lws having to buffer failed large sends, it
1934 * can be increased to, eg, 128KiB to improve throughput. */
1935 unsigned int max_http_header_data2;
1936 /**< CONTEXT: if max_http_header_data is 0 and this
1937 * is nonzero, this will be used in place of the default. It's
1938 * like this for compatibility with the original short version,
1939 * this is unsigned int length. */
1940 long ssl_options_set;
1941 /**< VHOST: Any bits set here will be set as SSL options */
1942 long ssl_options_clear;
1943 /**< VHOST: Any bits set here will be cleared as SSL options */
1944 unsigned short ws_ping_pong_interval;
1945 /**< CONTEXT: 0 for none, else interval in seconds between sending
1946 * PINGs on idle websocket connections. When the PING is sent,
1947 * the PONG must come within the normal timeout_secs timeout period
1948 * or the connection will be dropped.
1949 * Any RX or TX traffic on the connection restarts the interval timer,
1950 * so a connection which always sends or receives something at intervals
1951 * less than the interval given here will never send PINGs / expect
1952 * PONGs. Conversely as soon as the ws connection is established, an
1953 * idle connection will do the PING / PONG roundtrip as soon as
1954 * ws_ping_pong_interval seconds has passed without traffic
1956 const struct lws_protocol_vhost_options *headers;
1957 /**< VHOST: pointer to optional linked list of per-vhost
1958 * canned headers that are added to server responses */
1960 const struct lws_protocol_vhost_options *reject_service_keywords;
1961 /**< CONTEXT: Optional list of keywords and rejection codes + text.
1963 * The keywords are checked for existing in the user agent string.
1965 * Eg, "badrobot" "404 Not Found"
1967 void *external_baggage_free_on_destroy;
1968 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
1969 * should be freed when the context is destroyed. This allows you to
1970 * automatically sync the freeing action to the context destruction
1971 * action, so there is no need for an external free() if the context
1972 * succeeded to create.
1975 #ifdef LWS_OPENSSL_SUPPORT
1976 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1977 * with a token length limit for each possible WSI_TOKEN_ */
1978 const char *client_ssl_private_key_password;
1979 /**< VHOST: NULL or the passphrase needed for the private key */
1980 const char *client_ssl_cert_filepath;
1981 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1982 * to listen using SSL, set to the filepath to fetch the
1983 * server cert from, otherwise NULL for unencrypted */
1984 const char *client_ssl_private_key_filepath;
1985 /**< VHOST: filepath to private key if wanting SSL mode;
1986 * if this is set to NULL but sll_cert_filepath is set, the
1987 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1988 * to allow setting of the private key directly via openSSL
1990 const char *client_ssl_ca_filepath;
1991 /**< VHOST: CA certificate filepath or NULL */
1992 const char *client_ssl_cipher_list;
1993 /**< VHOST: List of valid ciphers to use (eg,
1994 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1995 * or you can leave it as NULL to get "DEFAULT" */
1998 const struct lws_plat_file_ops *fops;
1999 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
2000 * by a sentinel with NULL .open.
2002 * If NULL, lws provides just the platform file operations struct for
2003 * backwards compatibility.
2005 int simultaneous_ssl_restriction;
2006 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
2007 const char *socks_proxy_address;
2008 /**< VHOST: If non-NULL, attempts to proxy via the given address.
2009 * If proxy auth is required, use format "username:password\@server:port" */
2010 unsigned int socks_proxy_port;
2011 /**< VHOST: If socks_proxy_address was non-NULL, uses this port */
2012 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
2013 cap_value_t caps[4];
2014 /**< CONTEXT: array holding Linux capabilities you want to
2015 * continue to be available to the server after it transitions
2016 * to a noprivileged user. Usually none are needed but for, eg,
2017 * .bind_iface, CAP_NET_RAW is required. This gives you a way
2018 * to still have the capability but drop root.
2021 /**< CONTEXT: count of Linux capabilities in .caps[]. 0 means
2022 * no capabilities will be inherited from root (the default) */
2025 /**< VHOST: nonzero to strictly bind sockets to the interface name in
2026 * .iface (eg, "eth2"), using SO_BIND_TO_DEVICE.
2028 * Requires SO_BINDTODEVICE support from your OS and CAP_NET_RAW
2031 * Notice that common things like access network interface IP from
2032 * your local machine use your lo / loopback interface and will be
2033 * disallowed by this.
2036 /* Add new things just above here ---^
2037 * This is part of the ABI, don't needlessly break compatibility
2039 * The below is to ensure later library versions with new
2040 * members added above will see 0 (default) even if the app
2041 * was not built against the newer headers.
2044 void *_unused[8]; /**< dummy */
2048 * lws_create_context() - Create the websocket handler
2049 * \param info: pointer to struct with parameters
2051 * This function creates the listening socket (if serving) and takes care
2052 * of all initialization in one step.
2054 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
2055 * created; you're expected to create your own vhosts afterwards using
2056 * lws_create_vhost(). Otherwise a vhost named "default" is also created
2057 * using the information in the vhost-related members, for compatibility.
2059 * After initialization, it returns a struct lws_context * that
2060 * represents this server. After calling, user code needs to take care
2061 * of calling lws_service() with the context pointer to get the
2062 * server's sockets serviced. This must be done in the same process
2063 * context as the initialization call.
2065 * The protocol callback functions are called for a handful of events
2066 * including http requests coming in, websocket connections becoming
2067 * established, and data arriving; it's also called periodically to allow
2068 * async transmission.
2070 * HTTP requests are sent always to the FIRST protocol in protocol, since
2071 * at that time websocket protocol has not been negotiated. Other
2072 * protocols after the first one never see any HTTP callback activity.
2074 * The server created is a simple http server by default; part of the
2075 * websocket standard is upgrading this http connection to a websocket one.
2077 * This allows the same server to provide files like scripts and favicon /
2078 * images or whatever over http and dynamic data over websockets all in
2079 * one place; they're all handled in the user callback.
2081 LWS_VISIBLE LWS_EXTERN struct lws_context *
2082 lws_create_context(struct lws_context_creation_info *info);
2085 * lws_context_destroy() - Destroy the websocket context
2086 * \param context: Websocket context
2088 * This function closes any active connections and then frees the
2089 * context. After calling this, any further use of the context is
2092 LWS_VISIBLE LWS_EXTERN void
2093 lws_context_destroy(struct lws_context *context);
2095 LWS_VISIBLE LWS_EXTERN void
2096 lws_context_destroy2(struct lws_context *context);
2098 typedef int (*lws_reload_func)(void);
2101 * lws_context_deprecate() - Deprecate the websocket context
2102 * \param context: Websocket context
2104 * This function is used on an existing context before superceding it
2105 * with a new context.
2107 * It closes any listen sockets in the context, so new connections are
2110 * And it marks the context to be deleted when the number of active
2111 * connections into it falls to zero.
2113 * Otherwise if you attach the deprecated context to the replacement
2114 * context when it has been created using lws_context_attach_deprecated()
2115 * both any deprecated and the new context will service their connections.
2117 * This is aimed at allowing seamless configuration reloads.
2119 * The callback cb will be called after the listen sockets are actually
2120 * closed and may be reopened. In the callback the new context should be
2121 * configured and created. (With libuv, socket close happens async after
2122 * more loop events).
2124 LWS_VISIBLE LWS_EXTERN void
2125 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2127 LWS_VISIBLE LWS_EXTERN int
2128 lws_context_is_deprecated(struct lws_context *context);
2131 * lws_set_proxy() - Setups proxy to lws_context.
2132 * \param vhost: pointer to struct lws_vhost you want set proxy for
2133 * \param proxy: pointer to c string containing proxy in format address:port
2135 * Returns 0 if proxy string was parsed and proxy was setup.
2136 * Returns -1 if proxy is NULL or has incorrect format.
2138 * This is only required if your OS does not provide the http_proxy
2139 * environment variable (eg, OSX)
2141 * IMPORTANT! You should call this function right after creation of the
2142 * lws_context and before call to connect. If you call this
2143 * function after connect behavior is undefined.
2144 * This function will override proxy settings made on lws_context
2145 * creation with genenv() call.
2147 LWS_VISIBLE LWS_EXTERN int
2148 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2151 * lws_set_socks() - Setup socks to lws_context.
2152 * \param vhost: pointer to struct lws_vhost you want set socks for
2153 * \param socks: pointer to c string containing socks in format address:port
2155 * Returns 0 if socks string was parsed and socks was setup.
2156 * Returns -1 if socks is NULL or has incorrect format.
2158 * This is only required if your OS does not provide the socks_proxy
2159 * environment variable (eg, OSX)
2161 * IMPORTANT! You should call this function right after creation of the
2162 * lws_context and before call to connect. If you call this
2163 * function after connect behavior is undefined.
2164 * This function will override proxy settings made on lws_context
2165 * creation with genenv() call.
2167 LWS_VISIBLE LWS_EXTERN int
2168 lws_set_socks(struct lws_vhost *vhost, const char *socks);
2173 * lws_create_vhost() - Create a vhost (virtual server context)
2174 * \param context: pointer to result of lws_create_context()
2175 * \param info: pointer to struct with parameters
2177 * This function creates a virtual server (vhost) using the vhost-related
2178 * members of the info struct. You can create many vhosts inside one context
2179 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2181 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
2182 lws_create_vhost(struct lws_context *context,
2183 struct lws_context_creation_info *info);
2186 * lwsws_get_config_globals() - Parse a JSON server config file
2187 * \param info: pointer to struct with parameters
2188 * \param d: filepath of the config file
2189 * \param config_strings: storage for the config strings extracted from JSON,
2190 * the pointer is incremented as strings are stored
2191 * \param len: pointer to the remaining length left in config_strings
2192 * the value is decremented as strings are stored
2194 * This function prepares a n lws_context_creation_info struct with global
2195 * settings from a file d.
2197 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2199 LWS_VISIBLE LWS_EXTERN int
2200 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2201 char **config_strings, int *len);
2204 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2205 * \param context: pointer to result of lws_create_context()
2206 * \param info: pointer to struct with parameters
2207 * \param d: filepath of the config file
2208 * \param config_strings: storage for the config strings extracted from JSON,
2209 * the pointer is incremented as strings are stored
2210 * \param len: pointer to the remaining length left in config_strings
2211 * the value is decremented as strings are stored
2213 * This function creates vhosts into a context according to the settings in
2214 *JSON files found in directory d.
2216 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2218 LWS_VISIBLE LWS_EXTERN int
2219 lwsws_get_config_vhosts(struct lws_context *context,
2220 struct lws_context_creation_info *info, const char *d,
2221 char **config_strings, int *len);
2223 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2224 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2225 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2228 * lws_get_vhost() - return the vhost a wsi belongs to
2230 * \param wsi: which connection
2232 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2233 lws_get_vhost(struct lws *wsi);
2236 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2238 * \param vh: the vhost
2239 * \param buf: buffer to fill with JSON
2240 * \param len: max length of buf
2242 LWS_VISIBLE LWS_EXTERN int
2243 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2246 * lws_json_dump_context() - describe context state and stats in JSON
2248 * \param context: the context
2249 * \param buf: buffer to fill with JSON
2250 * \param len: max length of buf
2252 LWS_VISIBLE LWS_EXTERN int
2253 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2257 * lws_context_user() - get the user data associated with the context
2258 * \param context: Websocket context
2260 * This returns the optional user allocation that can be attached to
2261 * the context the sockets live in at context_create time. It's a way
2262 * to let all sockets serviced in the same context share data without
2263 * using globals statics in the user code.
2265 LWS_VISIBLE LWS_EXTERN void *
2266 lws_context_user(struct lws_context *context);
2268 /*! \defgroup vhost-mounts Vhost mounts and options
2269 * \ingroup context-and-vhost-creation
2271 * ##Vhost mounts and options
2274 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2275 * name=value options
2277 * This provides a general way to attach a linked-list of name=value pairs,
2278 * which can also have an optional child link-list using the options member.
2280 struct lws_protocol_vhost_options {
2281 const struct lws_protocol_vhost_options *next; /**< linked list */
2282 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2283 const char *name; /**< name of name=value pair */
2284 const char *value; /**< value of name=value pair */
2287 /** enum lws_mount_protocols
2288 * This specifies the mount protocol for a mountpoint, whether it is to be
2289 * served from a filesystem, or it is a cgi etc.
2291 enum lws_mount_protocols {
2292 LWSMPRO_HTTP = 0, /**< http reverse proxy */
2293 LWSMPRO_HTTPS = 1, /**< https reverse proxy */
2294 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2295 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2296 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2297 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2298 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2301 /** struct lws_http_mount
2303 * arguments for mounting something in a vhost's url namespace
2305 struct lws_http_mount {
2306 const struct lws_http_mount *mount_next;
2307 /**< pointer to next struct lws_http_mount */
2308 const char *mountpoint;
2309 /**< mountpoint in http pathspace, eg, "/" */
2311 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2313 /**< default target, eg, "index.html" */
2314 const char *protocol;
2315 /**<"protocol-name" to handle mount */
2317 const struct lws_protocol_vhost_options *cgienv;
2318 /**< optional linked-list of cgi options. These are created
2319 * as environment variables for the cgi process
2321 const struct lws_protocol_vhost_options *extra_mimetypes;
2322 /**< optional linked-list of mimetype mappings */
2323 const struct lws_protocol_vhost_options *interpret;
2324 /**< optional linked-list of files to be interpreted */
2327 /**< seconds cgi is allowed to live, if cgi://mount type */
2329 /**< max-age for reuse of client cache of files, seconds */
2330 unsigned int auth_mask;
2331 /**< bits set here must be set for authorized client session */
2333 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2334 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2335 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2337 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2338 unsigned char mountpoint_len; /**< length of mountpoint string */
2340 const char *basic_auth_login_file;
2341 /**<NULL, or filepath to use to check basic auth logins against */
2343 /* Add new things just above here ---^
2344 * This is part of the ABI, don't needlessly break compatibility
2346 * The below is to ensure later library versions with new
2347 * members added above will see 0 (default) even if the app
2348 * was not built against the newer headers.
2351 void *_unused[2]; /**< dummy */
2356 /*! \defgroup client
2359 * ##Client releated functions
2363 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2364 * with struct lws_client_connect_info ssl_connection member to control if
2365 * and how SSL checks apply to the client connection being created
2368 enum lws_client_connect_ssl_connection_flags {
2369 LCCSCF_USE_SSL = (1 << 0),
2370 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2371 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2372 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2375 /** struct lws_client_connect_info - parameters to connect with when using
2376 * lws_client_connect_via_info() */
2378 struct lws_client_connect_info {
2379 struct lws_context *context;
2380 /**< lws context to create connection in */
2381 const char *address;
2382 /**< remote address to connect to */
2384 /**< remote port to connect to */
2386 /**< nonzero for ssl */
2390 /**< content of host header */
2392 /**< content of origin header */
2393 const char *protocol;
2394 /**< list of ws protocols we could accept */
2395 int ietf_version_or_minus_one;
2396 /**< deprecated: currently leave at 0 or -1 */
2398 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2399 const void *client_exts;
2400 /**< UNUSED... provide in info.extensions at context creation time */
2402 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2403 * use "GET" to be a simple http client connection */
2404 struct lws *parent_wsi;
2405 /**< if another wsi is responsible for this connection, give it here.
2406 * this is used to make sure if the parent closes so do any
2407 * child connections first. */
2408 const char *uri_replace_from;
2409 /**< if non-NULL, when this string is found in URIs in
2410 * text/html content-encoding, it's replaced with uri_replace_to */
2411 const char *uri_replace_to;
2412 /**< see uri_replace_from */
2413 struct lws_vhost *vhost;
2414 /**< vhost to bind to (used to determine related SSL_CTX) */
2416 /**< if not NULL, store the new wsi here early in the connection
2417 * process. Although we return the new wsi, the call to create the
2418 * client connection does progress the connection somewhat and may
2419 * meet an error that will result in the connection being scrubbed and
2420 * NULL returned. While the wsi exists though, he may process a
2421 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2422 * user callback a way to identify which wsi it is that faced the error
2423 * even before the new wsi is returned and even if ultimately no wsi
2427 /**< NULL to allow routing on any interface, or interface name or IP
2428 * to bind the socket to */
2430 /* Add new things just above here ---^
2431 * This is part of the ABI, don't needlessly break compatibility
2433 * The below is to ensure later library versions with new
2434 * members added above will see 0 (default) even if the app
2435 * was not built against the newer headers.
2438 void *_unused[4]; /**< dummy */
2442 * lws_client_connect_via_info() - Connect to another websocket server
2443 * \param ccinfo: pointer to lws_client_connect_info struct
2445 * This function creates a connection to a remote server using the
2446 * information provided in ccinfo.
2448 LWS_VISIBLE LWS_EXTERN struct lws *
2449 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2452 * lws_client_connect() - Connect to another websocket server
2453 * \deprecated DEPRECATED use lws_client_connect_via_info
2454 * \param clients: Websocket context
2455 * \param address: Remote server address, eg, "myserver.com"
2456 * \param port: Port to connect to on the remote server, eg, 80
2457 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2459 * \param path: Websocket path on server
2460 * \param host: Hostname on server
2461 * \param origin: Socket origin name
2462 * \param protocol: Comma-separated list of protocols being asked for from
2463 * the server, or just one. The server will pick the one it
2464 * likes best. If you don't want to specify a protocol, which is
2465 * legal, use NULL here.
2466 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2467 * protocol supported, or the specific protocol ordinal
2469 * This function creates a connection to a remote server
2471 /* deprecated, use lws_client_connect_via_info() */
2472 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2473 lws_client_connect(struct lws_context *clients, const char *address,
2474 int port, int ssl_connection, const char *path,
2475 const char *host, const char *origin, const char *protocol,
2476 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2477 /* deprecated, use lws_client_connect_via_info() */
2479 * lws_client_connect_extended() - Connect to another websocket server
2480 * \deprecated DEPRECATED use lws_client_connect_via_info
2481 * \param clients: Websocket context
2482 * \param address: Remote server address, eg, "myserver.com"
2483 * \param port: Port to connect to on the remote server, eg, 80
2484 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2486 * \param path: Websocket path on server
2487 * \param host: Hostname on server
2488 * \param origin: Socket origin name
2489 * \param protocol: Comma-separated list of protocols being asked for from
2490 * the server, or just one. The server will pick the one it
2492 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2493 * protocol supported, or the specific protocol ordinal
2494 * \param userdata: Pre-allocated user data
2496 * This function creates a connection to a remote server
2498 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2499 lws_client_connect_extended(struct lws_context *clients, const char *address,
2500 int port, int ssl_connection, const char *path,
2501 const char *host, const char *origin,
2502 const char *protocol, int ietf_version_or_minus_one,
2503 void *userdata) LWS_WARN_DEPRECATED;
2506 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2508 * \param info: client ssl related info
2509 * \param vhost: which vhost to initialize client ssl operations on
2511 * You only need to call this if you plan on using SSL client connections on
2512 * the vhost. For non-SSL client connections, it's not necessary to call this.
2514 * The following members of info are used during the call
2516 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2517 * otherwise the call does nothing
2518 * - provided_client_ssl_ctx must be NULL to get a generated client
2519 * ssl context, otherwise you can pass a prepared one in by setting it
2520 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2521 * - ssl_ca_filepath may be NULL or client cert filepath
2522 * - ssl_cert_filepath may be NULL or client cert filepath
2523 * - ssl_private_key_filepath may be NULL or client cert private key
2525 * You must create your vhost explicitly if you want to use this, so you have
2526 * a pointer to the vhost. Create the context first with the option flag
2527 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2528 * the same info struct.
2530 LWS_VISIBLE LWS_EXTERN int
2531 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2532 struct lws_vhost *vhost);
2534 * lws_http_client_read() - consume waiting received http client data
2536 * \param wsi: client connection
2537 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2538 * \param len: pointer to chunk length - fill with max length of buffer
2540 * This is called when the user code is notified client http data has arrived.
2541 * The user code may choose to delay calling it to consume the data, for example
2542 * waiting until an onward connection is writeable.
2544 * For non-chunked connections, up to len bytes of buf are filled with the
2545 * received content. len is set to the actual amount filled before return.
2547 * For chunked connections, the linear buffer content contains the chunking
2548 * headers and it cannot be passed in one lump. Instead, this function will
2549 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2550 * chunk start and len set to the chunk length. There will be as many calls
2551 * as there are chunks or partial chunks in the buffer.
2553 LWS_VISIBLE LWS_EXTERN int
2554 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2557 * lws_http_client_http_response() - get last HTTP response code
2559 * \param wsi: client connection
2561 * Returns the last server response code, eg, 200 for client http connections.
2563 LWS_VISIBLE LWS_EXTERN unsigned int
2564 lws_http_client_http_response(struct lws *wsi);
2566 LWS_VISIBLE LWS_EXTERN void
2567 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2570 * lws_client_http_body_pending() - control if client connection neeeds to send body
2572 * \param wsi: client connection
2573 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2574 * if nothing more to send
2576 * If you will send payload data with your HTTP client connection, eg, for POST,
2577 * when you set the related http headers in
2578 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2579 * this API with something_left_to_send nonzero, and call
2580 * lws_callback_on_writable(wsi);
2582 * After sending the headers, lws will call your callback with
2583 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2584 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2585 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2586 * let lws know the last part is sent and the connection can move on.
2591 /** \defgroup service Built-in service loop entry
2593 * ##Built-in service loop entry
2595 * If you're not using libev / libuv, these apis are needed to enter the poll()
2596 * wait in lws and service any connections with pending events.
2601 * lws_service() - Service any pending websocket activity
2602 * \param context: Websocket context
2603 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2604 * service otherwise block and service immediately, returning
2605 * after the timeout if nothing needed service.
2607 * This function deals with any pending websocket traffic, for three
2608 * kinds of event. It handles these events on both server and client
2609 * types of connection the same.
2611 * 1) Accept new connections to our context's server
2613 * 2) Call the receive callback for incoming frame data received by
2614 * server or client connections.
2616 * You need to call this service function periodically to all the above
2617 * functions to happen; if your application is single-threaded you can
2618 * just call it in your main event loop.
2620 * Alternatively you can fork a new process that asynchronously handles
2621 * calling this service in a loop. In that case you are happy if this
2622 * call blocks your thread until it needs to take care of something and
2623 * would call it with a large nonzero timeout. Your loop then takes no
2624 * CPU while there is nothing happening.
2626 * If you are calling it in a single-threaded app, you don't want it to
2627 * wait around blocking other things in your loop from happening, so you
2628 * would call it with a timeout_ms of 0, so it returns immediately if
2629 * nothing is pending, or as soon as it services whatever was pending.
2631 LWS_VISIBLE LWS_EXTERN int
2632 lws_service(struct lws_context *context, int timeout_ms);
2635 * lws_service() - Service any pending websocket activity
2637 * \param context: Websocket context
2638 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2639 * service otherwise block and service immediately, returning
2640 * after the timeout if nothing needed service.
2642 * Same as lws_service(), but for a specific thread service index. Only needed
2643 * if you are spawning multiple service threads.
2645 LWS_VISIBLE LWS_EXTERN int
2646 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2649 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2651 * \param wsi: Cancel service on the thread this wsi is serviced by
2653 * This function lets a call to lws_service() waiting for a timeout
2654 * immediately return.
2656 * It works by creating a phony event and then swallowing it silently.
2658 * The reason it may be needed is when waiting in poll(), changes to
2659 * the event masks are ignored by the OS until poll() is reentered. This
2660 * lets you halt the poll() wait and make the reentry happen immediately
2661 * instead of having the wait out the rest of the poll timeout.
2663 LWS_VISIBLE LWS_EXTERN void
2664 lws_cancel_service_pt(struct lws *wsi);
2667 * lws_cancel_service() - Cancel wait for new pending socket activity
2668 * \param context: Websocket context
2670 * This function let a call to lws_service() waiting for a timeout
2671 * immediately return.
2673 * What it basically does is provide a fake event that will be swallowed,
2674 * so the wait in poll() is ended. That's useful because poll() doesn't
2675 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2677 LWS_VISIBLE LWS_EXTERN void
2678 lws_cancel_service(struct lws_context *context);
2681 * lws_service_fd() - Service polled socket with something waiting
2682 * \param context: Websocket context
2683 * \param pollfd: The pollfd entry describing the socket fd and which events
2684 * happened, or NULL to tell lws to do only timeout servicing.
2686 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2687 * services it according to the state of the associated
2690 * The one call deals with all "service" that might happen on a socket
2691 * including listen accepts, http files as well as websocket protocol.
2693 * If a pollfd says it has something, you can just pass it to
2694 * lws_service_fd() whether it is a socket handled by lws or not.
2695 * If it sees it is a lws socket, the traffic will be handled and
2696 * pollfd->revents will be zeroed now.
2698 * If the socket is foreign to lws, it leaves revents alone. So you can
2699 * see if you should service yourself by checking the pollfd revents
2700 * after letting lws try to service it.
2702 * You should also call this with pollfd = NULL to just allow the
2703 * once-per-second global timeout checks; if less than a second since the last
2704 * check it returns immediately then.
2706 LWS_VISIBLE LWS_EXTERN int
2707 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2710 * lws_service_fd_tsi() - Service polled socket in specific service thread
2711 * \param context: Websocket context
2712 * \param pollfd: The pollfd entry describing the socket fd and which events
2714 * \param tsi: thread service index
2716 * Same as lws_service_fd() but used with multiple service threads
2718 LWS_VISIBLE LWS_EXTERN int
2719 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2723 * lws_service_adjust_timeout() - Check for any connection needing forced service
2724 * \param context: Websocket context
2725 * \param timeout_ms: The original poll timeout value. You can just set this
2726 * to 1 if you don't really have a poll timeout.
2727 * \param tsi: thread service index
2729 * Under some conditions connections may need service even though there is no
2730 * pending network action on them, this is "forced service". For default
2731 * poll() and libuv / libev, the library takes care of calling this and
2732 * dealing with it for you. But for external poll() integration, you need
2733 * access to the apis.
2735 * If anybody needs "forced service", returned timeout is zero. In that case,
2736 * you can call lws_service_tsi() with a timeout of -1 to only service
2737 * guys who need forced service.
2739 LWS_VISIBLE LWS_EXTERN int
2740 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2742 /* Backwards compatibility */
2743 #define lws_plat_service_tsi lws_service_tsi
2747 /*! \defgroup http HTTP
2749 Modules related to handling HTTP
2753 /*! \defgroup httpft HTTP File transfer
2756 APIs for sending local files in response to HTTP requests
2761 * lws_get_mimetype() - Determine mimetype to use from filename
2763 * \param file: filename
2764 * \param m: NULL, or mount context
2766 * This uses a canned list of known filetypes first, if no match and m is
2767 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2769 * Returns either NULL or a pointer to the mimetype matching the file.
2771 LWS_VISIBLE LWS_EXTERN const char *
2772 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2775 * lws_serve_http_file() - Send a file back to the client using http
2776 * \param wsi: Websocket instance (available from user callback)
2777 * \param file: The file to issue over http
2778 * \param content_type: The http content type, eg, text/html
2779 * \param other_headers: NULL or pointer to header string
2780 * \param other_headers_len: length of the other headers if non-NULL
2782 * This function is intended to be called from the callback in response
2783 * to http requests from the client. It allows the callback to issue
2784 * local files down the http link in a single step.
2786 * Returning <0 indicates error and the wsi should be closed. Returning
2787 * >0 indicates the file was completely sent and
2788 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2789 * ==0 indicates the file transfer is started and needs more service later,
2790 * the wsi should be left alone.
2792 LWS_VISIBLE LWS_EXTERN int
2793 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2794 const char *other_headers, int other_headers_len);
2796 LWS_VISIBLE LWS_EXTERN int
2797 lws_serve_http_file_fragment(struct lws *wsi);
2800 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2803 * ##HTML chunked Substitution
2805 * APIs for receiving chunks of text, replacing a set of variable names via
2806 * a callback, and then prepending and appending HTML chunked encoding
2812 HTTP_STATUS_OK = 200,
2813 HTTP_STATUS_NO_CONTENT = 204,
2814 HTTP_STATUS_PARTIAL_CONTENT = 206,
2816 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2817 HTTP_STATUS_FOUND = 302,
2818 HTTP_STATUS_SEE_OTHER = 303,
2819 HTTP_STATUS_NOT_MODIFIED = 304,
2821 HTTP_STATUS_BAD_REQUEST = 400,
2822 HTTP_STATUS_UNAUTHORIZED,
2823 HTTP_STATUS_PAYMENT_REQUIRED,
2824 HTTP_STATUS_FORBIDDEN,
2825 HTTP_STATUS_NOT_FOUND,
2826 HTTP_STATUS_METHOD_NOT_ALLOWED,
2827 HTTP_STATUS_NOT_ACCEPTABLE,
2828 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2829 HTTP_STATUS_REQUEST_TIMEOUT,
2830 HTTP_STATUS_CONFLICT,
2832 HTTP_STATUS_LENGTH_REQUIRED,
2833 HTTP_STATUS_PRECONDITION_FAILED,
2834 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2835 HTTP_STATUS_REQ_URI_TOO_LONG,
2836 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2837 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2838 HTTP_STATUS_EXPECTATION_FAILED,
2840 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2841 HTTP_STATUS_NOT_IMPLEMENTED,
2842 HTTP_STATUS_BAD_GATEWAY,
2843 HTTP_STATUS_SERVICE_UNAVAILABLE,
2844 HTTP_STATUS_GATEWAY_TIMEOUT,
2845 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2848 struct lws_process_html_args {
2849 char *p; /**< pointer to the buffer containing the data */
2850 int len; /**< length of the original data at p */
2851 int max_len; /**< maximum length we can grow the data to */
2852 int final; /**< set if this is the last chunk of the file */
2855 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2857 struct lws_process_html_state {
2858 char *start; /**< pointer to start of match */
2859 char swallow[16]; /**< matched character buffer */
2860 int pos; /**< position in match */
2861 void *data; /**< opaque pointer */
2862 const char * const *vars; /**< list of variable names */
2863 int count_vars; /**< count of variable names */
2865 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2868 /*! lws_chunked_html_process() - generic chunked substitution
2869 * \param args: buffer to process using chunked encoding
2870 * \param s: current processing state
2872 LWS_VISIBLE LWS_EXTERN int
2873 lws_chunked_html_process(struct lws_process_html_args *args,
2874 struct lws_process_html_state *s);
2877 /** \defgroup HTTP-headers-read HTTP headers: read
2880 * ##HTTP header releated functions
2882 * In lws the client http headers are temporarily stored in a pool, only for the
2883 * duration of the http part of the handshake. It's because in most cases,
2884 * the header content is ignored for the whole rest of the connection lifetime
2885 * and would then just be taking up space needlessly.
2887 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2888 * the http headers are still allocated, you can use these apis then to
2889 * look at and copy out interesting header content (cookies, etc)
2891 * Notice that the header total length reported does not include a terminating
2892 * '\0', however you must allocate for it when using the _copy apis. So the
2893 * length reported for a header containing "123" is 3, but you must provide
2894 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2895 * will fail with a nonzero return code.
2897 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2898 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2899 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2900 * length to confirm the method.
2902 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2903 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2904 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2906 * As a convenience, lws has an api that will find the fragment with a
2907 * given name= part, lws_get_urlarg_by_name().
2911 /** struct lws_tokens
2912 * you need these to look at headers that have been parsed if using the
2913 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
2914 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
2915 * points to .token_len chars containing that header content.
2918 char *token; /**< pointer to start of the token */
2919 int token_len; /**< length of the token's value */
2922 /* enum lws_token_indexes
2923 * these have to be kept in sync with lextable.h / minilex.c
2925 * NOTE: These public enums are part of the abi. If you want to add one,
2926 * add it at where specified so existing users are unaffected.
2928 enum lws_token_indexes {
2929 WSI_TOKEN_GET_URI = 0,
2930 WSI_TOKEN_POST_URI = 1,
2931 WSI_TOKEN_OPTIONS_URI = 2,
2933 WSI_TOKEN_CONNECTION = 4,
2934 WSI_TOKEN_UPGRADE = 5,
2935 WSI_TOKEN_ORIGIN = 6,
2936 WSI_TOKEN_DRAFT = 7,
2937 WSI_TOKEN_CHALLENGE = 8,
2938 WSI_TOKEN_EXTENSIONS = 9,
2939 WSI_TOKEN_KEY1 = 10,
2940 WSI_TOKEN_KEY2 = 11,
2941 WSI_TOKEN_PROTOCOL = 12,
2942 WSI_TOKEN_ACCEPT = 13,
2943 WSI_TOKEN_NONCE = 14,
2944 WSI_TOKEN_HTTP = 15,
2945 WSI_TOKEN_HTTP2_SETTINGS = 16,
2946 WSI_TOKEN_HTTP_ACCEPT = 17,
2947 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2948 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2949 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2950 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2951 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2952 WSI_TOKEN_HTTP_PRAGMA = 23,
2953 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2954 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2955 WSI_TOKEN_HTTP_COOKIE = 26,
2956 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2957 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2958 WSI_TOKEN_HTTP_DATE = 29,
2959 WSI_TOKEN_HTTP_RANGE = 30,
2960 WSI_TOKEN_HTTP_REFERER = 31,
2962 WSI_TOKEN_VERSION = 33,
2963 WSI_TOKEN_SWORIGIN = 34,
2965 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2966 WSI_TOKEN_HTTP_COLON_METHOD = 36,
2967 WSI_TOKEN_HTTP_COLON_PATH = 37,
2968 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2969 WSI_TOKEN_HTTP_COLON_STATUS = 39,
2971 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2972 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2973 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2974 WSI_TOKEN_HTTP_AGE = 43,
2975 WSI_TOKEN_HTTP_ALLOW = 44,
2976 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2977 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2978 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2979 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2980 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2981 WSI_TOKEN_HTTP_ETAG = 50,
2982 WSI_TOKEN_HTTP_EXPECT = 51,
2983 WSI_TOKEN_HTTP_EXPIRES = 52,
2984 WSI_TOKEN_HTTP_FROM = 53,
2985 WSI_TOKEN_HTTP_IF_MATCH = 54,
2986 WSI_TOKEN_HTTP_IF_RANGE = 55,
2987 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2988 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2989 WSI_TOKEN_HTTP_LINK = 58,
2990 WSI_TOKEN_HTTP_LOCATION = 59,
2991 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2992 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2993 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2994 WSI_TOKEN_HTTP_REFRESH = 63,
2995 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2996 WSI_TOKEN_HTTP_SERVER = 65,
2997 WSI_TOKEN_HTTP_SET_COOKIE = 66,
2998 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2999 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
3000 WSI_TOKEN_HTTP_USER_AGENT = 69,
3001 WSI_TOKEN_HTTP_VARY = 70,
3002 WSI_TOKEN_HTTP_VIA = 71,
3003 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
3005 WSI_TOKEN_PATCH_URI = 73,
3006 WSI_TOKEN_PUT_URI = 74,
3007 WSI_TOKEN_DELETE_URI = 75,
3009 WSI_TOKEN_HTTP_URI_ARGS = 76,
3010 WSI_TOKEN_PROXY = 77,
3011 WSI_TOKEN_HTTP_X_REAL_IP = 78,
3012 WSI_TOKEN_HTTP1_0 = 79,
3013 WSI_TOKEN_X_FORWARDED_FOR = 80,
3014 WSI_TOKEN_CONNECT = 81,
3015 /****** add new things just above ---^ ******/
3017 /* use token storage to stash these internally, not for
3020 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
3021 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
3022 _WSI_TOKEN_CLIENT_URI,
3023 _WSI_TOKEN_CLIENT_HOST,
3024 _WSI_TOKEN_CLIENT_ORIGIN,
3025 _WSI_TOKEN_CLIENT_METHOD,
3026 _WSI_TOKEN_CLIENT_IFACE,
3028 /* always last real token index*/
3031 /* parser state additions, no storage associated */
3032 WSI_TOKEN_NAME_PART,
3034 WSI_TOKEN_SKIPPING_SAW_CR,
3035 WSI_PARSING_COMPLETE,
3036 WSI_INIT_TOKEN_MUXURL,
3039 struct lws_token_limits {
3040 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
3044 * lws_token_to_string() - returns a textual representation of a hdr token index
3046 * \param: token index
3048 LWS_VISIBLE LWS_EXTERN const unsigned char *
3049 lws_token_to_string(enum lws_token_indexes token);
3053 * lws_hdr_total_length: report length of all fragments of a header totalled up
3054 * The returned length does not include the space for a
3057 * \param wsi: websocket connection
3058 * \param h: which header index we are interested in
3060 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3061 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
3064 * lws_hdr_fragment_length: report length of a single fragment of a header
3065 * The returned length does not include the space for a
3068 * \param wsi: websocket connection
3069 * \param h: which header index we are interested in
3070 * \param frag_idx: which fragment of h we want to get the length of
3072 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3073 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
3076 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
3077 * The buffer length len must include space for an additional
3078 * terminating '\0', or it will fail returning -1.
3080 * \param wsi: websocket connection
3081 * \param dest: destination buffer
3082 * \param len: length of destination buffer
3083 * \param h: which header index we are interested in
3085 * copies the whole, aggregated header, even if it was delivered in
3086 * several actual headers piece by piece
3088 LWS_VISIBLE LWS_EXTERN int
3089 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
3092 * lws_hdr_copy_fragment() - 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.
3095 * If the requested fragment index is not present, it fails
3098 * \param wsi: websocket connection
3099 * \param dest: destination buffer
3100 * \param len: length of destination buffer
3101 * \param h: which header index we are interested in
3102 * \param frag_idx: which fragment of h we want to copy
3104 * Normally this is only useful
3105 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
3106 * fragment 0 will contain "x=1" and fragment 1 "y=2"
3108 LWS_VISIBLE LWS_EXTERN int
3109 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
3110 enum lws_token_indexes h, int frag_idx);
3113 * lws_get_urlarg_by_name() - return pointer to arg value if present
3114 * \param wsi: the connection to check
3115 * \param name: the arg name, like "token="
3116 * \param buf: the buffer to receive the urlarg (including the name= part)
3117 * \param len: the length of the buffer to receive the urlarg
3119 * Returns NULL if not found or a pointer inside buf to just after the
3122 LWS_VISIBLE LWS_EXTERN const char *
3123 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
3126 /*! \defgroup HTTP-headers-create HTTP headers: create
3128 * ## HTTP headers: Create
3130 * These apis allow you to create HTTP response headers in a way compatible with
3131 * both HTTP/1.x and HTTP/2.
3133 * They each append to a buffer taking care about the buffer end, which is
3134 * passed in as a pointer. When data is written to the buffer, the current
3135 * position p is updated accordingly.
3137 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3138 * and fail with nonzero return.
3142 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3143 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3146 * lws_add_http_header_status() - add the HTTP response status code
3148 * \param wsi: the connection to check
3149 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3150 * \param p: pointer to current position in buffer pointer
3151 * \param end: pointer to end of buffer
3153 * Adds the initial response code, so should be called first.
3155 * Code may additionally take OR'd flags:
3157 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3159 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3160 lws_add_http_header_status(struct lws *wsi,
3161 unsigned int code, unsigned char **p,
3162 unsigned char *end);
3164 * lws_add_http_header_by_name() - append named header and value
3166 * \param wsi: the connection to check
3167 * \param name: the hdr name, like "my-header"
3168 * \param value: the value after the = for this header
3169 * \param length: the length of the value
3170 * \param p: pointer to current position in buffer pointer
3171 * \param end: pointer to end of buffer
3173 * Appends name: value to the headers
3175 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3176 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3177 const unsigned char *value, int length,
3178 unsigned char **p, unsigned char *end);
3180 * lws_add_http_header_by_token() - append given header and value
3182 * \param wsi: the connection to check
3183 * \param token: the token index for the hdr
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, but is able to take advantage of better
3190 * HTTP/2 coding mechanisms where possible.
3192 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3193 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3194 const unsigned char *value, int length,
3195 unsigned char **p, unsigned char *end);
3197 * lws_add_http_header_content_length() - append content-length helper
3199 * \param wsi: the connection to check
3200 * \param content_length: the content length to use
3201 * \param p: pointer to current position in buffer pointer
3202 * \param end: pointer to end of buffer
3204 * Appends content-length: content_length to the headers
3206 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3207 lws_add_http_header_content_length(struct lws *wsi,
3208 lws_filepos_t content_length,
3209 unsigned char **p, unsigned char *end);
3211 * lws_finalize_http_header() - terminate header block
3213 * \param wsi: the connection to check
3214 * \param p: pointer to current position in buffer pointer
3215 * \param end: pointer to end of buffer
3217 * Indicates no more headers will be added
3219 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3220 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3221 unsigned char *end);
3224 /** \defgroup form-parsing Form Parsing
3226 * ##POSTed form parsing functions
3228 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3229 * POSTed form arguments, both using simple urlencoded and multipart transfer
3232 * It's capable of handling file uploads as well a named input parsing,
3233 * and the apis are the same for both form upload styles.
3235 * You feed it a list of parameter names and it creates pointers to the
3236 * urldecoded arguments: file upload parameters pass the file data in chunks to
3237 * a user-supplied callback as they come.
3239 * Since it's stateful, it handles the incoming data needing more than one
3240 * POST_BODY callback and has no limit on uploaded file size.
3244 /** enum lws_spa_fileupload_states */
3245 enum lws_spa_fileupload_states {
3247 /**< a chunk of file content has arrived */
3248 LWS_UFS_FINAL_CONTENT,
3249 /**< the last chunk (possibly zero length) of file content has arrived */
3251 /**< a new file is starting to arrive */
3255 * lws_spa_fileupload_cb() - callback to receive file upload data
3257 * \param data: opt_data pointer set in lws_spa_create
3258 * \param name: name of the form field being uploaded
3259 * \param filename: original filename from client
3260 * \param buf: start of data to receive
3261 * \param len: length of data to receive
3262 * \param state: information about how this call relates to file
3264 * Notice name and filename shouldn't be trusted, as they are passed from
3265 * HTTP provided by the client.
3267 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3268 const char *filename, char *buf, int len,
3269 enum lws_spa_fileupload_states state);
3271 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3272 * and file uploads */
3276 * lws_spa_create() - create urldecode parser
3278 * \param wsi: lws connection (used to find Content Type)
3279 * \param param_names: array of form parameter names, like "username"
3280 * \param count_params: count of param_names
3281 * \param max_storage: total amount of form parameter values we can store
3282 * \param opt_cb: NULL, or callback to receive file upload data.
3283 * \param opt_data: NULL, or user pointer provided to opt_cb.
3285 * Creates a urldecode parser and initializes it.
3287 * opt_cb can be NULL if you just want normal name=value parsing, however
3288 * if one or more entries in your form are bulk data (file transfer), you
3289 * can provide this callback and filter on the name callback parameter to
3290 * treat that urldecoded data separately. The callback should return -1
3291 * in case of fatal error, and 0 if OK.
3293 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3294 lws_spa_create(struct lws *wsi, const char * const *param_names,
3295 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3299 * lws_spa_process() - parses a chunk of input data
3301 * \param spa: the parser object previously created
3302 * \param in: incoming, urlencoded data
3303 * \param len: count of bytes valid at \param in
3305 LWS_VISIBLE LWS_EXTERN int
3306 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3309 * lws_spa_finalize() - indicate incoming data completed
3311 * \param spa: the parser object previously created
3313 LWS_VISIBLE LWS_EXTERN int
3314 lws_spa_finalize(struct lws_spa *spa);
3317 * lws_spa_get_length() - return length of parameter value
3319 * \param spa: the parser object previously created
3320 * \param n: parameter ordinal to return length of value for
3322 LWS_VISIBLE LWS_EXTERN int
3323 lws_spa_get_length(struct lws_spa *spa, int n);
3326 * lws_spa_get_string() - return pointer to parameter value
3327 * \param spa: the parser object previously created
3328 * \param n: parameter ordinal to return pointer to value for
3330 LWS_VISIBLE LWS_EXTERN const char *
3331 lws_spa_get_string(struct lws_spa *spa, int n);
3334 * lws_spa_destroy() - destroy parser object
3336 * \param spa: the parser object previously created
3338 LWS_VISIBLE LWS_EXTERN int
3339 lws_spa_destroy(struct lws_spa *spa);
3342 /*! \defgroup urlendec Urlencode and Urldecode
3345 * ##HTML chunked Substitution
3347 * APIs for receiving chunks of text, replacing a set of variable names via
3348 * a callback, and then prepending and appending HTML chunked encoding
3354 * lws_urlencode() - like strncpy but with urlencoding
3356 * \param escaped: output buffer
3357 * \param string: input buffer ('/0' terminated)
3358 * \param len: output buffer max length
3360 * Because urlencoding expands the output string, it's not
3361 * possible to do it in-place, ie, with escaped == string
3363 LWS_VISIBLE LWS_EXTERN const char *
3364 lws_urlencode(char *escaped, const char *string, int len);
3369 * This simple urldecode only operates until the first '\0' and requires the
3370 * data to exist all at once
3373 * lws_urldecode() - like strncpy but with urldecoding
3375 * \param string: output buffer
3376 * \param escaped: input buffer ('\0' terminated)
3377 * \param len: output buffer max length
3379 * This is only useful for '\0' terminated strings
3381 * Since urldecoding only shrinks the output string, it is possible to
3382 * do it in-place, ie, string == escaped
3384 LWS_VISIBLE LWS_EXTERN int
3385 lws_urldecode(char *string, const char *escaped, int len);
3388 * lws_return_http_status() - Return simple http status
3389 * \param wsi: Websocket instance (available from user callback)
3390 * \param code: Status index, eg, 404
3391 * \param html_body: User-readable HTML description < 1KB, or NULL
3393 * Helper to report HTTP errors back to the client cleanly and
3396 LWS_VISIBLE LWS_EXTERN int
3397 lws_return_http_status(struct lws *wsi, unsigned int code,
3398 const char *html_body);
3401 * lws_http_redirect() - write http redirect into buffer
3403 * \param wsi: websocket connection
3404 * \param code: HTTP response code (eg, 301)
3405 * \param loc: where to redirect to
3406 * \param len: length of loc
3407 * \param p: pointer current position in buffer (updated as we write)
3408 * \param end: pointer to end of buffer
3410 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3411 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3412 unsigned char **p, unsigned char *end);
3415 * lws_http_transaction_completed() - wait for new http transaction or close
3416 * \param wsi: websocket connection
3418 * Returns 1 if the HTTP connection must close now
3419 * Returns 0 and resets connection to wait for new HTTP header /
3420 * transaction if possible
3422 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3423 lws_http_transaction_completed(struct lws *wsi);
3426 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3428 * ##Sanitize / purify SQL and JSON helpers
3430 * APIs for escaping untrusted JSON and SQL safely before use
3435 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3437 * \param escaped: output buffer
3438 * \param string: input buffer ('/0' terminated)
3439 * \param len: output buffer max length
3441 * Because escaping expands the output string, it's not
3442 * possible to do it in-place, ie, with escaped == string
3444 LWS_VISIBLE LWS_EXTERN const char *
3445 lws_sql_purify(char *escaped, const char *string, int len);
3448 * lws_json_purify() - like strncpy but with escaping for json chars
3450 * \param escaped: output buffer
3451 * \param string: input buffer ('/0' terminated)
3452 * \param len: output buffer max length
3454 * Because escaping expands the output string, it's not
3455 * possible to do it in-place, ie, with escaped == string
3457 LWS_VISIBLE LWS_EXTERN const char *
3458 lws_json_purify(char *escaped, const char *string, int len);
3461 /*! \defgroup ev libev helpers
3465 * APIs specific to libev event loop itegration
3469 #ifdef LWS_USE_LIBEV
3470 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3472 LWS_VISIBLE LWS_EXTERN int
3473 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3474 lws_ev_signal_cb_t *cb);
3476 LWS_VISIBLE LWS_EXTERN int
3477 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3479 LWS_VISIBLE LWS_EXTERN void
3480 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3481 #endif /* LWS_USE_LIBEV */
3485 /*! \defgroup uv libuv helpers
3489 * APIs specific to libuv event loop itegration
3492 #ifdef LWS_USE_LIBUV
3493 LWS_VISIBLE LWS_EXTERN int
3494 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3497 LWS_VISIBLE LWS_EXTERN void
3498 lws_libuv_run(const struct lws_context *context, int tsi);
3500 LWS_VISIBLE LWS_EXTERN void
3501 lws_libuv_stop(struct lws_context *context);
3503 LWS_VISIBLE LWS_EXTERN void
3504 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3506 LWS_VISIBLE LWS_EXTERN int
3507 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3509 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3510 lws_uv_getloop(struct lws_context *context, int tsi);
3512 LWS_VISIBLE LWS_EXTERN void
3513 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3514 #endif /* LWS_USE_LIBUV */
3517 /*! \defgroup event libevent helpers
3519 * ##libevent helpers
3521 * APIs specific to libevent event loop itegration
3525 #ifdef LWS_USE_LIBEVENT
3526 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3529 LWS_VISIBLE LWS_EXTERN int
3530 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3531 lws_event_signal_cb_t cb);
3533 LWS_VISIBLE LWS_EXTERN int
3534 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3537 LWS_VISIBLE LWS_EXTERN void
3538 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3540 #endif /* LWS_USE_LIBEVENT */
3544 /*! \defgroup timeout Connection timeouts
3546 APIs related to setting connection timeouts
3551 * NOTE: These public enums are part of the abi. If you want to add one,
3552 * add it at where specified so existing users are unaffected.
3554 enum pending_timeout {
3555 NO_PENDING_TIMEOUT = 0,
3556 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3557 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3558 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3559 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3560 PENDING_TIMEOUT_AWAITING_PING = 5,
3561 PENDING_TIMEOUT_CLOSE_ACK = 6,
3562 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3563 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3564 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3565 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3566 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3567 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3568 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3569 PENDING_TIMEOUT_CGI = 14,
3570 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3571 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3572 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3573 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3574 PENDING_TIMEOUT_AWAITING_SOCKS_GREETING_REPLY = 19,
3575 PENDING_TIMEOUT_AWAITING_SOCKS_CONNECT_REPLY = 20,
3576 PENDING_TIMEOUT_AWAITING_SOCKS_AUTH_REPLY = 21,
3578 /****** add new things just above ---^ ******/
3582 * lws_set_timeout() - marks the wsi as subject to a timeout
3584 * You will not need this unless you are doing something special
3586 * \param wsi: Websocket connection instance
3587 * \param reason: timeout reason
3588 * \param secs: how many seconds
3590 LWS_VISIBLE LWS_EXTERN void
3591 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3594 /*! \defgroup sending-data Sending data
3596 APIs related to writing data on a connection
3599 #if !defined(LWS_SIZEOFPTR)
3600 #define LWS_SIZEOFPTR (sizeof (void *))
3602 #if !defined(u_int64_t)
3603 #define u_int64_t unsigned long long
3606 #if defined(__x86_64__)
3607 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3609 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3611 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3612 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3613 #define LWS_PRE _LWS_PAD(4 + 10)
3614 /* used prior to 1.7 and retained for backward compatibility */
3615 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3616 #define LWS_SEND_BUFFER_POST_PADDING 0
3619 * NOTE: These public enums are part of the abi. If you want to add one,
3620 * add it at where specified so existing users are unaffected.
3622 enum lws_write_protocol {
3624 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3625 * memory behind it. The receiver expects only valid utf-8 in the
3627 LWS_WRITE_BINARY = 1,
3628 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3629 * memory behind it. Any sequence of bytes is valid */
3630 LWS_WRITE_CONTINUATION = 2,
3631 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3632 * memory behind it */
3634 /**< Send HTTP content */
3636 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3640 /* Same as write_http but we know this write ends the transaction */
3641 LWS_WRITE_HTTP_FINAL = 7,
3645 LWS_WRITE_HTTP_HEADERS = 8,
3646 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3647 * payload differently, http 1.x links also handle this correctly. so
3648 * to be compatible with both in the future,header response part should
3649 * be sent using this regardless of http version expected)
3652 /****** add new things just above ---^ ******/
3656 LWS_WRITE_NO_FIN = 0x40,
3657 /**< This part of the message is not the end of the message */
3659 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3660 /**< client packet payload goes out on wire unmunged
3661 * only useful for security tests since normal servers cannot
3662 * decode the content if used */
3667 * lws_write() - Apply protocol then write data to client
3668 * \param wsi: Websocket instance (available from user callback)
3669 * \param buf: The data to send. For data being sent on a websocket
3670 * connection (ie, not default http), this buffer MUST have
3671 * LWS_PRE bytes valid BEFORE the pointer.
3672 * This is so the protocol header data can be added in-situ.
3673 * \param len: Count of the data bytes in the payload starting from buf
3674 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3675 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3676 * data on a websockets connection. Remember to allow the extra
3677 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3680 * This function provides the way to issue data back to the client
3681 * for both http and websocket protocols.
3685 * When sending with websocket protocol
3689 * LWS_WRITE_CONTINUATION,
3693 * the send buffer has to have LWS_PRE bytes valid BEFORE
3694 * the buffer pointer you pass to lws_write().
3696 * This allows us to add protocol info before and after the data, and send as
3697 * one packet on the network without payload copying, for maximum efficiency.
3699 * So for example you need this kind of code to use lws_write with a
3702 * char buf[LWS_PRE + 128];
3704 * // fill your part of the buffer... for example here it's all zeros
3705 * memset(&buf[LWS_PRE], 0, 128);
3707 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3709 * When sending HTTP, with
3712 * LWS_WRITE_HTTP_HEADERS
3713 * LWS_WRITE_HTTP_FINAL
3715 * there is no protocol data prepended, and don't need to take care about the
3716 * LWS_PRE bytes valid before the buffer pointer.
3718 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3719 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3720 * The example apps no longer use it.
3722 * Pad LWS_PRE to the CPU word size, so that word references
3723 * to the address immediately after the padding won't cause an unaligned access
3724 * error. Sometimes for performance reasons the recommended padding is even
3725 * larger than sizeof(void *).
3727 * In the case of sending using websocket protocol, be sure to allocate
3728 * valid storage before and after buf as explained above. This scheme
3729 * allows maximum efficiency of sending data and protocol in a single
3730 * packet while not burdening the user code with any protocol knowledge.
3732 * Return may be -1 for a fatal error needing connection close, or the
3733 * number of bytes sent.
3738 * The OS may not accept everything you asked to write on the connection.
3740 * Posix defines POLLOUT indication from poll() to show that the connection
3741 * will accept more write data, but it doesn't specifiy how much. It may just
3742 * accept one byte of whatever you wanted to send.
3744 * LWS will buffer the remainder automatically, and send it out autonomously.
3746 * During that time, WRITABLE callbacks will be suppressed.
3748 * This is to handle corner cases where unexpectedly the OS refuses what we
3749 * usually expect it to accept. You should try to send in chunks that are
3750 * almost always accepted in order to avoid the inefficiency of the buffering.
3752 LWS_VISIBLE LWS_EXTERN int
3753 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3754 enum lws_write_protocol protocol);
3756 /* helper for case where buffer may be const */
3757 #define lws_write_http(wsi, buf, len) \
3758 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3761 /** \defgroup callback-when-writeable Callback when writeable
3763 * ##Callback When Writeable
3765 * lws can only write data on a connection when it is able to accept more
3766 * data without blocking.
3768 * So a basic requirement is we should only use the lws_write() apis when the
3769 * connection we want to write on says that he can accept more data.
3771 * When lws cannot complete your send at the time, it will buffer the data
3772 * and send it in the background, suppressing any further WRITEABLE callbacks
3773 * on that connection until it completes. So it is important to write new
3774 * things in a new writeable callback.
3776 * These apis reflect the various ways we can indicate we would like to be
3777 * called back when one or more connections is writeable.
3782 * lws_callback_on_writable() - Request a callback when this socket
3783 * becomes able to be written to without
3786 * \param wsi: Websocket connection instance to get callback for
3788 * - Which: only this wsi
3789 * - When: when the individual connection becomes writeable
3790 * - What: LWS_CALLBACK_*_WRITEABLE
3792 LWS_VISIBLE LWS_EXTERN int
3793 lws_callback_on_writable(struct lws *wsi);
3796 * lws_callback_on_writable_all_protocol() - Request a callback for all
3797 * connections on same vhost using the given protocol when it
3798 * becomes possible to write to each socket without
3801 * \param context: lws_context
3802 * \param protocol: Protocol whose connections will get callbacks
3804 * - Which: connections using this protocol on ANY VHOST
3805 * - When: when the individual connection becomes writeable
3806 * - What: LWS_CALLBACK_*_WRITEABLE
3808 LWS_VISIBLE LWS_EXTERN int
3809 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3810 const struct lws_protocols *protocol);
3813 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3814 * all connections using the given protocol when it
3815 * becomes possible to write to each socket without
3818 * \param vhost: Only consider connections on this lws_vhost
3819 * \param protocol: Protocol whose connections will get callbacks
3821 * - Which: connections using this protocol on GIVEN VHOST ONLY
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_vhost(const struct lws_vhost *vhost,
3827 const struct lws_protocols *protocol);
3830 * lws_callback_all_protocol() - Callback all connections using
3831 * the given protocol with the given reason
3833 * \param context: lws_context
3834 * \param protocol: Protocol whose connections will get callbacks
3835 * \param reason: Callback reason index
3837 * - Which: connections using this protocol on ALL VHOSTS
3838 * - When: before returning
3841 * This isn't normally what you want... normally any update of connection-
3842 * specific information can wait until a network-related callback like rx,
3843 * writable, or close.
3845 LWS_VISIBLE LWS_EXTERN int
3846 lws_callback_all_protocol(struct lws_context *context,
3847 const struct lws_protocols *protocol, int reason);
3850 * lws_callback_all_protocol_vhost() - Callback all connections using
3851 * the given protocol with the given reason
3853 * \param vh: Vhost whose connections will get callbacks
3854 * \param protocol: Which protocol to match
3855 * \param reason: Callback reason index
3857 * - Which: connections using this protocol on GIVEN VHOST ONLY
3861 LWS_VISIBLE LWS_EXTERN int
3862 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3863 const struct lws_protocols *protocol, int reason);
3866 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3867 * with the given reason
3869 * \param wsi: wsi whose vhost will get callbacks
3870 * \param reason: Callback reason index
3871 * \param in: in argument to callback
3872 * \param len: len argument to callback
3874 * - Which: connections using this protocol on same VHOST as wsi ONLY
3878 LWS_VISIBLE LWS_EXTERN int
3879 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3881 LWS_VISIBLE LWS_EXTERN int
3882 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3883 void *user, void *in, size_t len);
3886 * lws_get_socket_fd() - returns the socket file descriptor
3888 * You will not need this unless you are doing something special
3890 * \param wsi: Websocket connection instance
3892 LWS_VISIBLE LWS_EXTERN int
3893 lws_get_socket_fd(struct lws *wsi);
3896 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
3899 * \param wsi: Websocket connection instance
3901 * if the protocol does not have any guidance, returns -1. Currently only
3902 * http2 connections get send window information from this API. But your code
3903 * should use it so it can work properly with any protocol.
3905 * If nonzero return is the amount of payload data the peer or intermediary has
3906 * reported it has buffer space for. That has NO relationship with the amount
3907 * of buffer space your OS can accept on this connection for a write action.
3909 * This number represents the maximum you could send to the peer or intermediary
3910 * on this connection right now without the protocol complaining.
3912 * lws manages accounting for send window updates and payload writes
3913 * automatically, so this number reflects the situation at the peer or
3914 * intermediary dynamically.
3916 LWS_VISIBLE LWS_EXTERN size_t
3917 lws_get_peer_write_allowance(struct lws *wsi);
3921 * lws_rx_flow_control() - Enable and disable socket servicing for
3924 * If the output side of a server process becomes choked, this allows flow
3925 * control for the input side.
3927 * \param wsi: Websocket connection instance to get callback for
3928 * \param enable: 0 = disable read servicing for this connection, 1 = enable
3930 LWS_VISIBLE LWS_EXTERN int
3931 lws_rx_flow_control(struct lws *wsi, int enable);
3934 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
3936 * When the user server code realizes it can accept more input, it can
3937 * call this to have the RX flow restriction removed from all connections using
3938 * the given protocol.
3939 * \param context: lws_context
3940 * \param protocol: all connections using this protocol will be allowed to receive
3942 LWS_VISIBLE LWS_EXTERN void
3943 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3944 const struct lws_protocols *protocol);
3947 * lws_remaining_packet_payload() - Bytes to come before "overall"
3948 * rx packet is complete
3949 * \param wsi: Websocket instance (available from user callback)
3951 * This function is intended to be called from the callback if the
3952 * user code is interested in "complete packets" from the client.
3953 * libwebsockets just passes through payload as it comes and issues a buffer
3954 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
3955 * callback handler can use this API to find out if the buffer it has just
3956 * been given is the last piece of a "complete packet" from the client --
3957 * when that is the case lws_remaining_packet_payload() will return
3960 * Many protocols won't care becuse their packets are always small.
3962 LWS_VISIBLE LWS_EXTERN size_t
3963 lws_remaining_packet_payload(struct lws *wsi);
3966 /** \defgroup sock-adopt Socket adoption helpers
3967 * ##Socket adoption helpers
3969 * When integrating with an external app with its own event loop, these can
3970 * be used to accept connections from someone else's listening socket.
3972 * When using lws own event loop, these are not needed.
3977 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
3978 * for the default vhost of context.
3979 * \param context: lws context
3980 * \param accept_fd: fd of already-accepted socket to adopt
3982 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3983 * returns NULL, having cleaned up any new wsi pieces.
3985 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3986 * to ws or just serve http.
3988 LWS_VISIBLE LWS_EXTERN struct lws *
3989 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3991 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
3993 * \param vhost: lws vhost
3994 * \param accept_fd: fd of already-accepted socket to adopt
3996 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3997 * returns NULL, having cleaned up any new wsi pieces.
3999 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4000 * to ws or just serve http.
4002 LWS_VISIBLE LWS_EXTERN struct lws *
4003 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
4006 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
4007 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
4008 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
4009 LWS_ADOPT_ALLOW_SSL = 4 /* flag: if set requires LWS_ADOPT_SOCKET */
4010 } lws_adoption_type;
4013 lws_sockfd_type sockfd;
4014 lws_filefd_type filefd;
4015 } lws_sock_file_fd_type;
4018 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
4019 * if socket descriptor, should already have been accepted from listen socket
4021 * \param vhost: lws vhost
4022 * \param type: OR-ed combinations of lws_adoption_type flags
4023 * \param fd: union with either .sockfd or .filefd set
4024 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
4025 * \param parent: NULL or struct lws to attach new_wsi to as a child
4027 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4028 * returns NULL, having cleaned up any new wsi pieces.
4030 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
4031 * ready to accept an upgrade to ws or just serve http.
4033 * parent may be NULL, if given it should be an existing wsi that will become the
4034 * parent of the new wsi created by this call.
4036 LWS_VISIBLE struct lws *
4037 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
4038 lws_sock_file_fd_type fd, const char *vh_prot_name,
4039 struct lws *parent);
4042 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
4043 * for the default vhost of context.
4044 * \param context: lws context
4045 * \param accept_fd: fd of already-accepted socket to adopt
4046 * \param readbuf: NULL or pointer to data that must be drained before reading from
4048 * \param len: The length of the data held at \param readbuf
4050 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4051 * returns NULL, having cleaned up any new wsi pieces.
4053 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4054 * to ws or just serve http.
4056 * If your external code did not already read from the socket, you can use
4057 * lws_adopt_socket() instead.
4059 * This api is guaranteed to use the data at \param readbuf first, before reading from
4062 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4064 LWS_VISIBLE LWS_EXTERN struct lws *
4065 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
4066 const char *readbuf, size_t len);
4068 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
4069 * accepted it for vhost.
4070 * \param vhost: lws vhost
4071 * \param accept_fd: fd of already-accepted socket to adopt
4072 * \param readbuf: NULL or pointer to data that must be drained before reading from
4074 * \param len: The length of the data held at \param readbuf
4076 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4077 * returns NULL, having cleaned up any new wsi pieces.
4079 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4080 * to ws or just serve http.
4082 * If your external code did not already read from the socket, you can use
4083 * lws_adopt_socket() instead.
4085 * This api is guaranteed to use the data at \param readbuf first, before reading from
4088 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4090 LWS_VISIBLE LWS_EXTERN struct lws *
4091 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
4092 const char *readbuf, size_t len);
4095 /** \defgroup net Network related helper APIs
4096 * ##Network related helper APIs
4098 * These wrap miscellaneous useful network-related functions
4103 * lws_canonical_hostname() - returns this host's hostname
4105 * This is typically used by client code to fill in the host parameter
4106 * when making a client connection. You can only call it after the context
4109 * \param context: Websocket context
4111 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4112 lws_canonical_hostname(struct lws_context *context);
4115 * lws_get_peer_addresses() - Get client address information
4116 * \param wsi: Local struct lws associated with
4117 * \param fd: Connection socket descriptor
4118 * \param name: Buffer to take client address name
4119 * \param name_len: Length of client address name buffer
4120 * \param rip: Buffer to take client address IP dotted quad
4121 * \param rip_len: Length of client address IP buffer
4123 * This function fills in name and rip with the name and IP of
4124 * the client connected with socket descriptor fd. Names may be
4125 * truncated if there is not enough room. If either cannot be
4126 * determined, they will be returned as valid zero-length strings.
4128 LWS_VISIBLE LWS_EXTERN void
4129 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
4130 int name_len, char *rip, int rip_len);
4133 * lws_get_peer_simple() - Get client address information without RDNS
4135 * \param wsi: Local struct lws associated with
4136 * \param name: Buffer to take client address name
4137 * \param namelen: Length of client address name buffer
4139 * This provides a 123.123.123.123 type IP address in name from the
4140 * peer that has connected to wsi
4142 LWS_VISIBLE LWS_EXTERN const char *
4143 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4144 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4146 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4148 * \param ipv6: Allow IPV6 addresses
4149 * \param ifname: Interface name or IP
4150 * \param addr: struct sockaddr_in * to be written
4151 * \param addrlen: Length of addr
4153 * This converts a textual network interface name to a sockaddr usable by
4154 * other network functions
4156 LWS_VISIBLE LWS_EXTERN int
4157 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4162 /** \defgroup misc Miscellaneous APIs
4163 * ##Miscellaneous APIs
4165 * Various APIs outside of other categories
4170 * lws_snprintf(): snprintf that truncates the returned length too
4172 * \param str: destination buffer
4173 * \param size: bytes left in destination buffer
4174 * \param format: format string
4175 * \param ...: args for format
4177 * This lets you correctly truncate buffers by concatenating lengths, if you
4178 * reach the limit the reported length doesn't exceed the limit.
4180 LWS_VISIBLE LWS_EXTERN int
4181 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4184 * lws_get_random(): fill a buffer with platform random data
4186 * \param context: the lws context
4187 * \param buf: buffer to fill
4188 * \param len: how much to fill
4190 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4191 * it's interested to see if the frame it's dealing with was sent in binary
4194 LWS_VISIBLE LWS_EXTERN int
4195 lws_get_random(struct lws_context *context, void *buf, int len);
4197 * lws_daemonize(): make current process run in the background
4199 * \param _lock_path: the filepath to write the lock file
4201 * Spawn lws as a background process, taking care of various things
4203 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4204 lws_daemonize(const char *_lock_path);
4206 * lws_get_library_version(): return string describing the version of lws
4208 * On unix, also includes the git describe
4210 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4211 lws_get_library_version(void);
4214 * lws_wsi_user() - get the user data associated with the connection
4215 * \param wsi: lws connection
4217 * Not normally needed since it's passed into the callback
4219 LWS_VISIBLE LWS_EXTERN void *
4220 lws_wsi_user(struct lws *wsi);
4223 * lws_wsi_set_user() - set the user data associated with the client connection
4224 * \param wsi: lws connection
4225 * \param user: user data
4227 * By default lws allocates this and it's not legal to externally set it
4228 * yourself. However client connections may have it set externally when the
4229 * connection is created... if so, this api can be used to modify it at
4230 * runtime additionally.
4232 LWS_VISIBLE LWS_EXTERN void
4233 lws_set_wsi_user(struct lws *wsi, void *user);
4236 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4237 * Notice it does so by dropping '\0' into input string
4238 * and the leading / on the path is consequently lost
4240 * \param p: incoming uri string.. will get written to
4241 * \param prot: result pointer for protocol part (https://)
4242 * \param ads: result pointer for address part
4243 * \param port: result pointer for port part
4244 * \param path: result pointer for path part
4246 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4247 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4251 * lws_now_secs(): return seconds since 1970-1-1
4253 LWS_VISIBLE LWS_EXTERN unsigned long
4257 * lws_get_context - Allow geting lws_context from a Websocket connection
4260 * With this function, users can access context in the callback function.
4261 * Otherwise users may have to declare context as a global variable.
4263 * \param wsi: Websocket connection instance
4265 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4266 lws_get_context(const struct lws *wsi);
4269 * lws_get_count_threads(): how many service threads the context uses
4271 * \param context: the lws context
4273 * By default this is always 1, if you asked for more than lws can handle it
4274 * will clip the number of threads. So you can use this to find out how many
4275 * threads are actually in use.
4277 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4278 lws_get_count_threads(struct lws_context *context);
4281 * lws_get_parent() - get parent wsi or NULL
4282 * \param wsi: lws connection
4284 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4285 * this allows you to get their parent.
4287 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4288 lws_get_parent(const struct lws *wsi);
4291 * lws_get_child() - get child wsi or NULL
4292 * \param wsi: lws connection
4294 * Allows you to find a related wsi from the parent wsi.
4296 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4297 lws_get_child(const struct lws *wsi);
4301 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4302 * It's provided in case it is
4303 * useful when integrating with other app poll loop service code.
4305 LWS_VISIBLE LWS_EXTERN int
4306 lws_read(struct lws *wsi, unsigned char *buf, lws_filepos_t len);
4309 * lws_set_allocator() - custom allocator support
4313 * Allows you to replace the allocator (and deallocator) used by lws
4315 LWS_VISIBLE LWS_EXTERN void
4316 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4319 /** \defgroup wsstatus Websocket status APIs
4320 * ##Websocket connection status APIs
4322 * These provide information about ws connection or message status
4326 * lws_send_pipe_choked() - tests if socket is writable or not
4327 * \param wsi: lws connection
4329 * Allows you to check if you can write more on the socket
4331 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4332 lws_send_pipe_choked(struct lws *wsi);
4335 * lws_is_final_fragment() - tests if last part of ws message
4336 * \param wsi: lws connection
4338 LWS_VISIBLE LWS_EXTERN int
4339 lws_is_final_fragment(struct lws *wsi);
4342 * lws_get_reserved_bits() - access reserved bits of ws frame
4343 * \param wsi: lws connection
4345 LWS_VISIBLE LWS_EXTERN unsigned char
4346 lws_get_reserved_bits(struct lws *wsi);
4349 * lws_partial_buffered() - find out if lws buffered the last write
4350 * \param wsi: websocket connection to check
4352 * Returns 1 if you cannot use lws_write because the last
4353 * write on this connection is still buffered, and can't be cleared without
4354 * returning to the service loop and waiting for the connection to be
4357 * If you will try to do >1 lws_write call inside a single
4358 * WRITEABLE callback, you must check this after every write and bail if
4359 * set, ask for a new writeable callback and continue writing from there.
4361 * This is never set at the start of a writeable callback, but any write
4364 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4365 lws_partial_buffered(struct lws *wsi);
4368 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4370 * \param wsi: the connection we are inquiring about
4372 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4373 * it's interested to see if the frame it's dealing with was sent in binary
4376 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4377 lws_frame_is_binary(struct lws *wsi);
4380 * lws_is_ssl() - Find out if connection is using SSL
4381 * \param wsi: websocket connection to check
4383 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4384 * using verified cert, and 2 if using SSL but the cert was not
4385 * checked (appears for client wsi told to skip check on connection)
4387 LWS_VISIBLE LWS_EXTERN int
4388 lws_is_ssl(struct lws *wsi);
4390 * lws_is_cgi() - find out if this wsi is running a cgi process
4391 * \param wsi: lws connection
4393 LWS_VISIBLE LWS_EXTERN int
4394 lws_is_cgi(struct lws *wsi);
4396 #ifdef LWS_OPENSSL_SUPPORT
4398 * lws_get_ssl() - Return wsi's SSL context structure
4399 * \param wsi: websocket connection
4401 * Returns pointer to the SSL library's context structure
4403 LWS_VISIBLE LWS_EXTERN SSL*
4404 lws_get_ssl(struct lws *wsi);
4409 /** \defgroup sha SHA and B64 helpers
4410 * ##SHA and B64 helpers
4412 * These provide SHA-1 and B64 helper apis
4415 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4416 #define lws_SHA1 SHA1
4419 * lws_SHA1(): make a SHA-1 digest of a buffer
4421 * \param d: incoming buffer
4422 * \param n: length of incoming buffer
4423 * \param md: buffer for message digest (must be >= 20 bytes)
4425 * Reduces any size buffer into a 20-byte SHA-1 hash.
4427 LWS_VISIBLE LWS_EXTERN unsigned char *
4428 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4431 * lws_b64_encode_string(): encode a string into base 64
4433 * \param in: incoming buffer
4434 * \param in_len: length of incoming buffer
4435 * \param out: result buffer
4436 * \param out_size: length of result buffer
4438 * Encodes a string using b64
4440 LWS_VISIBLE LWS_EXTERN int
4441 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4443 * lws_b64_decode_string(): decode a string from base 64
4445 * \param in: incoming buffer
4446 * \param out: result buffer
4447 * \param out_size: length of result buffer
4449 * Decodes a string using b64
4451 LWS_VISIBLE LWS_EXTERN int
4452 lws_b64_decode_string(const char *in, char *out, int out_size);
4456 /*! \defgroup cgi cgi handling
4460 * These functions allow low-level control over stdin/out/err of the cgi.
4462 * However for most cases, binding the cgi to http in and out, the default
4463 * lws implementation already does the right thing.
4466 enum lws_enum_stdinouterr {
4472 enum lws_cgi_hdr_state {
4484 struct lws_cgi_args {
4485 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4486 enum lws_enum_stdinouterr ch; /**< channel index */
4487 unsigned char *data; /**< for messages with payload */
4488 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4489 int len; /**< length */
4494 * lws_cgi: spawn network-connected cgi process
4496 * \param wsi: connection to own the process
4497 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4498 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4499 * \param timeout_secs: seconds script should be allowed to run
4500 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4502 LWS_VISIBLE LWS_EXTERN int
4503 lws_cgi(struct lws *wsi, const char * const *exec_array,
4504 int script_uri_path_len, int timeout_secs,
4505 const struct lws_protocol_vhost_options *mp_cgienv);
4508 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4510 * \param wsi: connection to own the process
4512 LWS_VISIBLE LWS_EXTERN int
4513 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4516 * lws_cgi_kill: terminate cgi process associated with wsi
4518 * \param wsi: connection to own the process
4520 LWS_VISIBLE LWS_EXTERN int
4521 lws_cgi_kill(struct lws *wsi);
4526 /*! \defgroup fops file operation wrapping
4528 * ##File operation wrapping
4530 * Use these helper functions if you want to access a file from the perspective
4531 * of a specific wsi, which is usually the case. If you just want contextless
4532 * file access, use the fops callbacks directly with NULL wsi instead of these
4535 * If so, then it calls the platform handler or user overrides where present
4536 * (as defined in info->fops)
4538 * The advantage from all this is user code can be portable for file operations
4539 * without having to deal with differences between platforms.
4543 /** struct lws_plat_file_ops - Platform-specific file operations
4545 * These provide platform-agnostic ways to deal with filesystem access in the
4546 * library and in the user code.
4549 #if defined(LWS_WITH_ESP32)
4550 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4551 #define LWS_FOP_OPEN _open
4552 #define LWS_FOP_CLOSE _close
4553 #define LWS_FOP_SEEK_CUR _seek_cur
4554 #define LWS_FOP_READ _read
4555 #define LWS_FOP_WRITE _write
4557 #define LWS_FOP_OPEN open
4558 #define LWS_FOP_CLOSE close
4559 #define LWS_FOP_SEEK_CUR seek_cur
4560 #define LWS_FOP_READ read
4561 #define LWS_FOP_WRITE write
4564 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4565 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4566 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4567 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4568 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4570 struct lws_plat_file_ops;
4574 /**< real file descriptor related to the file... */
4575 const struct lws_plat_file_ops *fops;
4576 /**< fops that apply to this fop_fd */
4577 void *filesystem_priv;
4578 /**< ignored by lws; owned by the fops handlers */
4580 /**< generic "position in file" */
4582 /**< generic "length of file" */
4583 lws_fop_flags_t flags;
4584 /**< copy of the returned flags */
4586 /**< optional "modification time of file", only valid if .open()
4587 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4589 typedef struct lws_fop_fd *lws_fop_fd_t;
4591 struct lws_fops_index {
4592 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4593 uint8_t len; /* length of above string */
4596 struct lws_plat_file_ops {
4597 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4598 const char *filename, const char *vpath,
4599 lws_fop_flags_t *flags);
4600 /**< Open file (always binary access if plat supports it)
4601 * vpath may be NULL, or if the fops understands it, the point at which
4602 * the filename's virtual part starts.
4603 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4604 * If the file may be gzip-compressed,
4605 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4606 * gzip-compressed, then the open handler should OR
4607 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4609 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4610 /**< close file AND set the pointer to NULL */
4611 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4612 lws_fileofs_t offset_from_cur_pos);
4613 /**< seek from current position */
4614 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4615 uint8_t *buf, lws_filepos_t len);
4616 /**< Read from file, on exit *amount is set to amount actually read */
4617 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4618 uint8_t *buf, lws_filepos_t len);
4619 /**< Write to file, on exit *amount is set to amount actually written */
4621 struct lws_fops_index fi[3];
4622 /**< vfs path signatures implying use of this fops */
4624 const struct lws_plat_file_ops *next;
4625 /**< NULL or next fops in list */
4627 /* Add new things just above here ---^
4628 * This is part of the ABI, don't needlessly break compatibility */
4632 * lws_get_fops() - get current file ops
4634 * \param context: context
4636 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4637 lws_get_fops(struct lws_context *context);
4638 LWS_VISIBLE LWS_EXTERN void
4639 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4641 * lws_vfs_tell() - get current file position
4643 * \param fop_fd: fop_fd we are asking about
4645 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4646 lws_vfs_tell(lws_fop_fd_t fop_fd);
4648 * lws_vfs_get_length() - get current file total length in bytes
4650 * \param fop_fd: fop_fd we are asking about
4652 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4653 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4655 * lws_vfs_get_mod_time() - get time file last modified
4657 * \param fop_fd: fop_fd we are asking about
4659 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4660 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4662 * lws_vfs_file_seek_set() - seek relative to start of file
4664 * \param fop_fd: fop_fd we are seeking in
4665 * \param offset: offset from start of file
4667 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4668 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4670 * lws_vfs_file_seek_end() - seek relative to end of file
4672 * \param fop_fd: fop_fd we are seeking in
4673 * \param offset: offset from start of file
4675 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4676 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4678 extern struct lws_plat_file_ops fops_zip;
4681 * lws_plat_file_open() - open vfs filepath
4683 * \param fops: file ops struct that applies to this descriptor
4684 * \param vfs_path: filename to open
4685 * \param flags: pointer to open flags
4687 * The vfs_path is scanned for known fops signatures, and the open directed
4688 * to any matching fops open.
4690 * User code should use this api to perform vfs opens.
4692 * returns semi-opaque handle
4694 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4695 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4696 lws_fop_flags_t *flags);
4699 * lws_plat_file_close() - close file
4701 * \param fop_fd: file handle to close
4703 static LWS_INLINE int
4704 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4706 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4710 * lws_plat_file_seek_cur() - close file
4713 * \param fop_fd: file handle
4714 * \param offset: position to seek to
4716 static LWS_INLINE lws_fileofs_t
4717 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4719 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4722 * lws_plat_file_read() - read from file
4724 * \param fop_fd: file handle
4725 * \param amount: how much to read (rewritten by call)
4726 * \param buf: buffer to write to
4727 * \param len: max length
4729 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4730 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4731 uint8_t *buf, lws_filepos_t len)
4733 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4736 * lws_plat_file_write() - write from file
4738 * \param fop_fd: file handle
4739 * \param amount: how much to write (rewritten by call)
4740 * \param buf: buffer to read from
4741 * \param len: max length
4743 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4744 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4745 uint8_t *buf, lws_filepos_t len)
4747 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4750 /* these are the platform file operations implementations... they can
4751 * be called directly and used in fops arrays
4754 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4755 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4756 const char *vpath, lws_fop_flags_t *flags);
4757 LWS_VISIBLE LWS_EXTERN int
4758 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4759 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4760 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4761 LWS_VISIBLE LWS_EXTERN int
4762 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4763 uint8_t *buf, lws_filepos_t len);
4764 LWS_VISIBLE LWS_EXTERN int
4765 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4766 uint8_t *buf, lws_filepos_t len);
4768 LWS_VISIBLE LWS_EXTERN int
4769 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4770 lws_filepos_t *amount);
4775 * ##SMTP related functions
4777 * These apis let you communicate with a local SMTP server to send email from
4778 * lws. It handles all the SMTP sequencing and protocol actions.
4780 * Your system should have postfix, sendmail or another MTA listening on port
4781 * 25 and able to send email using the "mail" commandline app. Usually distro
4782 * MTAs are configured for this by default.
4784 * It runs via its own libuv events if initialized (which requires giving it
4785 * a libuv loop to attach to).
4787 * It operates using three callbacks, on_next() queries if there is a new email
4788 * to send, on_get_body() asks for the body of the email, and on_sent() is
4789 * called after the email is successfully sent.
4793 * - create an lws_email struct
4795 * - initialize data, loop, the email_* strings, max_content_size and
4798 * - call lws_email_init()
4800 * When you have at least one email to send, call lws_email_check() to
4801 * schedule starting to send it.
4804 #ifdef LWS_WITH_SMTP
4806 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
4807 enum lwsgs_smtp_states {
4808 LGSSMTP_IDLE, /**< awaiting new email */
4809 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
4810 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
4811 LGSSMTP_SENT_HELO, /**< sent the HELO */
4812 LGSSMTP_SENT_FROM, /**< sent FROM */
4813 LGSSMTP_SENT_TO, /**< sent TO */
4814 LGSSMTP_SENT_DATA, /**< sent DATA request */
4815 LGSSMTP_SENT_BODY, /**< sent the email body */
4816 LGSSMTP_SENT_QUIT, /**< sent the session quit */
4819 /** struct lws_email - abstract context for performing SMTP operations */
4822 /**< opaque pointer set by user code and available to the callbacks */
4824 /**< the libuv loop we will work on */
4826 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
4827 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
4828 char email_from[100]; /**< Fill before init or on_next */
4829 char email_to[100]; /**< Fill before init or on_next */
4831 unsigned int max_content_size;
4832 /**< largest possible email body size */
4834 /* Fill all the callbacks before init */
4836 int (*on_next)(struct lws_email *email);
4837 /**< (Fill in before calling lws_email_init)
4838 * called when idle, 0 = another email to send, nonzero is idle.
4839 * If you return 0, all of the email_* char arrays must be set
4840 * to something useful. */
4841 int (*on_sent)(struct lws_email *email);
4842 /**< (Fill in before calling lws_email_init)
4843 * called when transfer of the email to the SMTP server was
4844 * successful, your callback would remove the current email
4846 int (*on_get_body)(struct lws_email *email, char *buf, int len);
4847 /**< (Fill in before calling lws_email_init)
4848 * called when the body part of the queued email is about to be
4849 * sent to the SMTP server. */
4852 /* private things */
4853 uv_timer_t timeout_email; /**< private */
4854 enum lwsgs_smtp_states estate; /**< private */
4855 uv_connect_t email_connect_req; /**< private */
4856 uv_tcp_t email_client; /**< private */
4857 time_t email_connect_started; /**< private */
4858 char email_buf[256]; /**< private */
4859 char *content; /**< private */
4863 * lws_email_init() - Initialize a struct lws_email
4865 * \param email: struct lws_email to init
4866 * \param loop: libuv loop to use
4867 * \param max_content: max email content size
4869 * Prepares a struct lws_email for use ending SMTP
4871 LWS_VISIBLE LWS_EXTERN int
4872 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4875 * lws_email_check() - Request check for new email
4877 * \param email: struct lws_email context to check
4879 * Schedules a check for new emails in 1s... call this when you have queued an
4882 LWS_VISIBLE LWS_EXTERN void
4883 lws_email_check(struct lws_email *email);
4885 * lws_email_destroy() - stop using the struct lws_email
4887 * \param email: the struct lws_email context
4889 * Stop sending email using email and free allocations
4891 LWS_VISIBLE LWS_EXTERN void
4892 lws_email_destroy(struct lws_email *email);
4898 * Stats are all uint64_t numbers that start at 0.
4899 * Index names here have the convention
4903 * _MS_ millisecond count
4907 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
4908 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
4909 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
4910 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
4911 LWSSTATS_C_API_WRITE, /**< count calls to write API */
4912 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
4913 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
4914 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
4915 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
4916 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
4917 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
4918 LWSSTATS_C_SSL_CONNS_HAD_RX, /**< count of accepted SSL conns that have had some RX */
4919 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
4920 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
4921 LWSSTATS_B_READ, /**< aggregate bytes read */
4922 LWSSTATS_B_WRITE, /**< aggregate bytes written */
4923 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
4924 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
4925 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
4926 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
4927 LWSSTATS_MS_SSL_RX_DELAY, /**< aggregate delay between ssl accept complete and first RX */
4929 /* Add new things just above here ---^
4930 * This is part of the ABI, don't needlessly break compatibility */
4934 #if defined(LWS_WITH_STATS)
4936 LWS_VISIBLE LWS_EXTERN uint64_t
4937 lws_stats_get(struct lws_context *context, int index);
4938 LWS_VISIBLE LWS_EXTERN void
4939 lws_stats_log_dump(struct lws_context *context);
4941 static LWS_INLINE uint64_t
4942 lws_stats_get(struct lws_context *context, int index) { return 0; }
4943 static LWS_INLINE void
4944 lws_stats_log_dump(struct lws_context *context) { }