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)
673 /** struct lws_pollargs - argument structure for all external poll related calls
674 * passed in via 'in' */
675 struct lws_pollargs {
676 lws_sockfd_type fd; /**< applicable socket descriptor */
677 int events; /**< the new event mask */
678 int prev_events; /**< the previous event mask */
682 struct lws_token_limits;
684 /*! \defgroup wsclose Websocket Close
686 * ##Websocket close frame control
688 * When we close a ws connection, we can send a reason code and a short
689 * UTF-8 description back with the close packet.
694 * NOTE: These public enums are part of the abi. If you want to add one,
695 * add it at where specified so existing users are unaffected.
697 /** enum lws_close_status - RFC6455 close status codes */
698 enum lws_close_status {
699 LWS_CLOSE_STATUS_NOSTATUS = 0,
700 LWS_CLOSE_STATUS_NORMAL = 1000,
701 /**< 1000 indicates a normal closure, meaning that the purpose for
702 which the connection was established has been fulfilled. */
703 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
704 /**< 1001 indicates that an endpoint is "going away", such as a server
705 going down or a browser having navigated away from a page. */
706 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
707 /**< 1002 indicates that an endpoint is terminating the connection due
708 to a protocol error. */
709 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
710 /**< 1003 indicates that an endpoint is terminating the connection
711 because it has received a type of data it cannot accept (e.g., an
712 endpoint that understands only text data MAY send this if it
713 receives a binary message). */
714 LWS_CLOSE_STATUS_RESERVED = 1004,
715 /**< Reserved. The specific meaning might be defined in the future. */
716 LWS_CLOSE_STATUS_NO_STATUS = 1005,
717 /**< 1005 is a reserved value and MUST NOT be set as a status code in a
718 Close control frame by an endpoint. It is designated for use in
719 applications expecting a status code to indicate that no status
720 code was actually present. */
721 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
722 /**< 1006 is a reserved value and MUST NOT be set as a status code in a
723 Close control frame by an endpoint. It is designated for use in
724 applications expecting a status code to indicate that the
725 connection was closed abnormally, e.g., without sending or
726 receiving a Close control frame. */
727 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
728 /**< 1007 indicates that an endpoint is terminating the connection
729 because it has received data within a message that was not
730 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
731 data within a text message). */
732 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
733 /**< 1008 indicates that an endpoint is terminating the connection
734 because it has received a message that violates its policy. This
735 is a generic status code that can be returned when there is no
736 other more suitable status code (e.g., 1003 or 1009) or if there
737 is a need to hide specific details about the policy. */
738 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
739 /**< 1009 indicates that an endpoint is terminating the connection
740 because it has received a message that is too big for it to
742 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
743 /**< 1010 indicates that an endpoint (client) is terminating the
744 connection because it has expected the server to negotiate one or
745 more extension, but the server didn't return them in the response
746 message of the WebSocket handshake. The list of extensions that
747 are needed SHOULD appear in the /reason/ part of the Close frame.
748 Note that this status code is not used by the server, because it
749 can fail the WebSocket handshake instead */
750 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
751 /**< 1011 indicates that a server is terminating the connection because
752 it encountered an unexpected condition that prevented it from
753 fulfilling the request. */
754 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
755 /**< 1015 is a reserved value and MUST NOT be set as a status code in a
756 Close control frame by an endpoint. It is designated for use in
757 applications expecting a status code to indicate that the
758 connection was closed due to a failure to perform a TLS handshake
759 (e.g., the server certificate can't be verified). */
761 /****** add new things just above ---^ ******/
763 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
767 * lws_close_reason - Set reason and aux data to send with Close packet
768 * If you are going to return nonzero from the callback
769 * requesting the connection to close, you can optionally
770 * call this to set the reason the peer will be told if
773 * \param wsi: The websocket connection to set the close reason on
774 * \param status: A valid close status from websocket standard
775 * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data
776 * \param len: Length of data in \param buf to send
778 LWS_VISIBLE LWS_EXTERN void
779 lws_close_reason(struct lws *wsi, enum lws_close_status status,
780 unsigned char *buf, size_t len);
786 /* needed even with extensions disabled for create context */
787 struct lws_extension;
789 /*! \defgroup usercb User Callback
791 * ##User protocol callback
793 * The protocol callback is the primary way lws interacts with
794 * user code. For one of a list of a few dozen reasons the callback gets
795 * called at some event to be handled.
797 * All of the events can be ignored, returning 0 is taken as "OK" and returning
798 * nonzero in most cases indicates that the connection should be closed.
804 * NOTE: These public enums are part of the abi. If you want to add one,
805 * add it at where specified so existing users are unaffected.
807 /** enum lws_callback_reasons - reason you're getting a protocol callback */
808 enum lws_callback_reasons {
809 LWS_CALLBACK_ESTABLISHED = 0,
810 /**< (VH) after the server completes a handshake with an incoming
811 * client. If you built the library with ssl support, in is a
812 * pointer to the ssl struct associated with the connection or NULL.*/
813 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
814 /**< the request client connection has been unable to complete a
815 * handshake with the remote server. If in is non-NULL, you can
816 * find an error string of length len where it points to
818 * Diagnostic strings that may be returned include
820 * "getaddrinfo (ipv6) failed"
821 * "unknown address family"
822 * "getaddrinfo (ipv4) failed"
823 * "set socket opts failed"
824 * "insert wsi failed"
825 * "lws_ssl_client_connect1 failed"
826 * "lws_ssl_client_connect2 failed"
830 * "HS: Redirect code but no Location"
831 * "HS: URI did not parse"
832 * "HS: Redirect failed"
833 * "HS: Server did not return 200"
835 * "HS: disallowed by client filter"
836 * "HS: disallowed at ESTABLISHED"
837 * "HS: ACCEPT missing"
838 * "HS: ws upgrade response not 101"
839 * "HS: UPGRADE missing"
840 * "HS: Upgrade to something other than websocket"
841 * "HS: CONNECTION missing"
842 * "HS: UPGRADE malformed"
843 * "HS: PROTOCOL malformed"
844 * "HS: Cannot match protocol"
845 * "HS: EXT: list too big"
846 * "HS: EXT: failed setting defaults"
847 * "HS: EXT: failed parsing defaults"
848 * "HS: EXT: failed parsing options"
849 * "HS: EXT: Rejects server options"
850 * "HS: EXT: unknown ext"
851 * "HS: Accept hash wrong"
852 * "HS: Rejected by filter cb"
854 * "HS: SO_SNDBUF failed"
855 * "HS: Rejected at CLIENT_ESTABLISHED"
857 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
858 /**< this is the last chance for the client user code to examine the
859 * http headers and decide to reject the connection. If the
860 * content in the headers is interesting to the
861 * client (url, etc) it needs to copy it out at
862 * this point since it will be destroyed before
863 * the CLIENT_ESTABLISHED call */
864 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
865 /**< after your client connection completed
866 * a handshake with the remote server */
867 LWS_CALLBACK_CLOSED = 4,
868 /**< when the websocket session ends */
869 LWS_CALLBACK_CLOSED_HTTP = 5,
870 /**< when a HTTP (non-websocket) session ends */
871 LWS_CALLBACK_RECEIVE = 6,
872 /**< data has appeared for this server endpoint from a
873 * remote client, it can be found at *in and is
875 LWS_CALLBACK_RECEIVE_PONG = 7,
876 /**< servers receive PONG packets with this callback reason */
877 LWS_CALLBACK_CLIENT_RECEIVE = 8,
878 /**< data has appeared from the server for the client connection, it
879 * can be found at *in and is len bytes long */
880 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
881 /**< clients receive PONG packets with this callback reason */
882 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
883 /**< If you call lws_callback_on_writable() on a connection, you will
884 * get one of these callbacks coming when the connection socket
885 * is able to accept another write packet without blocking.
886 * If it already was able to take another packet without blocking,
887 * you'll get this callback at the next call to the service loop
888 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
889 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
890 LWS_CALLBACK_SERVER_WRITEABLE = 11,
891 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
892 LWS_CALLBACK_HTTP = 12,
893 /**< an http request has come from a client that is not
894 * asking to upgrade the connection to a websocket
895 * one. This is a chance to serve http content,
896 * for example, to send a script to the client
897 * which will then open the websockets connection.
898 * in points to the URI path requested and
899 * lws_serve_http_file() makes it very
900 * simple to send back a file to the client.
901 * Normally after sending the file you are done
902 * with the http connection, since the rest of the
903 * activity will come by websockets from the script
904 * that was delivered by http, so you will want to
905 * return 1; to close and free up the connection. */
906 LWS_CALLBACK_HTTP_BODY = 13,
907 /**< the next len bytes data from the http
908 * request body HTTP connection is now available in in. */
909 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
910 /**< the expected amount of http request body has been delivered */
911 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
912 /**< a file requested to be sent down http link has completed. */
913 LWS_CALLBACK_HTTP_WRITEABLE = 16,
914 /**< you can write more down the http protocol link now. */
915 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
916 /**< called when a client connects to
917 * the server at network level; the connection is accepted but then
918 * passed to this callback to decide whether to hang up immediately
919 * or not, based on the client IP. in contains the connection
920 * socket's descriptor. Since the client connection information is
921 * not available yet, wsi still pointing to the main server socket.
922 * Return non-zero to terminate the connection before sending or
923 * receiving anything. Because this happens immediately after the
924 * network connection from the client, there's no websocket protocol
925 * selected yet so this callback is issued only to protocol 0. */
926 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
927 /**< called when the request has
928 * been received and parsed from the client, but the response is
929 * not sent yet. Return non-zero to disallow the connection.
930 * user is a pointer to the connection user space allocation,
931 * in is the URI, eg, "/"
932 * In your handler you can use the public APIs
933 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
934 * headers using the header enums lws_token_indexes from
935 * libwebsockets.h to check for and read the supported header
936 * presence and content before deciding to allow the http
937 * connection to proceed or to kill the connection. */
938 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
939 /**< A new client just had
940 * been connected, accepted, and instantiated into the pool. This
941 * callback allows setting any relevant property to it. Because this
942 * happens immediately after the instantiation of a new client,
943 * there's no websocket protocol selected yet so this callback is
944 * issued only to protocol 0. Only wsi is defined, pointing to the
945 * new client, and the return value is ignored. */
946 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
947 /**< called when the handshake has
948 * been received and parsed from the client, but the response is
949 * not sent yet. Return non-zero to disallow the connection.
950 * user is a pointer to the connection user space allocation,
951 * in is the requested protocol name
952 * In your handler you can use the public APIs
953 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
954 * headers using the header enums lws_token_indexes from
955 * libwebsockets.h to check for and read the supported header
956 * presence and content before deciding to allow the handshake
957 * to proceed or to kill the connection. */
958 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
959 /**< if configured for
960 * including OpenSSL support, this callback allows your user code
961 * to perform extra SSL_CTX_load_verify_locations() or similar
962 * calls to direct OpenSSL where to find certificates the client
963 * can use to confirm the remote server identity. user is the
964 * OpenSSL SSL_CTX* */
965 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
966 /**< if configured for
967 * including OpenSSL support, this callback allows your user code
968 * to load extra certifcates into the server which allow it to
969 * verify the validity of certificates returned by clients. user
970 * is the server's OpenSSL SSL_CTX* */
971 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
972 /**< if the libwebsockets vhost was created with the option
973 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
974 * callback is generated during OpenSSL verification of the cert
975 * sent from the client. It is sent to protocol[0] callback as
976 * no protocol has been negotiated on the connection yet.
977 * Notice that the libwebsockets context and wsi are both NULL
978 * during this callback. See
979 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
980 * to understand more detail about the OpenSSL callback that
981 * generates this libwebsockets callback and the meanings of the
982 * arguments passed. In this callback, user is the x509_ctx,
983 * in is the ssl pointer and len is preverify_ok
984 * Notice that this callback maintains libwebsocket return
985 * conventions, return 0 to mean the cert is OK or 1 to fail it.
986 * This also means that if you don't handle this callback then
987 * the default callback action of returning 0 allows the client
989 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
990 /**< this callback happens
991 * when a client handshake is being compiled. user is NULL,
992 * in is a char **, it's pointing to a char * which holds the
993 * next location in the header buffer where you can add
994 * headers, and len is the remaining space in the header buffer,
995 * which is typically some hundreds of bytes. So, to add a canned
996 * cookie, your handler code might look similar to:
998 * char **p = (char **)in;
1003 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1007 * Notice if you add anything, you just have to take care about
1008 * the CRLF on the line you added. Obviously this callback is
1009 * optional, if you don't handle it everything is fine.
1011 * Notice the callback is coming to protocols[0] all the time,
1012 * because there is no specific protocol negotiated yet. */
1013 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
1014 /**< When the server handshake code
1015 * sees that it does support a requested extension, before
1016 * accepting the extension by additing to the list sent back to
1017 * the client it gives this callback just to check that it's okay
1018 * to use that extension. It calls back to the requested protocol
1019 * and with in being the extension name, len is 0 and user is
1020 * valid. Note though at this time the ESTABLISHED callback hasn't
1021 * happened yet so if you initialize user content there, user
1022 * content during this callback might not be useful for anything. */
1023 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
1025 * connection is being prepared to start a handshake to a server,
1026 * each supported extension is checked with protocols[0] callback
1027 * with this reason, giving the user code a chance to suppress the
1028 * claim to support that extension by returning non-zero. If
1029 * unhandled, by default 0 will be returned and the extension
1030 * support included in the header to the server. Notice this
1031 * callback comes to protocols[0]. */
1032 LWS_CALLBACK_PROTOCOL_INIT = 27,
1033 /**< One-time call per protocol, per-vhost using it, so it can
1034 * do initial setup / allocations etc */
1035 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
1036 /**< One-time call per protocol, per-vhost using it, indicating
1037 * this protocol won't get used at all after this callback, the
1038 * vhost is getting destroyed. Take the opportunity to
1039 * deallocate everything that was allocated by the protocol. */
1040 LWS_CALLBACK_WSI_CREATE = 29,
1041 /**< outermost (earliest) wsi create notification to protocols[0] */
1042 LWS_CALLBACK_WSI_DESTROY = 30,
1043 /**< outermost (latest) wsi destroy notification to protocols[0] */
1044 LWS_CALLBACK_GET_THREAD_ID = 31,
1045 /**< lws can accept callback when writable requests from other
1046 * threads, if you implement this callback and return an opaque
1047 * current thread ID integer. */
1049 /* external poll() management support */
1050 LWS_CALLBACK_ADD_POLL_FD = 32,
1051 /**< lws normally deals with its poll() or other event loop
1052 * internally, but in the case you are integrating with another
1053 * server you will need to have lws sockets share a
1054 * polling array with the other server. This and the other
1055 * POLL_FD related callbacks let you put your specialized
1056 * poll array interface code in the callback for protocol 0, the
1057 * first protocol you support, usually the HTTP protocol in the
1059 * This callback happens when a socket needs to be
1060 * added to the polling loop: in points to a struct
1061 * lws_pollargs; the fd member of the struct is the file
1062 * descriptor, and events contains the active events
1064 * If you are using the internal lws polling / event loop
1065 * you can just ignore these callbacks. */
1066 LWS_CALLBACK_DEL_POLL_FD = 33,
1067 /**< This callback happens when a socket descriptor
1068 * needs to be removed from an external polling array. in is
1069 * again the struct lws_pollargs containing the fd member
1070 * to be removed. If you are using the internal polling
1071 * loop, you can just ignore it. */
1072 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1073 /**< This callback happens when lws wants to modify the events for
1075 * in is the struct lws_pollargs with the fd to change.
1076 * The new event mask is in events member and the old mask is in
1077 * the prev_events member.
1078 * If you are using the internal polling loop, you can just ignore
1080 LWS_CALLBACK_LOCK_POLL = 35,
1081 /**< These allow the external poll changes driven
1082 * by lws to participate in an external thread locking
1083 * scheme around the changes, so the whole thing is threadsafe.
1084 * These are called around three activities in the library,
1085 * - inserting a new wsi in the wsi / fd table (len=1)
1086 * - deleting a wsi from the wsi / fd table (len=1)
1087 * - changing a wsi's POLLIN/OUT state (len=0)
1088 * Locking and unlocking external synchronization objects when
1089 * len == 1 allows external threads to be synchronized against
1090 * wsi lifecycle changes if it acquires the same lock for the
1091 * duration of wsi dereference from the other thread context. */
1092 LWS_CALLBACK_UNLOCK_POLL = 36,
1093 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1095 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1096 /**< if configured for including OpenSSL support but no private key
1097 * file has been specified (ssl_private_key_filepath is NULL), this is
1098 * called to allow the user to set the private key directly via
1099 * libopenssl and perform further operations if required; this might be
1100 * useful in situations where the private key is not directly accessible
1101 * by the OS, for example if it is stored on a smartcard.
1102 * user is the server's OpenSSL SSL_CTX* */
1103 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1104 /**< The peer has sent an unsolicited Close WS packet. in and
1105 * len are the optional close code (first 2 bytes, network
1106 * order) and the optional additional information which is not
1107 * defined in the standard, and may be a string or non-human- readable data.
1108 * If you return 0 lws will echo the close and then close the
1109 * connection. If you return nonzero lws will just close the
1112 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1115 LWS_CALLBACK_CGI = 40,
1117 LWS_CALLBACK_CGI_TERMINATED = 41,
1119 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1121 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1123 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1125 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1127 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1129 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1131 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1133 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1135 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1137 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1139 LWS_CALLBACK_PROCESS_HTML = 52,
1141 LWS_CALLBACK_ADD_HEADERS = 53,
1143 LWS_CALLBACK_SESSION_INFO = 54,
1146 LWS_CALLBACK_GS_EVENT = 55,
1148 LWS_CALLBACK_HTTP_PMO = 56,
1149 /**< per-mount options for this connection, called before
1150 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1153 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1154 /**< when doing an HTTP type client connection, you can call
1155 * lws_client_http_body_pending(wsi, 1) from
1156 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1157 * sending the HTTP headers.
1159 * From this callback, when you have sent everything, you should let
1160 * lws know by calling lws_client_http_body_pending(wsi, 0)
1162 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1163 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1164 * this callback is called during OpenSSL verification of the cert
1165 * sent from the server to the client. It is sent to protocol[0]
1166 * callback as no protocol has been negotiated on the connection yet.
1167 * Notice that the wsi is set because lws_client_connect_via_info was
1170 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1171 * to understand more detail about the OpenSSL callback that
1172 * generates this libwebsockets callback and the meanings of the
1173 * arguments passed. In this callback, user is the x509_ctx,
1174 * in is the ssl pointer and len is preverify_ok.
1176 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1177 * overruled and cert shall be accepted as ok,
1178 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1179 * called and return value must be 0 to mean the cert is OK;
1180 * returning 1 will fail the cert in any case.
1182 * This also means that if you don't handle this callback then
1183 * the default callback action of returning 0 will not accept the
1184 * certificate in case of a validation error decided by the SSL lib.
1186 * This is expected and secure behaviour when validating certificates.
1188 * Note: LCCSCF_ALLOW_SELFSIGNED and
1189 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1190 * callback being implemented.
1192 LWS_CALLBACK_RAW_RX = 59,
1193 /**< RAW mode connection RX */
1194 LWS_CALLBACK_RAW_CLOSE = 60,
1195 /**< RAW mode connection is closing */
1196 LWS_CALLBACK_RAW_WRITEABLE = 61,
1197 /**< RAW mode connection may be written */
1198 LWS_CALLBACK_RAW_ADOPT = 62,
1199 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1200 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1201 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1202 LWS_CALLBACK_RAW_RX_FILE = 64,
1203 /**< RAW mode file has something to read */
1204 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1205 /**< RAW mode file is writeable */
1206 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1207 /**< RAW mode wsi that adopted a file is closing */
1209 /****** add new things just above ---^ ******/
1211 LWS_CALLBACK_USER = 1000,
1212 /**< user code can use any including above without fear of clashes */
1218 * typedef lws_callback_function() - User server actions
1219 * \param wsi: Opaque websocket instance pointer
1220 * \param reason: The reason for the call
1221 * \param user: Pointer to per-session user data allocated by library
1222 * \param in: Pointer used for some callback reasons
1223 * \param len: Length set for some callback reasons
1225 * This callback is the way the user controls what is served. All the
1226 * protocol detail is hidden and handled by the library.
1228 * For each connection / session there is user data allocated that is
1229 * pointed to by "user". You set the size of this user data area when
1230 * the library is initialized with lws_create_server.
1233 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1234 void *user, void *in, size_t len);
1237 /*! \defgroup extensions
1239 * ##Extension releated functions
1241 * Ws defines optional extensions, lws provides the ability to implement these
1242 * in user code if so desired.
1244 * We provide one extensions permessage-deflate.
1249 * NOTE: These public enums are part of the abi. If you want to add one,
1250 * add it at where specified so existing users are unaffected.
1252 enum lws_extension_callback_reasons {
1253 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1254 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1255 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1256 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1257 LWS_EXT_CB_CONSTRUCT = 4,
1258 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1259 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1260 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1261 LWS_EXT_CB_DESTROY = 8,
1262 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1263 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1264 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1265 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1266 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1267 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1268 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1269 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1270 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1271 LWS_EXT_CB_1HZ = 18,
1272 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1273 LWS_EXT_CB_IS_WRITEABLE = 20,
1274 LWS_EXT_CB_PAYLOAD_TX = 21,
1275 LWS_EXT_CB_PAYLOAD_RX = 22,
1276 LWS_EXT_CB_OPTION_DEFAULT = 23,
1277 LWS_EXT_CB_OPTION_SET = 24,
1278 LWS_EXT_CB_OPTION_CONFIRM = 25,
1279 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1281 /****** add new things just above ---^ ******/
1284 /** enum lws_ext_options_types */
1285 enum lws_ext_options_types {
1286 EXTARG_NONE, /**< does not take an argument */
1287 EXTARG_DEC, /**< requires a decimal argument */
1288 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1290 /* Add new things just above here ---^
1291 * This is part of the ABI, don't needlessly break compatibility */
1294 /** struct lws_ext_options - Option arguments to the extension. These are
1295 * used in the negotiation at ws upgrade time.
1296 * The helper function lws_ext_parse_options()
1297 * uses these to generate callbacks */
1298 struct lws_ext_options {
1299 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1300 enum lws_ext_options_types type; /**< What kind of args the option can take */
1302 /* Add new things just above here ---^
1303 * This is part of the ABI, don't needlessly break compatibility */
1306 /** struct lws_ext_option_arg */
1307 struct lws_ext_option_arg {
1308 const char *option_name; /**< may be NULL, option_index used then */
1309 int option_index; /**< argument ordinal to use if option_name missing */
1310 const char *start; /**< value */
1311 int len; /**< length of value */
1315 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1316 * \param context: Websockets context
1317 * \param ext: This extension
1318 * \param wsi: Opaque websocket instance pointer
1319 * \param reason: The reason for the call
1320 * \param user: Pointer to ptr to per-session user data allocated by library
1321 * \param in: Pointer used for some callback reasons
1322 * \param len: Length set for some callback reasons
1324 * Each extension that is active on a particular connection receives
1325 * callbacks during the connection lifetime to allow the extension to
1326 * operate on websocket data and manage itself.
1328 * Libwebsockets takes care of allocating and freeing "user" memory for
1329 * each active extension on each connection. That is what is pointed to
1330 * by the user parameter.
1332 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1333 * select this extension from the list provided by the client,
1334 * just before the server will send back the handshake accepting
1335 * the connection with this extension active. This gives the
1336 * extension a chance to initialize its connection context found
1339 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1340 * but called when client is instantiating this extension. Some
1341 * extensions will work the same on client and server side and then
1342 * you can just merge handlers for both CONSTRUCTS.
1344 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1345 * being used on is about to be closed and deallocated. It's the
1346 * last chance for the extension to deallocate anything it has
1347 * allocated in the user data (pointed to by user) before the
1348 * user data is deleted. This same callback is used whether you
1349 * are in client or server instantiation context.
1351 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1352 * a connection, and a packet of data arrived at the connection,
1353 * it is passed to this callback to give the extension a chance to
1354 * change the data, eg, decompress it. user is pointing to the
1355 * extension's private connection context data, in is pointing
1356 * to an lws_tokens struct, it consists of a char * pointer called
1357 * token, and an int called token_len. At entry, these are
1358 * set to point to the received buffer and set to the content
1359 * length. If the extension will grow the content, it should use
1360 * a new buffer allocated in its private user context data and
1361 * set the pointed-to lws_tokens members to point to its buffer.
1363 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1364 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1365 * extension a chance to change websocket data just before it will
1366 * be sent out. Using the same lws_token pointer scheme in in,
1367 * the extension can change the buffer and the length to be
1368 * transmitted how it likes. Again if it wants to grow the
1369 * buffer safely, it should copy the data into its own buffer and
1370 * set the lws_tokens token pointer to it.
1372 * LWS_EXT_CB_ARGS_VALIDATE:
1375 lws_extension_callback_function(struct lws_context *context,
1376 const struct lws_extension *ext, struct lws *wsi,
1377 enum lws_extension_callback_reasons reason,
1378 void *user, void *in, size_t len);
1380 /** struct lws_extension - An extension we support */
1381 struct lws_extension {
1382 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1383 lws_extension_callback_function *callback; /**< Service callback */
1384 const char *client_offer; /**< String containing exts and options client offers */
1386 /* Add new things just above here ---^
1387 * This is part of the ABI, don't needlessly break compatibility */
1391 * lws_set_extension_option(): set extension option if possible
1393 * \param wsi: websocket connection
1394 * \param ext_name: name of ext, like "permessage-deflate"
1395 * \param opt_name: name of option, like "rx_buf_size"
1396 * \param opt_val: value to set option to
1398 LWS_VISIBLE LWS_EXTERN int
1399 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1400 const char *opt_name, const char *opt_val);
1402 #ifndef LWS_NO_EXTENSIONS
1403 /* lws_get_internal_extensions() - DEPRECATED
1405 * \Deprecated There is no longer a set internal extensions table. The table is provided
1406 * by user code along with application-specific settings. See the test
1407 * client and server for how to do.
1409 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1410 lws_get_internal_extensions(void) { return NULL; }
1413 * lws_ext_parse_options() - deal with parsing negotiated extension options
1415 * \param ext: related extension struct
1416 * \param wsi: websocket connection
1417 * \param ext_user: per-connection extension private data
1418 * \param opts: list of supported options
1419 * \param o: option string to parse
1420 * \param len: length
1422 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1423 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1424 void *ext_user, const struct lws_ext_options *opts,
1425 const char *o, int len);
1428 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1430 * \param context: lws context
1431 * \param ext: related lws_extension struct
1432 * \param wsi: websocket connection
1433 * \param reason: incoming callback reason
1434 * \param user: per-connection extension private data
1435 * \param in: pointer parameter
1436 * \param len: length parameter
1438 * Built-in callback implementing RFC7692 permessage-deflate
1441 int lws_extension_callback_pm_deflate(
1442 struct lws_context *context, const struct lws_extension *ext,
1443 struct lws *wsi, enum lws_extension_callback_reasons reason,
1444 void *user, void *in, size_t len);
1447 * The internal exts are part of the public abi
1448 * If we add more extensions, publish the callback here ------v
1452 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1455 * ##Protocol and protocol plugin -related apis
1457 * Protocols bind ws protocol names to a custom callback specific to that
1458 * protocol implementaion.
1460 * A list of protocols can be passed in at context creation time, but it is
1461 * also legal to leave that NULL and add the protocols and their callback code
1464 * Plugins are much preferable compared to cut and pasting code into an
1465 * application each time, since they can be used standalone.
1468 /** struct lws_protocols - List of protocols and handlers client or server
1471 struct lws_protocols {
1473 /**< Protocol name that must match the one given in the client
1474 * Javascript new WebSocket(url, 'protocol') name. */
1475 lws_callback_function *callback;
1476 /**< The service callback used for this protocol. It allows the
1477 * service action for an entire protocol to be encapsulated in
1478 * the protocol-specific callback */
1479 size_t per_session_data_size;
1480 /**< Each new connection using this protocol gets
1481 * this much memory allocated on connection establishment and
1482 * freed on connection takedown. A pointer to this per-connection
1483 * allocation is passed into the callback in the 'user' parameter */
1484 size_t rx_buffer_size;
1485 /**< lws allocates this much space for rx data and informs callback
1486 * when something came. Due to rx flow control, the callback may not
1487 * be able to consume it all without having to return to the event
1488 * loop. That is supported in lws.
1490 * If .tx_packet_size is 0, this also controls how much may be sent at once
1491 * for backwards compatibility.
1494 /**< ignored by lws, but useful to contain user information bound
1495 * to the selected protocol. For example if this protocol was
1496 * called "myprotocol-v2", you might set id to 2, and the user
1497 * code that acts differently according to the version can do so by
1498 * switch (wsi->protocol->id), user code might use some bits as
1499 * capability flags based on selected protocol version, etc. */
1500 void *user; /**< ignored by lws, but user code can pass a pointer
1501 here it can later access from the protocol callback */
1502 size_t tx_packet_size;
1503 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1505 * If greater than zero, a single send() is restricted to this amount
1506 * and any remainder is buffered by lws and sent afterwards also in
1507 * these size chunks. Since that is expensive, it's preferable
1508 * to restrict one fragment you are trying to send to match this
1512 /* Add new things just above here ---^
1513 * This is part of the ABI, don't needlessly break compatibility */
1519 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1521 * \param vh: vhost to search
1522 * \param name: protocol name
1524 * Returns NULL or a pointer to the vhost's protocol of the requested name
1526 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1527 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1530 * lws_get_protocol() - Returns a protocol pointer from a websocket
1532 * \param wsi: pointer to struct websocket you want to know the protocol of
1535 * Some apis can act on all live connections of a given protocol,
1536 * this is how you can get a pointer to the active protocol if needed.
1538 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1539 lws_get_protocol(struct lws *wsi);
1541 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1542 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1543 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1546 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1548 * \param vhost: vhost the instance is related to
1549 * \param prot: protocol the instance is related to
1550 * \param size: bytes to allocate
1552 * Protocols often find it useful to allocate a per-vhost struct, this is a
1553 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1555 LWS_VISIBLE LWS_EXTERN void *
1556 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1560 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1562 * \param vhost: vhost the instance is related to
1563 * \param prot: protocol the instance is related to
1565 * Recover a pointer to the allocated per-vhost storage for the protocol created
1566 * by lws_protocol_vh_priv_zalloc() earlier
1568 LWS_VISIBLE LWS_EXTERN void *
1569 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1572 * lws_finalize_startup() - drop initial process privileges
1574 * \param context: lws context
1576 * This is called after the end of the vhost protocol initializations, but
1577 * you may choose to call it earlier
1579 LWS_VISIBLE LWS_EXTERN int
1580 lws_finalize_startup(struct lws_context *context);
1582 LWS_VISIBLE LWS_EXTERN int
1583 lws_protocol_init(struct lws_context *context);
1585 #ifdef LWS_WITH_PLUGINS
1587 /* PLUGINS implies LIBUV */
1589 #define LWS_PLUGIN_API_MAGIC 180
1591 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1592 struct lws_plugin_capability {
1593 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1594 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1595 int count_protocols; /**< how many protocols */
1596 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1597 int count_extensions; /**< how many extensions */
1600 typedef int (*lws_plugin_init_func)(struct lws_context *,
1601 struct lws_plugin_capability *);
1602 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1604 /** struct lws_plugin */
1606 struct lws_plugin *list; /**< linked list */
1607 #if (UV_VERSION_MAJOR > 0)
1608 uv_lib_t lib; /**< shared library pointer */
1610 void *l; /**< so we can compile on ancient libuv */
1612 char name[64]; /**< name of the plugin */
1613 struct lws_plugin_capability caps; /**< plugin capabilities */
1621 /*! \defgroup generic-sessions plugin: generic-sessions
1622 * \ingroup Protocols-and-Plugins
1624 * ##Plugin Generic-sessions related
1626 * generic-sessions plugin provides a reusable, generic session and login /
1627 * register / forgot password framework including email verification.
1631 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1632 /**< Maximum size of email we might send */
1634 /* SHA-1 binary and hexified versions */
1635 /** typedef struct lwsgw_hash_bin */
1636 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1637 /** typedef struct lwsgw_hash */
1638 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1640 /** enum lwsgs_auth_bits */
1641 enum lwsgs_auth_bits {
1642 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1643 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1644 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1645 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1648 /** struct lws_session_info - information about user session status */
1649 struct lws_session_info {
1650 char username[32]; /**< username logged in as, or empty string */
1651 char email[100]; /**< email address associated with login, or empty string */
1652 char ip[72]; /**< ip address session was started from */
1653 unsigned int mask; /**< access rights mask associated with session
1654 * see enum lwsgs_auth_bits */
1655 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1658 /** enum lws_gs_event */
1660 LWSGSE_CREATED, /**< a new user was created */
1661 LWSGSE_DELETED /**< an existing user was deleted */
1664 /** struct lws_gs_event_args */
1665 struct lws_gs_event_args {
1666 enum lws_gs_event event; /**< which event happened */
1667 const char *username; /**< which username the event happened to */
1668 const char *email; /**< the email address of that user */
1674 /*! \defgroup context-and-vhost
1677 * ##Context and Vhost releated functions
1679 * LWS requires that there is one context, in which you may define multiple
1680 * vhosts. Each vhost is a virtual host, with either its own listen port
1681 * or sharing an existing one. Each vhost has its own SSL context that can
1682 * be set up individually or left disabled.
1684 * If you don't care about multiple "site" support, you can ignore it and
1685 * lws will create a single default vhost at context creation time.
1690 * NOTE: These public enums are part of the abi. If you want to add one,
1691 * add it at where specified so existing users are unaffected.
1694 /** enum lws_context_options - context and vhost options */
1695 enum lws_context_options {
1696 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1698 /**< (VH) Don't allow the connection unless the client has a
1699 * client cert that we recognize; provides
1700 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1701 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1702 /**< (CTX) Don't try to get the server's hostname */
1703 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1705 /**< (VH) Allow non-SSL (plaintext) connections on the same
1706 * port as SSL is listening... undermines the security of SSL;
1707 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1708 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1709 /**< (CTX) Use libev event loop */
1710 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1711 /**< (VH) Disable IPV6 support */
1712 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1713 /**< (VH) Don't load OS CA certs, you will need to load your
1715 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1716 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1717 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1718 /**< (VH) Check UT-8 correctness */
1719 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1721 /**< (VH) initialize ECDH ciphers */
1722 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1723 /**< (CTX) Use libuv event loop */
1724 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1726 /**< (VH) Use http redirect to force http to https
1727 * (deprecated: use mount redirection) */
1728 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1729 /**< (CTX) Initialize the SSL library at all */
1730 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1731 /**< (CTX) Only create the context when calling context
1732 * create api, implies user code will create its own vhosts */
1733 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1734 /**< (VH) Use Unix socket */
1735 LWS_SERVER_OPTION_STS = (1 << 15),
1736 /**< (VH) Send Strict Transport Security header, making
1737 * clients subsequently go to https even if user asked for http */
1738 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1739 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1740 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1741 /**< (VH) if set, only ipv6 allowed on the vhost */
1742 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1743 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1744 * normally makes the lib spin so you can attach a debugger to it
1745 * even if it happened without a debugger in place. You can disable
1746 * that by giving this option.
1748 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1749 /**< For backwards-compatibility reasons, by default
1750 * lws prepends "http://" to the origin you give in the client
1751 * connection info struct. If you give this flag when you create
1752 * the context, only the string you give in the client connect
1753 * info for .origin (if any) will be used directly.
1755 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1756 /**< (VH) if invalid http is coming in the first line, */
1757 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1758 /**< (CTX) Use libevent event loop */
1759 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1760 /**< (VH) All connections to this vhost / port are RAW as soon as
1761 * the connection is accepted, no HTTP is going to be coming.
1764 /****** add new things just above ---^ ******/
1767 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1769 struct lws_plat_file_ops;
1771 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1773 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1774 * is not given, then for backwards compatibility one vhost is created at
1775 * context-creation time using the info from this struct.
1777 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1778 * at the same time as the context, they are expected to be created afterwards.
1780 struct lws_context_creation_info {
1782 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1783 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1784 * writing a server but you are using \ref sock-adopt instead of the
1785 * built-in listener */
1787 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1788 * interface name, eg, "eth2"
1789 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1790 * the pathname of a UNIX domain socket. you can use the UNIX domain
1791 * sockets in abstract namespace, by prepending an at symbol to the
1793 const struct lws_protocols *protocols;
1794 /**< VHOST: Array of structures listing supported protocols and a protocol-
1795 * specific callback for each one. The list is ended with an
1796 * entry that has a NULL callback pointer. */
1797 const struct lws_extension *extensions;
1798 /**< VHOST: NULL or array of lws_extension structs listing the
1799 * extensions this context supports. */
1800 const struct lws_token_limits *token_limits;
1801 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1802 * with a token length limit for each possible WSI_TOKEN_ */
1803 const char *ssl_private_key_password;
1804 /**< VHOST: NULL or the passphrase needed for the private key */
1805 const char *ssl_cert_filepath;
1806 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1807 * to listen using SSL, set to the filepath to fetch the
1808 * server cert from, otherwise NULL for unencrypted */
1809 const char *ssl_private_key_filepath;
1810 /**< VHOST: filepath to private key if wanting SSL mode;
1811 * if this is set to NULL but sll_cert_filepath is set, the
1812 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1813 * to allow setting of the private key directly via openSSL
1815 const char *ssl_ca_filepath;
1816 /**< VHOST: CA certificate filepath or NULL */
1817 const char *ssl_cipher_list;
1818 /**< VHOST: List of valid ciphers to use (eg,
1819 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1820 * or you can leave it as NULL to get "DEFAULT" */
1821 const char *http_proxy_address;
1822 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1823 * If proxy auth is required, use format "username:password\@server:port" */
1824 unsigned int http_proxy_port;
1825 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1827 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1829 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1830 unsigned int options;
1831 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1833 /**< CONTEXT: optional user pointer that can be recovered via the context
1834 * pointer using lws_context_user */
1836 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1837 * timeout to all libwebsocket sockets, client or server */
1839 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1840 * times to try to get a response from the peer before giving up
1841 * and killing the connection */
1843 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1845 #ifdef LWS_OPENSSL_SUPPORT
1846 SSL_CTX *provided_client_ssl_ctx;
1847 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1848 * implementation for the one provided by provided_ssl_ctx.
1849 * Libwebsockets no longer is responsible for freeing the context
1850 * if this option is selected. */
1851 #else /* maintain structure layout either way */
1852 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1855 short max_http_header_data;
1856 /**< CONTEXT: The max amount of header payload that can be handled
1857 * in an http request (unrecognized header payload is dropped) */
1858 short max_http_header_pool;
1859 /**< CONTEXT: The max number of connections with http headers that
1860 * can be processed simultaneously (the corresponding memory is
1861 * allocated for the lifetime of the context). If the pool is
1862 * busy new incoming connections must wait for accept until one
1865 unsigned int count_threads;
1866 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1867 unsigned int fd_limit_per_thread;
1868 /**< CONTEXT: nonzero means restrict each service thread to this
1869 * many fds, 0 means the default which is divide the process fd
1870 * limit by the number of threads. */
1871 unsigned int timeout_secs;
1872 /**< VHOST: various processes involving network roundtrips in the
1873 * library are protected from hanging forever by timeouts. If
1874 * nonzero, this member lets you set the timeout used in seconds.
1875 * Otherwise a default timeout is used. */
1876 const char *ecdh_curve;
1877 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1878 const char *vhost_name;
1879 /**< VHOST: name of vhost, must match external DNS name used to
1880 * access the site, like "warmcat.com" as it's used to match
1881 * Host: header and / or SNI name for SSL. */
1882 const char * const *plugin_dirs;
1883 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1884 * scan for lws protocol plugins at context creation time */
1885 const struct lws_protocol_vhost_options *pvo;
1886 /**< VHOST: pointer to optional linked list of per-vhost
1887 * options made accessible to protocols */
1888 int keepalive_timeout;
1889 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1890 * client to hold on to an idle HTTP/1.1 connection */
1891 const char *log_filepath;
1892 /**< VHOST: filepath to append logs to... this is opened before
1893 * any dropping of initial privileges */
1894 const struct lws_http_mount *mounts;
1895 /**< VHOST: optional linked list of mounts for this vhost */
1896 const char *server_string;
1897 /**< CONTEXT: string used in HTTP headers to identify server
1898 * software, if NULL, "libwebsockets". */
1899 unsigned int pt_serv_buf_size;
1900 /**< CONTEXT: 0 = default of 4096. This buffer is used by
1901 * various service related features including file serving, it
1902 * defines the max chunk of file that can be sent at once.
1903 * At the risk of lws having to buffer failed large sends, it
1904 * can be increased to, eg, 128KiB to improve throughput. */
1905 unsigned int max_http_header_data2;
1906 /**< CONTEXT: if max_http_header_data is 0 and this
1907 * is nonzero, this will be used in place of the default. It's
1908 * like this for compatibility with the original short version,
1909 * this is unsigned int length. */
1910 long ssl_options_set;
1911 /**< VHOST: Any bits set here will be set as SSL options */
1912 long ssl_options_clear;
1913 /**< VHOST: Any bits set here will be cleared as SSL options */
1914 unsigned short ws_ping_pong_interval;
1915 /**< CONTEXT: 0 for none, else interval in seconds between sending
1916 * PINGs on idle websocket connections. When the PING is sent,
1917 * the PONG must come within the normal timeout_secs timeout period
1918 * or the connection will be dropped.
1919 * Any RX or TX traffic on the connection restarts the interval timer,
1920 * so a connection which always sends or receives something at intervals
1921 * less than the interval given here will never send PINGs / expect
1922 * PONGs. Conversely as soon as the ws connection is established, an
1923 * idle connection will do the PING / PONG roundtrip as soon as
1924 * ws_ping_pong_interval seconds has passed without traffic
1926 const struct lws_protocol_vhost_options *headers;
1927 /**< VHOST: pointer to optional linked list of per-vhost
1928 * canned headers that are added to server responses */
1930 const struct lws_protocol_vhost_options *reject_service_keywords;
1931 /**< CONTEXT: Optional list of keywords and rejection codes + text.
1933 * The keywords are checked for existing in the user agent string.
1935 * Eg, "badrobot" "404 Not Found"
1937 void *external_baggage_free_on_destroy;
1938 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
1939 * should be freed when the context is destroyed. This allows you to
1940 * automatically sync the freeing action to the context destruction
1941 * action, so there is no need for an external free() if the context
1942 * succeeded to create.
1945 #ifdef LWS_OPENSSL_SUPPORT
1946 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1947 * with a token length limit for each possible WSI_TOKEN_ */
1948 const char *client_ssl_private_key_password;
1949 /**< VHOST: NULL or the passphrase needed for the private key */
1950 const char *client_ssl_cert_filepath;
1951 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1952 * to listen using SSL, set to the filepath to fetch the
1953 * server cert from, otherwise NULL for unencrypted */
1954 const char *client_ssl_private_key_filepath;
1955 /**< VHOST: filepath to private key if wanting SSL mode;
1956 * if this is set to NULL but sll_cert_filepath is set, the
1957 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1958 * to allow setting of the private key directly via openSSL
1960 const char *client_ssl_ca_filepath;
1961 /**< VHOST: CA certificate filepath or NULL */
1962 const char *client_ssl_cipher_list;
1963 /**< VHOST: List of valid ciphers to use (eg,
1964 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1965 * or you can leave it as NULL to get "DEFAULT" */
1968 const struct lws_plat_file_ops *fops;
1969 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
1970 * by a sentinel with NULL .open.
1972 * If NULL, lws provides just the platform file operations struct for
1973 * backwards compatibility.
1975 int simultaneous_ssl_restriction;
1976 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
1977 const char *socks_proxy_address;
1978 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1979 * If proxy auth is required, use format "username:password\@server:port" */
1980 unsigned int socks_proxy_port;
1981 /**< VHOST: If socks_proxy_address was non-NULL, uses this port */
1982 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
1983 cap_value_t caps[4];
1984 /**< CONTEXT: array holding Linux capabilities you want to
1985 * continue to be available to the server after it transitions
1986 * to a noprivileged user. Usually none are needed but for, eg,
1987 * .bind_iface, CAP_NET_RAW is required. This gives you a way
1988 * to still have the capability but drop root.
1991 /**< CONTEXT: count of Linux capabilities in .caps[]. 0 means
1992 * no capabilities will be inherited from root (the default) */
1995 /* Add new things just above here ---^
1996 * This is part of the ABI, don't needlessly break compatibility
1998 * The below is to ensure later library versions with new
1999 * members added above will see 0 (default) even if the app
2000 * was not built against the newer headers.
2003 void *_unused[8]; /**< dummy */
2007 * lws_create_context() - Create the websocket handler
2008 * \param info: pointer to struct with parameters
2010 * This function creates the listening socket (if serving) and takes care
2011 * of all initialization in one step.
2013 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
2014 * created; you're expected to create your own vhosts afterwards using
2015 * lws_create_vhost(). Otherwise a vhost named "default" is also created
2016 * using the information in the vhost-related members, for compatibility.
2018 * After initialization, it returns a struct lws_context * that
2019 * represents this server. After calling, user code needs to take care
2020 * of calling lws_service() with the context pointer to get the
2021 * server's sockets serviced. This must be done in the same process
2022 * context as the initialization call.
2024 * The protocol callback functions are called for a handful of events
2025 * including http requests coming in, websocket connections becoming
2026 * established, and data arriving; it's also called periodically to allow
2027 * async transmission.
2029 * HTTP requests are sent always to the FIRST protocol in protocol, since
2030 * at that time websocket protocol has not been negotiated. Other
2031 * protocols after the first one never see any HTTP callback activity.
2033 * The server created is a simple http server by default; part of the
2034 * websocket standard is upgrading this http connection to a websocket one.
2036 * This allows the same server to provide files like scripts and favicon /
2037 * images or whatever over http and dynamic data over websockets all in
2038 * one place; they're all handled in the user callback.
2040 LWS_VISIBLE LWS_EXTERN struct lws_context *
2041 lws_create_context(struct lws_context_creation_info *info);
2044 * lws_context_destroy() - Destroy the websocket context
2045 * \param context: Websocket context
2047 * This function closes any active connections and then frees the
2048 * context. After calling this, any further use of the context is
2051 LWS_VISIBLE LWS_EXTERN void
2052 lws_context_destroy(struct lws_context *context);
2054 LWS_VISIBLE LWS_EXTERN void
2055 lws_context_destroy2(struct lws_context *context);
2057 typedef int (*lws_reload_func)(void);
2060 * lws_context_deprecate() - Deprecate the websocket context
2061 * \param context: Websocket context
2063 * This function is used on an existing context before superceding it
2064 * with a new context.
2066 * It closes any listen sockets in the context, so new connections are
2069 * And it marks the context to be deleted when the number of active
2070 * connections into it falls to zero.
2072 * Otherwise if you attach the deprecated context to the replacement
2073 * context when it has been created using lws_context_attach_deprecated()
2074 * both any deprecated and the new context will service their connections.
2076 * This is aimed at allowing seamless configuration reloads.
2078 * The callback cb will be called after the listen sockets are actually
2079 * closed and may be reopened. In the callback the new context should be
2080 * configured and created. (With libuv, socket close happens async after
2081 * more loop events).
2083 LWS_VISIBLE LWS_EXTERN void
2084 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2086 LWS_VISIBLE LWS_EXTERN int
2087 lws_context_is_deprecated(struct lws_context *context);
2090 * lws_set_proxy() - Setups proxy to lws_context.
2091 * \param vhost: pointer to struct lws_vhost you want set proxy for
2092 * \param proxy: pointer to c string containing proxy in format address:port
2094 * Returns 0 if proxy string was parsed and proxy was setup.
2095 * Returns -1 if proxy is NULL or has incorrect format.
2097 * This is only required if your OS does not provide the http_proxy
2098 * environment variable (eg, OSX)
2100 * IMPORTANT! You should call this function right after creation of the
2101 * lws_context and before call to connect. If you call this
2102 * function after connect behavior is undefined.
2103 * This function will override proxy settings made on lws_context
2104 * creation with genenv() call.
2106 LWS_VISIBLE LWS_EXTERN int
2107 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2110 * lws_set_socks() - Setup socks to lws_context.
2111 * \param vhost: pointer to struct lws_vhost you want set socks for
2112 * \param socks: pointer to c string containing socks in format address:port
2114 * Returns 0 if socks string was parsed and socks was setup.
2115 * Returns -1 if socks is NULL or has incorrect format.
2117 * This is only required if your OS does not provide the socks_proxy
2118 * environment variable (eg, OSX)
2120 * IMPORTANT! You should call this function right after creation of the
2121 * lws_context and before call to connect. If you call this
2122 * function after connect behavior is undefined.
2123 * This function will override proxy settings made on lws_context
2124 * creation with genenv() call.
2126 LWS_VISIBLE LWS_EXTERN int
2127 lws_set_socks(struct lws_vhost *vhost, const char *socks);
2132 * lws_create_vhost() - Create a vhost (virtual server context)
2133 * \param context: pointer to result of lws_create_context()
2134 * \param info: pointer to struct with parameters
2136 * This function creates a virtual server (vhost) using the vhost-related
2137 * members of the info struct. You can create many vhosts inside one context
2138 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2140 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
2141 lws_create_vhost(struct lws_context *context,
2142 struct lws_context_creation_info *info);
2145 * lwsws_get_config_globals() - Parse a JSON server config file
2146 * \param info: pointer to struct with parameters
2147 * \param d: filepath of the config file
2148 * \param config_strings: storage for the config strings extracted from JSON,
2149 * the pointer is incremented as strings are stored
2150 * \param len: pointer to the remaining length left in config_strings
2151 * the value is decremented as strings are stored
2153 * This function prepares a n lws_context_creation_info struct with global
2154 * settings from a file d.
2156 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2158 LWS_VISIBLE LWS_EXTERN int
2159 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2160 char **config_strings, int *len);
2163 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2164 * \param context: pointer to result of lws_create_context()
2165 * \param info: pointer to struct with parameters
2166 * \param d: filepath of the config file
2167 * \param config_strings: storage for the config strings extracted from JSON,
2168 * the pointer is incremented as strings are stored
2169 * \param len: pointer to the remaining length left in config_strings
2170 * the value is decremented as strings are stored
2172 * This function creates vhosts into a context according to the settings in
2173 *JSON files found in directory d.
2175 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2177 LWS_VISIBLE LWS_EXTERN int
2178 lwsws_get_config_vhosts(struct lws_context *context,
2179 struct lws_context_creation_info *info, const char *d,
2180 char **config_strings, int *len);
2182 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2183 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2184 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2187 * lws_get_vhost() - return the vhost a wsi belongs to
2189 * \param wsi: which connection
2191 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2192 lws_get_vhost(struct lws *wsi);
2195 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2197 * \param vh: the vhost
2198 * \param buf: buffer to fill with JSON
2199 * \param len: max length of buf
2201 LWS_VISIBLE LWS_EXTERN int
2202 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2205 * lws_json_dump_context() - describe context state and stats in JSON
2207 * \param context: the context
2208 * \param buf: buffer to fill with JSON
2209 * \param len: max length of buf
2211 LWS_VISIBLE LWS_EXTERN int
2212 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2216 * lws_context_user() - get the user data associated with the context
2217 * \param context: Websocket context
2219 * This returns the optional user allocation that can be attached to
2220 * the context the sockets live in at context_create time. It's a way
2221 * to let all sockets serviced in the same context share data without
2222 * using globals statics in the user code.
2224 LWS_VISIBLE LWS_EXTERN void *
2225 lws_context_user(struct lws_context *context);
2227 /*! \defgroup vhost-mounts Vhost mounts and options
2228 * \ingroup context-and-vhost-creation
2230 * ##Vhost mounts and options
2233 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2234 * name=value options
2236 * This provides a general way to attach a linked-list of name=value pairs,
2237 * which can also have an optional child link-list using the options member.
2239 struct lws_protocol_vhost_options {
2240 const struct lws_protocol_vhost_options *next; /**< linked list */
2241 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2242 const char *name; /**< name of name=value pair */
2243 const char *value; /**< value of name=value pair */
2246 /** enum lws_mount_protocols
2247 * This specifies the mount protocol for a mountpoint, whether it is to be
2248 * served from a filesystem, or it is a cgi etc.
2250 enum lws_mount_protocols {
2251 LWSMPRO_HTTP = 0, /**< not supported yet */
2252 LWSMPRO_HTTPS = 1, /**< not supported yet */
2253 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2254 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2255 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2256 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2257 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2260 /** struct lws_http_mount
2262 * arguments for mounting something in a vhost's url namespace
2264 struct lws_http_mount {
2265 const struct lws_http_mount *mount_next;
2266 /**< pointer to next struct lws_http_mount */
2267 const char *mountpoint;
2268 /**< mountpoint in http pathspace, eg, "/" */
2270 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2272 /**< default target, eg, "index.html" */
2273 const char *protocol;
2274 /**<"protocol-name" to handle mount */
2276 const struct lws_protocol_vhost_options *cgienv;
2277 /**< optional linked-list of cgi options. These are created
2278 * as environment variables for the cgi process
2280 const struct lws_protocol_vhost_options *extra_mimetypes;
2281 /**< optional linked-list of mimetype mappings */
2282 const struct lws_protocol_vhost_options *interpret;
2283 /**< optional linked-list of files to be interpreted */
2286 /**< seconds cgi is allowed to live, if cgi://mount type */
2288 /**< max-age for reuse of client cache of files, seconds */
2289 unsigned int auth_mask;
2290 /**< bits set here must be set for authorized client session */
2292 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2293 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2294 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2296 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2297 unsigned char mountpoint_len; /**< length of mountpoint string */
2299 const char *basic_auth_login_file;
2300 /**<NULL, or filepath to use to check basic auth logins against */
2302 /* Add new things just above here ---^
2303 * This is part of the ABI, don't needlessly break compatibility
2305 * The below is to ensure later library versions with new
2306 * members added above will see 0 (default) even if the app
2307 * was not built against the newer headers.
2310 void *_unused[2]; /**< dummy */
2315 /*! \defgroup client
2318 * ##Client releated functions
2322 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2323 * with struct lws_client_connect_info ssl_connection member to control if
2324 * and how SSL checks apply to the client connection being created
2327 enum lws_client_connect_ssl_connection_flags {
2328 LCCSCF_USE_SSL = (1 << 0),
2329 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2330 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2331 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2334 /** struct lws_client_connect_info - parameters to connect with when using
2335 * lws_client_connect_via_info() */
2337 struct lws_client_connect_info {
2338 struct lws_context *context;
2339 /**< lws context to create connection in */
2340 const char *address;
2341 /**< remote address to connect to */
2343 /**< remote port to connect to */
2345 /**< nonzero for ssl */
2349 /**< content of host header */
2351 /**< content of origin header */
2352 const char *protocol;
2353 /**< list of ws protocols we could accept */
2354 int ietf_version_or_minus_one;
2355 /**< deprecated: currently leave at 0 or -1 */
2357 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2358 const void *client_exts;
2359 /**< UNUSED... provide in info.extensions at context creation time */
2361 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2362 * use "GET" to be a simple http client connection */
2363 struct lws *parent_wsi;
2364 /**< if another wsi is responsible for this connection, give it here.
2365 * this is used to make sure if the parent closes so do any
2366 * child connections first. */
2367 const char *uri_replace_from;
2368 /**< if non-NULL, when this string is found in URIs in
2369 * text/html content-encoding, it's replaced with uri_replace_to */
2370 const char *uri_replace_to;
2371 /**< see uri_replace_from */
2372 struct lws_vhost *vhost;
2373 /**< vhost to bind to (used to determine related SSL_CTX) */
2375 /**< if not NULL, store the new wsi here early in the connection
2376 * process. Although we return the new wsi, the call to create the
2377 * client connection does progress the connection somewhat and may
2378 * meet an error that will result in the connection being scrubbed and
2379 * NULL returned. While the wsi exists though, he may process a
2380 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2381 * user callback a way to identify which wsi it is that faced the error
2382 * even before the new wsi is returned and even if ultimately no wsi
2386 /* Add new things just above here ---^
2387 * This is part of the ABI, don't needlessly break compatibility
2389 * The below is to ensure later library versions with new
2390 * members added above will see 0 (default) even if the app
2391 * was not built against the newer headers.
2394 void *_unused[4]; /**< dummy */
2398 * lws_client_connect_via_info() - Connect to another websocket server
2399 * \param ccinfo: pointer to lws_client_connect_info struct
2401 * This function creates a connection to a remote server using the
2402 * information provided in ccinfo.
2404 LWS_VISIBLE LWS_EXTERN struct lws *
2405 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2408 * lws_client_connect() - Connect to another websocket server
2409 * \deprecated DEPRECATED use lws_client_connect_via_info
2410 * \param clients: Websocket context
2411 * \param address: Remote server address, eg, "myserver.com"
2412 * \param port: Port to connect to on the remote server, eg, 80
2413 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2415 * \param path: Websocket path on server
2416 * \param host: Hostname on server
2417 * \param origin: Socket origin name
2418 * \param protocol: Comma-separated list of protocols being asked for from
2419 * the server, or just one. The server will pick the one it
2420 * likes best. If you don't want to specify a protocol, which is
2421 * legal, use NULL here.
2422 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2423 * protocol supported, or the specific protocol ordinal
2425 * This function creates a connection to a remote server
2427 /* deprecated, use lws_client_connect_via_info() */
2428 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2429 lws_client_connect(struct lws_context *clients, const char *address,
2430 int port, int ssl_connection, const char *path,
2431 const char *host, const char *origin, const char *protocol,
2432 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2433 /* deprecated, use lws_client_connect_via_info() */
2435 * lws_client_connect_extended() - Connect to another websocket server
2436 * \deprecated DEPRECATED use lws_client_connect_via_info
2437 * \param clients: Websocket context
2438 * \param address: Remote server address, eg, "myserver.com"
2439 * \param port: Port to connect to on the remote server, eg, 80
2440 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2442 * \param path: Websocket path on server
2443 * \param host: Hostname on server
2444 * \param origin: Socket origin name
2445 * \param protocol: Comma-separated list of protocols being asked for from
2446 * the server, or just one. The server will pick the one it
2448 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2449 * protocol supported, or the specific protocol ordinal
2450 * \param userdata: Pre-allocated user data
2452 * This function creates a connection to a remote server
2454 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2455 lws_client_connect_extended(struct lws_context *clients, const char *address,
2456 int port, int ssl_connection, const char *path,
2457 const char *host, const char *origin,
2458 const char *protocol, int ietf_version_or_minus_one,
2459 void *userdata) LWS_WARN_DEPRECATED;
2462 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2464 * \param info: client ssl related info
2465 * \param vhost: which vhost to initialize client ssl operations on
2467 * You only need to call this if you plan on using SSL client connections on
2468 * the vhost. For non-SSL client connections, it's not necessary to call this.
2470 * The following members of info are used during the call
2472 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2473 * otherwise the call does nothing
2474 * - provided_client_ssl_ctx must be NULL to get a generated client
2475 * ssl context, otherwise you can pass a prepared one in by setting it
2476 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2477 * - ssl_ca_filepath may be NULL or client cert filepath
2478 * - ssl_cert_filepath may be NULL or client cert filepath
2479 * - ssl_private_key_filepath may be NULL or client cert private key
2481 * You must create your vhost explicitly if you want to use this, so you have
2482 * a pointer to the vhost. Create the context first with the option flag
2483 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2484 * the same info struct.
2486 LWS_VISIBLE LWS_EXTERN int
2487 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2488 struct lws_vhost *vhost);
2490 * lws_http_client_read() - consume waiting received http client data
2492 * \param wsi: client connection
2493 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2494 * \param len: pointer to chunk length - fill with max length of buffer
2496 * This is called when the user code is notified client http data has arrived.
2497 * The user code may choose to delay calling it to consume the data, for example
2498 * waiting until an onward connection is writeable.
2500 * For non-chunked connections, up to len bytes of buf are filled with the
2501 * received content. len is set to the actual amount filled before return.
2503 * For chunked connections, the linear buffer content contains the chunking
2504 * headers and it cannot be passed in one lump. Instead, this function will
2505 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2506 * chunk start and len set to the chunk length. There will be as many calls
2507 * as there are chunks or partial chunks in the buffer.
2509 LWS_VISIBLE LWS_EXTERN int
2510 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2513 * lws_http_client_http_response() - get last HTTP response code
2515 * \param wsi: client connection
2517 * Returns the last server response code, eg, 200 for client http connections.
2519 LWS_VISIBLE LWS_EXTERN unsigned int
2520 lws_http_client_http_response(struct lws *wsi);
2522 LWS_VISIBLE LWS_EXTERN void
2523 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2526 * lws_client_http_body_pending() - control if client connection neeeds to send body
2528 * \param wsi: client connection
2529 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2530 * if nothing more to send
2532 * If you will send payload data with your HTTP client connection, eg, for POST,
2533 * when you set the related http headers in
2534 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2535 * this API with something_left_to_send nonzero, and call
2536 * lws_callback_on_writable(wsi);
2538 * After sending the headers, lws will call your callback with
2539 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2540 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2541 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2542 * let lws know the last part is sent and the connection can move on.
2547 /** \defgroup service Built-in service loop entry
2549 * ##Built-in service loop entry
2551 * If you're not using libev / libuv, these apis are needed to enter the poll()
2552 * wait in lws and service any connections with pending events.
2557 * lws_service() - Service any pending websocket activity
2558 * \param context: Websocket context
2559 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2560 * service otherwise block and service immediately, returning
2561 * after the timeout if nothing needed service.
2563 * This function deals with any pending websocket traffic, for three
2564 * kinds of event. It handles these events on both server and client
2565 * types of connection the same.
2567 * 1) Accept new connections to our context's server
2569 * 2) Call the receive callback for incoming frame data received by
2570 * server or client connections.
2572 * You need to call this service function periodically to all the above
2573 * functions to happen; if your application is single-threaded you can
2574 * just call it in your main event loop.
2576 * Alternatively you can fork a new process that asynchronously handles
2577 * calling this service in a loop. In that case you are happy if this
2578 * call blocks your thread until it needs to take care of something and
2579 * would call it with a large nonzero timeout. Your loop then takes no
2580 * CPU while there is nothing happening.
2582 * If you are calling it in a single-threaded app, you don't want it to
2583 * wait around blocking other things in your loop from happening, so you
2584 * would call it with a timeout_ms of 0, so it returns immediately if
2585 * nothing is pending, or as soon as it services whatever was pending.
2587 LWS_VISIBLE LWS_EXTERN int
2588 lws_service(struct lws_context *context, int timeout_ms);
2591 * lws_service() - Service any pending websocket activity
2593 * \param context: Websocket context
2594 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2595 * service otherwise block and service immediately, returning
2596 * after the timeout if nothing needed service.
2598 * Same as lws_service(), but for a specific thread service index. Only needed
2599 * if you are spawning multiple service threads.
2601 LWS_VISIBLE LWS_EXTERN int
2602 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2605 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2607 * \param wsi: Cancel service on the thread this wsi is serviced by
2609 * This function lets a call to lws_service() waiting for a timeout
2610 * immediately return.
2612 * It works by creating a phony event and then swallowing it silently.
2614 * The reason it may be needed is when waiting in poll(), changes to
2615 * the event masks are ignored by the OS until poll() is reentered. This
2616 * lets you halt the poll() wait and make the reentry happen immediately
2617 * instead of having the wait out the rest of the poll timeout.
2619 LWS_VISIBLE LWS_EXTERN void
2620 lws_cancel_service_pt(struct lws *wsi);
2623 * lws_cancel_service() - Cancel wait for new pending socket activity
2624 * \param context: Websocket context
2626 * This function let a call to lws_service() waiting for a timeout
2627 * immediately return.
2629 * What it basically does is provide a fake event that will be swallowed,
2630 * so the wait in poll() is ended. That's useful because poll() doesn't
2631 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2633 LWS_VISIBLE LWS_EXTERN void
2634 lws_cancel_service(struct lws_context *context);
2637 * lws_service_fd() - Service polled socket with something waiting
2638 * \param context: Websocket context
2639 * \param pollfd: The pollfd entry describing the socket fd and which events
2640 * happened, or NULL to tell lws to do only timeout servicing.
2642 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2643 * services it according to the state of the associated
2646 * The one call deals with all "service" that might happen on a socket
2647 * including listen accepts, http files as well as websocket protocol.
2649 * If a pollfd says it has something, you can just pass it to
2650 * lws_service_fd() whether it is a socket handled by lws or not.
2651 * If it sees it is a lws socket, the traffic will be handled and
2652 * pollfd->revents will be zeroed now.
2654 * If the socket is foreign to lws, it leaves revents alone. So you can
2655 * see if you should service yourself by checking the pollfd revents
2656 * after letting lws try to service it.
2658 * You should also call this with pollfd = NULL to just allow the
2659 * once-per-second global timeout checks; if less than a second since the last
2660 * check it returns immediately then.
2662 LWS_VISIBLE LWS_EXTERN int
2663 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2666 * lws_service_fd_tsi() - Service polled socket in specific service thread
2667 * \param context: Websocket context
2668 * \param pollfd: The pollfd entry describing the socket fd and which events
2670 * \param tsi: thread service index
2672 * Same as lws_service_fd() but used with multiple service threads
2674 LWS_VISIBLE LWS_EXTERN int
2675 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2679 * lws_service_adjust_timeout() - Check for any connection needing forced service
2680 * \param context: Websocket context
2681 * \param timeout_ms: The original poll timeout value. You can just set this
2682 * to 1 if you don't really have a poll timeout.
2683 * \param tsi: thread service index
2685 * Under some conditions connections may need service even though there is no
2686 * pending network action on them, this is "forced service". For default
2687 * poll() and libuv / libev, the library takes care of calling this and
2688 * dealing with it for you. But for external poll() integration, you need
2689 * access to the apis.
2691 * If anybody needs "forced service", returned timeout is zero. In that case,
2692 * you can call lws_service_tsi() with a timeout of -1 to only service
2693 * guys who need forced service.
2695 LWS_VISIBLE LWS_EXTERN int
2696 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2698 /* Backwards compatibility */
2699 #define lws_plat_service_tsi lws_service_tsi
2703 /*! \defgroup http HTTP
2705 Modules related to handling HTTP
2709 /*! \defgroup httpft HTTP File transfer
2712 APIs for sending local files in response to HTTP requests
2717 * lws_get_mimetype() - Determine mimetype to use from filename
2719 * \param file: filename
2720 * \param m: NULL, or mount context
2722 * This uses a canned list of known filetypes first, if no match and m is
2723 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2725 * Returns either NULL or a pointer to the mimetype matching the file.
2727 LWS_VISIBLE LWS_EXTERN const char *
2728 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2731 * lws_serve_http_file() - Send a file back to the client using http
2732 * \param wsi: Websocket instance (available from user callback)
2733 * \param file: The file to issue over http
2734 * \param content_type: The http content type, eg, text/html
2735 * \param other_headers: NULL or pointer to header string
2736 * \param other_headers_len: length of the other headers if non-NULL
2738 * This function is intended to be called from the callback in response
2739 * to http requests from the client. It allows the callback to issue
2740 * local files down the http link in a single step.
2742 * Returning <0 indicates error and the wsi should be closed. Returning
2743 * >0 indicates the file was completely sent and
2744 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2745 * ==0 indicates the file transfer is started and needs more service later,
2746 * the wsi should be left alone.
2748 LWS_VISIBLE LWS_EXTERN int
2749 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2750 const char *other_headers, int other_headers_len);
2752 LWS_VISIBLE LWS_EXTERN int
2753 lws_serve_http_file_fragment(struct lws *wsi);
2756 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2759 * ##HTML chunked Substitution
2761 * APIs for receiving chunks of text, replacing a set of variable names via
2762 * a callback, and then prepending and appending HTML chunked encoding
2768 HTTP_STATUS_OK = 200,
2769 HTTP_STATUS_NO_CONTENT = 204,
2770 HTTP_STATUS_PARTIAL_CONTENT = 206,
2772 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2773 HTTP_STATUS_FOUND = 302,
2774 HTTP_STATUS_SEE_OTHER = 303,
2775 HTTP_STATUS_NOT_MODIFIED = 304,
2777 HTTP_STATUS_BAD_REQUEST = 400,
2778 HTTP_STATUS_UNAUTHORIZED,
2779 HTTP_STATUS_PAYMENT_REQUIRED,
2780 HTTP_STATUS_FORBIDDEN,
2781 HTTP_STATUS_NOT_FOUND,
2782 HTTP_STATUS_METHOD_NOT_ALLOWED,
2783 HTTP_STATUS_NOT_ACCEPTABLE,
2784 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2785 HTTP_STATUS_REQUEST_TIMEOUT,
2786 HTTP_STATUS_CONFLICT,
2788 HTTP_STATUS_LENGTH_REQUIRED,
2789 HTTP_STATUS_PRECONDITION_FAILED,
2790 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2791 HTTP_STATUS_REQ_URI_TOO_LONG,
2792 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2793 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2794 HTTP_STATUS_EXPECTATION_FAILED,
2796 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2797 HTTP_STATUS_NOT_IMPLEMENTED,
2798 HTTP_STATUS_BAD_GATEWAY,
2799 HTTP_STATUS_SERVICE_UNAVAILABLE,
2800 HTTP_STATUS_GATEWAY_TIMEOUT,
2801 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2804 struct lws_process_html_args {
2805 char *p; /**< pointer to the buffer containing the data */
2806 int len; /**< length of the original data at p */
2807 int max_len; /**< maximum length we can grow the data to */
2808 int final; /**< set if this is the last chunk of the file */
2811 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2813 struct lws_process_html_state {
2814 char *start; /**< pointer to start of match */
2815 char swallow[16]; /**< matched character buffer */
2816 int pos; /**< position in match */
2817 void *data; /**< opaque pointer */
2818 const char * const *vars; /**< list of variable names */
2819 int count_vars; /**< count of variable names */
2821 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2824 /*! lws_chunked_html_process() - generic chunked substitution
2825 * \param args: buffer to process using chunked encoding
2826 * \param s: current processing state
2828 LWS_VISIBLE LWS_EXTERN int
2829 lws_chunked_html_process(struct lws_process_html_args *args,
2830 struct lws_process_html_state *s);
2833 /** \defgroup HTTP-headers-read HTTP headers: read
2836 * ##HTTP header releated functions
2838 * In lws the client http headers are temporarily stored in a pool, only for the
2839 * duration of the http part of the handshake. It's because in most cases,
2840 * the header content is ignored for the whole rest of the connection lifetime
2841 * and would then just be taking up space needlessly.
2843 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2844 * the http headers are still allocated, you can use these apis then to
2845 * look at and copy out interesting header content (cookies, etc)
2847 * Notice that the header total length reported does not include a terminating
2848 * '\0', however you must allocate for it when using the _copy apis. So the
2849 * length reported for a header containing "123" is 3, but you must provide
2850 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2851 * will fail with a nonzero return code.
2853 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2854 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2855 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2856 * length to confirm the method.
2858 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2859 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2860 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2862 * As a convenience, lws has an api that will find the fragment with a
2863 * given name= part, lws_get_urlarg_by_name().
2867 /** struct lws_tokens
2868 * you need these to look at headers that have been parsed if using the
2869 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
2870 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
2871 * points to .token_len chars containing that header content.
2874 char *token; /**< pointer to start of the token */
2875 int token_len; /**< length of the token's value */
2878 /* enum lws_token_indexes
2879 * these have to be kept in sync with lextable.h / minilex.c
2881 * NOTE: These public enums are part of the abi. If you want to add one,
2882 * add it at where specified so existing users are unaffected.
2884 enum lws_token_indexes {
2885 WSI_TOKEN_GET_URI = 0,
2886 WSI_TOKEN_POST_URI = 1,
2887 WSI_TOKEN_OPTIONS_URI = 2,
2889 WSI_TOKEN_CONNECTION = 4,
2890 WSI_TOKEN_UPGRADE = 5,
2891 WSI_TOKEN_ORIGIN = 6,
2892 WSI_TOKEN_DRAFT = 7,
2893 WSI_TOKEN_CHALLENGE = 8,
2894 WSI_TOKEN_EXTENSIONS = 9,
2895 WSI_TOKEN_KEY1 = 10,
2896 WSI_TOKEN_KEY2 = 11,
2897 WSI_TOKEN_PROTOCOL = 12,
2898 WSI_TOKEN_ACCEPT = 13,
2899 WSI_TOKEN_NONCE = 14,
2900 WSI_TOKEN_HTTP = 15,
2901 WSI_TOKEN_HTTP2_SETTINGS = 16,
2902 WSI_TOKEN_HTTP_ACCEPT = 17,
2903 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2904 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2905 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2906 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2907 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2908 WSI_TOKEN_HTTP_PRAGMA = 23,
2909 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2910 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2911 WSI_TOKEN_HTTP_COOKIE = 26,
2912 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2913 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2914 WSI_TOKEN_HTTP_DATE = 29,
2915 WSI_TOKEN_HTTP_RANGE = 30,
2916 WSI_TOKEN_HTTP_REFERER = 31,
2918 WSI_TOKEN_VERSION = 33,
2919 WSI_TOKEN_SWORIGIN = 34,
2921 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2922 WSI_TOKEN_HTTP_COLON_METHOD = 36,
2923 WSI_TOKEN_HTTP_COLON_PATH = 37,
2924 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2925 WSI_TOKEN_HTTP_COLON_STATUS = 39,
2927 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2928 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2929 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2930 WSI_TOKEN_HTTP_AGE = 43,
2931 WSI_TOKEN_HTTP_ALLOW = 44,
2932 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2933 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2934 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2935 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2936 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2937 WSI_TOKEN_HTTP_ETAG = 50,
2938 WSI_TOKEN_HTTP_EXPECT = 51,
2939 WSI_TOKEN_HTTP_EXPIRES = 52,
2940 WSI_TOKEN_HTTP_FROM = 53,
2941 WSI_TOKEN_HTTP_IF_MATCH = 54,
2942 WSI_TOKEN_HTTP_IF_RANGE = 55,
2943 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2944 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2945 WSI_TOKEN_HTTP_LINK = 58,
2946 WSI_TOKEN_HTTP_LOCATION = 59,
2947 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2948 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2949 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2950 WSI_TOKEN_HTTP_REFRESH = 63,
2951 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2952 WSI_TOKEN_HTTP_SERVER = 65,
2953 WSI_TOKEN_HTTP_SET_COOKIE = 66,
2954 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2955 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
2956 WSI_TOKEN_HTTP_USER_AGENT = 69,
2957 WSI_TOKEN_HTTP_VARY = 70,
2958 WSI_TOKEN_HTTP_VIA = 71,
2959 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
2961 WSI_TOKEN_PATCH_URI = 73,
2962 WSI_TOKEN_PUT_URI = 74,
2963 WSI_TOKEN_DELETE_URI = 75,
2965 WSI_TOKEN_HTTP_URI_ARGS = 76,
2966 WSI_TOKEN_PROXY = 77,
2967 WSI_TOKEN_HTTP_X_REAL_IP = 78,
2968 WSI_TOKEN_HTTP1_0 = 79,
2969 WSI_TOKEN_X_FORWARDED_FOR = 80,
2970 WSI_TOKEN_CONNECT = 81,
2971 /****** add new things just above ---^ ******/
2973 /* use token storage to stash these internally, not for
2976 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
2977 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
2978 _WSI_TOKEN_CLIENT_URI,
2979 _WSI_TOKEN_CLIENT_HOST,
2980 _WSI_TOKEN_CLIENT_ORIGIN,
2981 _WSI_TOKEN_CLIENT_METHOD,
2983 /* always last real token index*/
2986 /* parser state additions, no storage associated */
2987 WSI_TOKEN_NAME_PART,
2989 WSI_TOKEN_SKIPPING_SAW_CR,
2990 WSI_PARSING_COMPLETE,
2991 WSI_INIT_TOKEN_MUXURL,
2994 struct lws_token_limits {
2995 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
2999 * lws_token_to_string() - returns a textual representation of a hdr token index
3001 * \param: token index
3003 LWS_VISIBLE LWS_EXTERN const unsigned char *
3004 lws_token_to_string(enum lws_token_indexes token);
3008 * lws_hdr_total_length: report length of all fragments of a header totalled up
3009 * The returned length does not include the space for a
3012 * \param wsi: websocket connection
3013 * \param h: which header index we are interested in
3015 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3016 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
3019 * lws_hdr_fragment_length: report length of a single fragment of a header
3020 * The returned length does not include the space for a
3023 * \param wsi: websocket connection
3024 * \param h: which header index we are interested in
3025 * \param frag_idx: which fragment of h we want to get the length of
3027 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3028 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
3031 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
3032 * The buffer length len must include space for an additional
3033 * terminating '\0', or it will fail returning -1.
3035 * \param wsi: websocket connection
3036 * \param dest: destination buffer
3037 * \param len: length of destination buffer
3038 * \param h: which header index we are interested in
3040 * copies the whole, aggregated header, even if it was delivered in
3041 * several actual headers piece by piece
3043 LWS_VISIBLE LWS_EXTERN int
3044 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
3047 * lws_hdr_copy_fragment() - copy a single fragment of the given header to a buffer
3048 * The buffer length len must include space for an additional
3049 * terminating '\0', or it will fail returning -1.
3050 * If the requested fragment index is not present, it fails
3053 * \param wsi: websocket connection
3054 * \param dest: destination buffer
3055 * \param len: length of destination buffer
3056 * \param h: which header index we are interested in
3057 * \param frag_idx: which fragment of h we want to copy
3059 * Normally this is only useful
3060 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
3061 * fragment 0 will contain "x=1" and fragment 1 "y=2"
3063 LWS_VISIBLE LWS_EXTERN int
3064 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
3065 enum lws_token_indexes h, int frag_idx);
3068 * lws_get_urlarg_by_name() - return pointer to arg value if present
3069 * \param wsi: the connection to check
3070 * \param name: the arg name, like "token="
3071 * \param buf: the buffer to receive the urlarg (including the name= part)
3072 * \param len: the length of the buffer to receive the urlarg
3074 * Returns NULL if not found or a pointer inside buf to just after the
3077 LWS_VISIBLE LWS_EXTERN const char *
3078 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
3081 /*! \defgroup HTTP-headers-create HTTP headers: create
3083 * ## HTTP headers: Create
3085 * These apis allow you to create HTTP response headers in a way compatible with
3086 * both HTTP/1.x and HTTP/2.
3088 * They each append to a buffer taking care about the buffer end, which is
3089 * passed in as a pointer. When data is written to the buffer, the current
3090 * position p is updated accordingly.
3092 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3093 * and fail with nonzero return.
3097 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3098 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3101 * lws_add_http_header_status() - add the HTTP response status code
3103 * \param wsi: the connection to check
3104 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3105 * \param p: pointer to current position in buffer pointer
3106 * \param end: pointer to end of buffer
3108 * Adds the initial response code, so should be called first.
3110 * Code may additionally take OR'd flags:
3112 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3114 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3115 lws_add_http_header_status(struct lws *wsi,
3116 unsigned int code, unsigned char **p,
3117 unsigned char *end);
3119 * lws_add_http_header_by_name() - append named header and value
3121 * \param wsi: the connection to check
3122 * \param name: the hdr name, like "my-header"
3123 * \param value: the value after the = for this header
3124 * \param length: the length of the value
3125 * \param p: pointer to current position in buffer pointer
3126 * \param end: pointer to end of buffer
3128 * Appends name: value to the headers
3130 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3131 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3132 const unsigned char *value, int length,
3133 unsigned char **p, unsigned char *end);
3135 * lws_add_http_header_by_token() - append given header and value
3137 * \param wsi: the connection to check
3138 * \param token: the token index for the hdr
3139 * \param value: the value after the = for this header
3140 * \param length: the length of the value
3141 * \param p: pointer to current position in buffer pointer
3142 * \param end: pointer to end of buffer
3144 * Appends name=value to the headers, but is able to take advantage of better
3145 * HTTP/2 coding mechanisms where possible.
3147 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3148 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3149 const unsigned char *value, int length,
3150 unsigned char **p, unsigned char *end);
3152 * lws_add_http_header_content_length() - append content-length helper
3154 * \param wsi: the connection to check
3155 * \param content_length: the content length to use
3156 * \param p: pointer to current position in buffer pointer
3157 * \param end: pointer to end of buffer
3159 * Appends content-length: content_length to the headers
3161 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3162 lws_add_http_header_content_length(struct lws *wsi,
3163 unsigned long content_length,
3164 unsigned char **p, unsigned char *end);
3166 * lws_finalize_http_header() - terminate header block
3168 * \param wsi: the connection to check
3169 * \param p: pointer to current position in buffer pointer
3170 * \param end: pointer to end of buffer
3172 * Indicates no more headers will be added
3174 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3175 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3176 unsigned char *end);
3179 /** \defgroup form-parsing Form Parsing
3181 * ##POSTed form parsing functions
3183 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3184 * POSTed form arguments, both using simple urlencoded and multipart transfer
3187 * It's capable of handling file uploads as well a named input parsing,
3188 * and the apis are the same for both form upload styles.
3190 * You feed it a list of parameter names and it creates pointers to the
3191 * urldecoded arguments: file upload parameters pass the file data in chunks to
3192 * a user-supplied callback as they come.
3194 * Since it's stateful, it handles the incoming data needing more than one
3195 * POST_BODY callback and has no limit on uploaded file size.
3199 /** enum lws_spa_fileupload_states */
3200 enum lws_spa_fileupload_states {
3202 /**< a chunk of file content has arrived */
3203 LWS_UFS_FINAL_CONTENT,
3204 /**< the last chunk (possibly zero length) of file content has arrived */
3206 /**< a new file is starting to arrive */
3210 * lws_spa_fileupload_cb() - callback to receive file upload data
3212 * \param data: opt_data pointer set in lws_spa_create
3213 * \param name: name of the form field being uploaded
3214 * \param filename: original filename from client
3215 * \param buf: start of data to receive
3216 * \param len: length of data to receive
3217 * \param state: information about how this call relates to file
3219 * Notice name and filename shouldn't be trusted, as they are passed from
3220 * HTTP provided by the client.
3222 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3223 const char *filename, char *buf, int len,
3224 enum lws_spa_fileupload_states state);
3226 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3227 * and file uploads */
3231 * lws_spa_create() - create urldecode parser
3233 * \param wsi: lws connection (used to find Content Type)
3234 * \param param_names: array of form parameter names, like "username"
3235 * \param count_params: count of param_names
3236 * \param max_storage: total amount of form parameter values we can store
3237 * \param opt_cb: NULL, or callback to receive file upload data.
3238 * \param opt_data: NULL, or user pointer provided to opt_cb.
3240 * Creates a urldecode parser and initializes it.
3242 * opt_cb can be NULL if you just want normal name=value parsing, however
3243 * if one or more entries in your form are bulk data (file transfer), you
3244 * can provide this callback and filter on the name callback parameter to
3245 * treat that urldecoded data separately. The callback should return -1
3246 * in case of fatal error, and 0 if OK.
3248 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3249 lws_spa_create(struct lws *wsi, const char * const *param_names,
3250 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3254 * lws_spa_process() - parses a chunk of input data
3256 * \param spa: the parser object previously created
3257 * \param in: incoming, urlencoded data
3258 * \param len: count of bytes valid at \param in
3260 LWS_VISIBLE LWS_EXTERN int
3261 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3264 * lws_spa_finalize() - indicate incoming data completed
3266 * \param spa: the parser object previously created
3268 LWS_VISIBLE LWS_EXTERN int
3269 lws_spa_finalize(struct lws_spa *spa);
3272 * lws_spa_get_length() - return length of parameter value
3274 * \param spa: the parser object previously created
3275 * \param n: parameter ordinal to return length of value for
3277 LWS_VISIBLE LWS_EXTERN int
3278 lws_spa_get_length(struct lws_spa *spa, int n);
3281 * lws_spa_get_string() - return pointer to parameter value
3282 * \param spa: the parser object previously created
3283 * \param n: parameter ordinal to return pointer to value for
3285 LWS_VISIBLE LWS_EXTERN const char *
3286 lws_spa_get_string(struct lws_spa *spa, int n);
3289 * lws_spa_destroy() - destroy parser object
3291 * \param spa: the parser object previously created
3293 LWS_VISIBLE LWS_EXTERN int
3294 lws_spa_destroy(struct lws_spa *spa);
3297 /*! \defgroup urlendec Urlencode and Urldecode
3300 * ##HTML chunked Substitution
3302 * APIs for receiving chunks of text, replacing a set of variable names via
3303 * a callback, and then prepending and appending HTML chunked encoding
3309 * lws_urlencode() - like strncpy but with urlencoding
3311 * \param escaped: output buffer
3312 * \param string: input buffer ('/0' terminated)
3313 * \param len: output buffer max length
3315 * Because urlencoding expands the output string, it's not
3316 * possible to do it in-place, ie, with escaped == string
3318 LWS_VISIBLE LWS_EXTERN const char *
3319 lws_urlencode(char *escaped, const char *string, int len);
3324 * This simple urldecode only operates until the first '\0' and requires the
3325 * data to exist all at once
3328 * lws_urldecode() - like strncpy but with urldecoding
3330 * \param string: output buffer
3331 * \param escaped: input buffer ('\0' terminated)
3332 * \param len: output buffer max length
3334 * This is only useful for '\0' terminated strings
3336 * Since urldecoding only shrinks the output string, it is possible to
3337 * do it in-place, ie, string == escaped
3339 LWS_VISIBLE LWS_EXTERN int
3340 lws_urldecode(char *string, const char *escaped, int len);
3343 * lws_return_http_status() - Return simple http status
3344 * \param wsi: Websocket instance (available from user callback)
3345 * \param code: Status index, eg, 404
3346 * \param html_body: User-readable HTML description < 1KB, or NULL
3348 * Helper to report HTTP errors back to the client cleanly and
3351 LWS_VISIBLE LWS_EXTERN int
3352 lws_return_http_status(struct lws *wsi, unsigned int code,
3353 const char *html_body);
3356 * lws_http_redirect() - write http redirect into buffer
3358 * \param wsi: websocket connection
3359 * \param code: HTTP response code (eg, 301)
3360 * \param loc: where to redirect to
3361 * \param len: length of loc
3362 * \param p: pointer current position in buffer (updated as we write)
3363 * \param end: pointer to end of buffer
3365 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3366 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3367 unsigned char **p, unsigned char *end);
3370 * lws_http_transaction_completed() - wait for new http transaction or close
3371 * \param wsi: websocket connection
3373 * Returns 1 if the HTTP connection must close now
3374 * Returns 0 and resets connection to wait for new HTTP header /
3375 * transaction if possible
3377 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3378 lws_http_transaction_completed(struct lws *wsi);
3381 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3383 * ##Sanitize / purify SQL and JSON helpers
3385 * APIs for escaping untrusted JSON and SQL safely before use
3390 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3392 * \param escaped: output buffer
3393 * \param string: input buffer ('/0' terminated)
3394 * \param len: output buffer max length
3396 * Because escaping expands the output string, it's not
3397 * possible to do it in-place, ie, with escaped == string
3399 LWS_VISIBLE LWS_EXTERN const char *
3400 lws_sql_purify(char *escaped, const char *string, int len);
3403 * lws_json_purify() - like strncpy but with escaping for json chars
3405 * \param escaped: output buffer
3406 * \param string: input buffer ('/0' terminated)
3407 * \param len: output buffer max length
3409 * Because escaping expands the output string, it's not
3410 * possible to do it in-place, ie, with escaped == string
3412 LWS_VISIBLE LWS_EXTERN const char *
3413 lws_json_purify(char *escaped, const char *string, int len);
3416 /*! \defgroup ev libev helpers
3420 * APIs specific to libev event loop itegration
3424 #ifdef LWS_USE_LIBEV
3425 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3427 LWS_VISIBLE LWS_EXTERN int
3428 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3429 lws_ev_signal_cb_t *cb);
3431 LWS_VISIBLE LWS_EXTERN int
3432 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3434 LWS_VISIBLE LWS_EXTERN void
3435 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3436 #endif /* LWS_USE_LIBEV */
3440 /*! \defgroup uv libuv helpers
3444 * APIs specific to libuv event loop itegration
3447 #ifdef LWS_USE_LIBUV
3448 LWS_VISIBLE LWS_EXTERN int
3449 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3452 LWS_VISIBLE LWS_EXTERN void
3453 lws_libuv_run(const struct lws_context *context, int tsi);
3455 LWS_VISIBLE LWS_EXTERN void
3456 lws_libuv_stop(struct lws_context *context);
3458 LWS_VISIBLE LWS_EXTERN void
3459 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3461 LWS_VISIBLE LWS_EXTERN int
3462 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3464 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3465 lws_uv_getloop(struct lws_context *context, int tsi);
3467 LWS_VISIBLE LWS_EXTERN void
3468 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3469 #endif /* LWS_USE_LIBUV */
3472 /*! \defgroup event libevent helpers
3474 * ##libevent helpers
3476 * APIs specific to libevent event loop itegration
3480 #ifdef LWS_USE_LIBEVENT
3481 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3484 LWS_VISIBLE LWS_EXTERN int
3485 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3486 lws_event_signal_cb_t cb);
3488 LWS_VISIBLE LWS_EXTERN int
3489 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3492 LWS_VISIBLE LWS_EXTERN void
3493 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3495 #endif /* LWS_USE_LIBEVENT */
3499 /*! \defgroup timeout Connection timeouts
3501 APIs related to setting connection timeouts
3506 * NOTE: These public enums are part of the abi. If you want to add one,
3507 * add it at where specified so existing users are unaffected.
3509 enum pending_timeout {
3510 NO_PENDING_TIMEOUT = 0,
3511 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3512 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3513 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3514 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3515 PENDING_TIMEOUT_AWAITING_PING = 5,
3516 PENDING_TIMEOUT_CLOSE_ACK = 6,
3517 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3518 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3519 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3520 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3521 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3522 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3523 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3524 PENDING_TIMEOUT_CGI = 14,
3525 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3526 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3527 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3528 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3529 PENDING_TIMEOUT_AWAITING_SOCKS_GREETING_REPLY = 19,
3530 PENDING_TIMEOUT_AWAITING_SOCKS_CONNECT_REPLY = 20,
3531 PENDING_TIMEOUT_AWAITING_SOCKS_AUTH_REPLY = 21,
3533 /****** add new things just above ---^ ******/
3537 * lws_set_timeout() - marks the wsi as subject to a timeout
3539 * You will not need this unless you are doing something special
3541 * \param wsi: Websocket connection instance
3542 * \param reason: timeout reason
3543 * \param secs: how many seconds
3545 LWS_VISIBLE LWS_EXTERN void
3546 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3549 /*! \defgroup sending-data Sending data
3551 APIs related to writing data on a connection
3554 #if !defined(LWS_SIZEOFPTR)
3555 #define LWS_SIZEOFPTR (sizeof (void *))
3557 #if !defined(u_int64_t)
3558 #define u_int64_t unsigned long long
3561 #if defined(__x86_64__)
3562 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3564 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3566 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3567 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3568 #define LWS_PRE _LWS_PAD(4 + 10)
3569 /* used prior to 1.7 and retained for backward compatibility */
3570 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3571 #define LWS_SEND_BUFFER_POST_PADDING 0
3574 * NOTE: These public enums are part of the abi. If you want to add one,
3575 * add it at where specified so existing users are unaffected.
3577 enum lws_write_protocol {
3579 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3580 * memory behind it. The receiver expects only valid utf-8 in the
3582 LWS_WRITE_BINARY = 1,
3583 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3584 * memory behind it. Any sequence of bytes is valid */
3585 LWS_WRITE_CONTINUATION = 2,
3586 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3587 * memory behind it */
3589 /**< Send HTTP content */
3591 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3595 /* Same as write_http but we know this write ends the transaction */
3596 LWS_WRITE_HTTP_FINAL = 7,
3600 LWS_WRITE_HTTP_HEADERS = 8,
3601 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3602 * payload differently, http 1.x links also handle this correctly. so
3603 * to be compatible with both in the future,header response part should
3604 * be sent using this regardless of http version expected)
3607 /****** add new things just above ---^ ******/
3611 LWS_WRITE_NO_FIN = 0x40,
3612 /**< This part of the message is not the end of the message */
3614 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3615 /**< client packet payload goes out on wire unmunged
3616 * only useful for security tests since normal servers cannot
3617 * decode the content if used */
3622 * lws_write() - Apply protocol then write data to client
3623 * \param wsi: Websocket instance (available from user callback)
3624 * \param buf: The data to send. For data being sent on a websocket
3625 * connection (ie, not default http), this buffer MUST have
3626 * LWS_PRE bytes valid BEFORE the pointer.
3627 * This is so the protocol header data can be added in-situ.
3628 * \param len: Count of the data bytes in the payload starting from buf
3629 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3630 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3631 * data on a websockets connection. Remember to allow the extra
3632 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3635 * This function provides the way to issue data back to the client
3636 * for both http and websocket protocols.
3640 * When sending with websocket protocol
3644 * LWS_WRITE_CONTINUATION,
3648 * the send buffer has to have LWS_PRE bytes valid BEFORE
3649 * the buffer pointer you pass to lws_write().
3651 * This allows us to add protocol info before and after the data, and send as
3652 * one packet on the network without payload copying, for maximum efficiency.
3654 * So for example you need this kind of code to use lws_write with a
3657 * char buf[LWS_PRE + 128];
3659 * // fill your part of the buffer... for example here it's all zeros
3660 * memset(&buf[LWS_PRE], 0, 128);
3662 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3664 * When sending HTTP, with
3667 * LWS_WRITE_HTTP_HEADERS
3668 * LWS_WRITE_HTTP_FINAL
3670 * there is no protocol data prepended, and don't need to take care about the
3671 * LWS_PRE bytes valid before the buffer pointer.
3673 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3674 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3675 * The example apps no longer use it.
3677 * Pad LWS_PRE to the CPU word size, so that word references
3678 * to the address immediately after the padding won't cause an unaligned access
3679 * error. Sometimes for performance reasons the recommended padding is even
3680 * larger than sizeof(void *).
3682 * In the case of sending using websocket protocol, be sure to allocate
3683 * valid storage before and after buf as explained above. This scheme
3684 * allows maximum efficiency of sending data and protocol in a single
3685 * packet while not burdening the user code with any protocol knowledge.
3687 * Return may be -1 for a fatal error needing connection close, or the
3688 * number of bytes sent.
3693 * The OS may not accept everything you asked to write on the connection.
3695 * Posix defines POLLOUT indication from poll() to show that the connection
3696 * will accept more write data, but it doesn't specifiy how much. It may just
3697 * accept one byte of whatever you wanted to send.
3699 * LWS will buffer the remainder automatically, and send it out autonomously.
3701 * During that time, WRITABLE callbacks will be suppressed.
3703 * This is to handle corner cases where unexpectedly the OS refuses what we
3704 * usually expect it to accept. You should try to send in chunks that are
3705 * almost always accepted in order to avoid the inefficiency of the buffering.
3707 LWS_VISIBLE LWS_EXTERN int
3708 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3709 enum lws_write_protocol protocol);
3711 /* helper for case where buffer may be const */
3712 #define lws_write_http(wsi, buf, len) \
3713 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3716 /** \defgroup callback-when-writeable Callback when writeable
3718 * ##Callback When Writeable
3720 * lws can only write data on a connection when it is able to accept more
3721 * data without blocking.
3723 * So a basic requirement is we should only use the lws_write() apis when the
3724 * connection we want to write on says that he can accept more data.
3726 * When lws cannot complete your send at the time, it will buffer the data
3727 * and send it in the background, suppressing any further WRITEABLE callbacks
3728 * on that connection until it completes. So it is important to write new
3729 * things in a new writeable callback.
3731 * These apis reflect the various ways we can indicate we would like to be
3732 * called back when one or more connections is writeable.
3737 * lws_callback_on_writable() - Request a callback when this socket
3738 * becomes able to be written to without
3741 * \param wsi: Websocket connection instance to get callback for
3743 * - Which: only this wsi
3744 * - When: when the individual connection becomes writeable
3745 * - What: LWS_CALLBACK_*_WRITEABLE
3747 LWS_VISIBLE LWS_EXTERN int
3748 lws_callback_on_writable(struct lws *wsi);
3751 * lws_callback_on_writable_all_protocol() - Request a callback for all
3752 * connections on same vhost using the given protocol when it
3753 * becomes possible to write to each socket without
3756 * \param context: lws_context
3757 * \param protocol: Protocol whose connections will get callbacks
3759 * - Which: connections using this protocol on ANY VHOST
3760 * - When: when the individual connection becomes writeable
3761 * - What: LWS_CALLBACK_*_WRITEABLE
3763 LWS_VISIBLE LWS_EXTERN int
3764 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3765 const struct lws_protocols *protocol);
3768 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3769 * all connections using the given protocol when it
3770 * becomes possible to write to each socket without
3773 * \param vhost: Only consider connections on this lws_vhost
3774 * \param protocol: Protocol whose connections will get callbacks
3776 * - Which: connections using this protocol on GIVEN VHOST ONLY
3777 * - When: when the individual connection becomes writeable
3778 * - What: LWS_CALLBACK_*_WRITEABLE
3780 LWS_VISIBLE LWS_EXTERN int
3781 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3782 const struct lws_protocols *protocol);
3785 * lws_callback_all_protocol() - Callback all connections using
3786 * the given protocol with the given reason
3788 * \param context: lws_context
3789 * \param protocol: Protocol whose connections will get callbacks
3790 * \param reason: Callback reason index
3792 * - Which: connections using this protocol on ALL VHOSTS
3793 * - When: before returning
3796 * This isn't normally what you want... normally any update of connection-
3797 * specific information can wait until a network-related callback like rx,
3798 * writable, or close.
3800 LWS_VISIBLE LWS_EXTERN int
3801 lws_callback_all_protocol(struct lws_context *context,
3802 const struct lws_protocols *protocol, int reason);
3805 * lws_callback_all_protocol_vhost() - Callback all connections using
3806 * the given protocol with the given reason
3808 * \param vh: Vhost whose connections will get callbacks
3809 * \param protocol: Which protocol to match
3810 * \param reason: Callback reason index
3812 * - Which: connections using this protocol on GIVEN VHOST ONLY
3816 LWS_VISIBLE LWS_EXTERN int
3817 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3818 const struct lws_protocols *protocol, int reason);
3821 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3822 * with the given reason
3824 * \param wsi: wsi whose vhost will get callbacks
3825 * \param reason: Callback reason index
3826 * \param in: in argument to callback
3827 * \param len: len argument to callback
3829 * - Which: connections using this protocol on same VHOST as wsi ONLY
3833 LWS_VISIBLE LWS_EXTERN int
3834 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3836 LWS_VISIBLE LWS_EXTERN int
3837 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3838 void *user, void *in, size_t len);
3841 * lws_get_socket_fd() - returns the socket file descriptor
3843 * You will not need this unless you are doing something special
3845 * \param wsi: Websocket connection instance
3847 LWS_VISIBLE LWS_EXTERN int
3848 lws_get_socket_fd(struct lws *wsi);
3851 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
3854 * \param wsi: Websocket connection instance
3856 * if the protocol does not have any guidance, returns -1. Currently only
3857 * http2 connections get send window information from this API. But your code
3858 * should use it so it can work properly with any protocol.
3860 * If nonzero return is the amount of payload data the peer or intermediary has
3861 * reported it has buffer space for. That has NO relationship with the amount
3862 * of buffer space your OS can accept on this connection for a write action.
3864 * This number represents the maximum you could send to the peer or intermediary
3865 * on this connection right now without the protocol complaining.
3867 * lws manages accounting for send window updates and payload writes
3868 * automatically, so this number reflects the situation at the peer or
3869 * intermediary dynamically.
3871 LWS_VISIBLE LWS_EXTERN size_t
3872 lws_get_peer_write_allowance(struct lws *wsi);
3876 * lws_rx_flow_control() - Enable and disable socket servicing for
3879 * If the output side of a server process becomes choked, this allows flow
3880 * control for the input side.
3882 * \param wsi: Websocket connection instance to get callback for
3883 * \param enable: 0 = disable read servicing for this connection, 1 = enable
3885 LWS_VISIBLE LWS_EXTERN int
3886 lws_rx_flow_control(struct lws *wsi, int enable);
3889 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
3891 * When the user server code realizes it can accept more input, it can
3892 * call this to have the RX flow restriction removed from all connections using
3893 * the given protocol.
3894 * \param context: lws_context
3895 * \param protocol: all connections using this protocol will be allowed to receive
3897 LWS_VISIBLE LWS_EXTERN void
3898 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3899 const struct lws_protocols *protocol);
3902 * lws_remaining_packet_payload() - Bytes to come before "overall"
3903 * rx packet is complete
3904 * \param wsi: Websocket instance (available from user callback)
3906 * This function is intended to be called from the callback if the
3907 * user code is interested in "complete packets" from the client.
3908 * libwebsockets just passes through payload as it comes and issues a buffer
3909 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
3910 * callback handler can use this API to find out if the buffer it has just
3911 * been given is the last piece of a "complete packet" from the client --
3912 * when that is the case lws_remaining_packet_payload() will return
3915 * Many protocols won't care becuse their packets are always small.
3917 LWS_VISIBLE LWS_EXTERN size_t
3918 lws_remaining_packet_payload(struct lws *wsi);
3921 /** \defgroup sock-adopt Socket adoption helpers
3922 * ##Socket adoption helpers
3924 * When integrating with an external app with its own event loop, these can
3925 * be used to accept connections from someone else's listening socket.
3927 * When using lws own event loop, these are not needed.
3932 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
3933 * for the default vhost of context.
3934 * \param context: lws context
3935 * \param accept_fd: fd of already-accepted socket to adopt
3937 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3938 * returns NULL, having cleaned up any new wsi pieces.
3940 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3941 * to ws or just serve http.
3943 LWS_VISIBLE LWS_EXTERN struct lws *
3944 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3946 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
3948 * \param vhost: lws vhost
3949 * \param accept_fd: fd of already-accepted socket to adopt
3951 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3952 * returns NULL, having cleaned up any new wsi pieces.
3954 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3955 * to ws or just serve http.
3957 LWS_VISIBLE LWS_EXTERN struct lws *
3958 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
3961 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
3962 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
3963 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
3964 LWS_ADOPT_ALLOW_SSL = 4 /* flag: if set requires LWS_ADOPT_SOCKET */
3965 } lws_adoption_type;
3968 lws_sockfd_type sockfd;
3969 lws_filefd_type filefd;
3970 } lws_sock_file_fd_type;
3973 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
3974 * if socket descriptor, should already have been accepted from listen socket
3976 * \param vhost: lws vhost
3977 * \param type: OR-ed combinations of lws_adoption_type flags
3978 * \param fd: union with either .sockfd or .filefd set
3979 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
3980 * \param parent: NULL or struct lws to attach new_wsi to as a child
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 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
3986 * ready to accept an upgrade to ws or just serve http.
3988 * parent may be NULL, if given it should be an existing wsi that will become the
3989 * parent of the new wsi created by this call.
3991 LWS_VISIBLE struct lws *
3992 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
3993 lws_sock_file_fd_type fd, const char *vh_prot_name,
3994 struct lws *parent);
3997 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
3998 * for the default vhost of context.
3999 * \param context: lws context
4000 * \param accept_fd: fd of already-accepted socket to adopt
4001 * \param readbuf: NULL or pointer to data that must be drained before reading from
4003 * \param len: The length of the data held at \param readbuf
4005 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4006 * returns NULL, having cleaned up any new wsi pieces.
4008 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4009 * to ws or just serve http.
4011 * If your external code did not already read from the socket, you can use
4012 * lws_adopt_socket() instead.
4014 * This api is guaranteed to use the data at \param readbuf first, before reading from
4017 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4019 LWS_VISIBLE LWS_EXTERN struct lws *
4020 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
4021 const char *readbuf, size_t len);
4023 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
4024 * accepted it for vhost.
4025 * \param vhost: lws vhost
4026 * \param accept_fd: fd of already-accepted socket to adopt
4027 * \param readbuf: NULL or pointer to data that must be drained before reading from
4029 * \param len: The length of the data held at \param readbuf
4031 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4032 * returns NULL, having cleaned up any new wsi pieces.
4034 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4035 * to ws or just serve http.
4037 * If your external code did not already read from the socket, you can use
4038 * lws_adopt_socket() instead.
4040 * This api is guaranteed to use the data at \param readbuf first, before reading from
4043 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4045 LWS_VISIBLE LWS_EXTERN struct lws *
4046 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
4047 const char *readbuf, size_t len);
4050 /** \defgroup net Network related helper APIs
4051 * ##Network related helper APIs
4053 * These wrap miscellaneous useful network-related functions
4058 * lws_canonical_hostname() - returns this host's hostname
4060 * This is typically used by client code to fill in the host parameter
4061 * when making a client connection. You can only call it after the context
4064 * \param context: Websocket context
4066 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4067 lws_canonical_hostname(struct lws_context *context);
4070 * lws_get_peer_addresses() - Get client address information
4071 * \param wsi: Local struct lws associated with
4072 * \param fd: Connection socket descriptor
4073 * \param name: Buffer to take client address name
4074 * \param name_len: Length of client address name buffer
4075 * \param rip: Buffer to take client address IP dotted quad
4076 * \param rip_len: Length of client address IP buffer
4078 * This function fills in name and rip with the name and IP of
4079 * the client connected with socket descriptor fd. Names may be
4080 * truncated if there is not enough room. If either cannot be
4081 * determined, they will be returned as valid zero-length strings.
4083 LWS_VISIBLE LWS_EXTERN void
4084 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
4085 int name_len, char *rip, int rip_len);
4088 * lws_get_peer_simple() - Get client address information without RDNS
4090 * \param wsi: Local struct lws associated with
4091 * \param name: Buffer to take client address name
4092 * \param namelen: Length of client address name buffer
4094 * This provides a 123.123.123.123 type IP address in name from the
4095 * peer that has connected to wsi
4097 LWS_VISIBLE LWS_EXTERN const char *
4098 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4099 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4101 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4103 * \param ipv6: Allow IPV6 addresses
4104 * \param ifname: Interface name or IP
4105 * \param addr: struct sockaddr_in * to be written
4106 * \param addrlen: Length of addr
4108 * This converts a textual network interface name to a sockaddr usable by
4109 * other network functions
4111 LWS_VISIBLE LWS_EXTERN int
4112 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4117 /** \defgroup misc Miscellaneous APIs
4118 * ##Miscellaneous APIs
4120 * Various APIs outside of other categories
4125 * lws_snprintf(): snprintf that truncates the returned length too
4127 * \param str: destination buffer
4128 * \param size: bytes left in destination buffer
4129 * \param format: format string
4130 * \param ...: args for format
4132 * This lets you correctly truncate buffers by concatenating lengths, if you
4133 * reach the limit the reported length doesn't exceed the limit.
4135 LWS_VISIBLE LWS_EXTERN int
4136 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4139 * lws_get_random(): fill a buffer with platform random data
4141 * \param context: the lws context
4142 * \param buf: buffer to fill
4143 * \param len: how much to fill
4145 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4146 * it's interested to see if the frame it's dealing with was sent in binary
4149 LWS_VISIBLE LWS_EXTERN int
4150 lws_get_random(struct lws_context *context, void *buf, int len);
4152 * lws_daemonize(): make current process run in the background
4154 * \param _lock_path: the filepath to write the lock file
4156 * Spawn lws as a background process, taking care of various things
4158 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4159 lws_daemonize(const char *_lock_path);
4161 * lws_get_library_version(): return string describing the version of lws
4163 * On unix, also includes the git describe
4165 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4166 lws_get_library_version(void);
4169 * lws_wsi_user() - get the user data associated with the connection
4170 * \param wsi: lws connection
4172 * Not normally needed since it's passed into the callback
4174 LWS_VISIBLE LWS_EXTERN void *
4175 lws_wsi_user(struct lws *wsi);
4178 * lws_wsi_set_user() - set the user data associated with the client connection
4179 * \param wsi: lws connection
4180 * \param user: user data
4182 * By default lws allocates this and it's not legal to externally set it
4183 * yourself. However client connections may have it set externally when the
4184 * connection is created... if so, this api can be used to modify it at
4185 * runtime additionally.
4187 LWS_VISIBLE LWS_EXTERN void
4188 lws_set_wsi_user(struct lws *wsi, void *user);
4191 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4192 * Notice it does so by dropping '\0' into input string
4193 * and the leading / on the path is consequently lost
4195 * \param p: incoming uri string.. will get written to
4196 * \param prot: result pointer for protocol part (https://)
4197 * \param ads: result pointer for address part
4198 * \param port: result pointer for port part
4199 * \param path: result pointer for path part
4201 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4202 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4206 * lws_now_secs(): return seconds since 1970-1-1
4208 LWS_VISIBLE LWS_EXTERN unsigned long
4212 * lws_get_context - Allow geting lws_context from a Websocket connection
4215 * With this function, users can access context in the callback function.
4216 * Otherwise users may have to declare context as a global variable.
4218 * \param wsi: Websocket connection instance
4220 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4221 lws_get_context(const struct lws *wsi);
4224 * lws_get_count_threads(): how many service threads the context uses
4226 * \param context: the lws context
4228 * By default this is always 1, if you asked for more than lws can handle it
4229 * will clip the number of threads. So you can use this to find out how many
4230 * threads are actually in use.
4232 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4233 lws_get_count_threads(struct lws_context *context);
4236 * lws_get_parent() - get parent wsi or NULL
4237 * \param wsi: lws connection
4239 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4240 * this allows you to get their parent.
4242 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4243 lws_get_parent(const struct lws *wsi);
4246 * lws_get_child() - get child wsi or NULL
4247 * \param wsi: lws connection
4249 * Allows you to find a related wsi from the parent wsi.
4251 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4252 lws_get_child(const struct lws *wsi);
4256 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4257 * It's provided in case it is
4258 * useful when integrating with other app poll loop service code.
4260 LWS_VISIBLE LWS_EXTERN int
4261 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
4264 * lws_set_allocator() - custom allocator support
4268 * Allows you to replace the allocator (and deallocator) used by lws
4270 LWS_VISIBLE LWS_EXTERN void
4271 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4274 /** \defgroup wsstatus Websocket status APIs
4275 * ##Websocket connection status APIs
4277 * These provide information about ws connection or message status
4281 * lws_send_pipe_choked() - tests if socket is writable or not
4282 * \param wsi: lws connection
4284 * Allows you to check if you can write more on the socket
4286 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4287 lws_send_pipe_choked(struct lws *wsi);
4290 * lws_is_final_fragment() - tests if last part of ws message
4291 * \param wsi: lws connection
4293 LWS_VISIBLE LWS_EXTERN int
4294 lws_is_final_fragment(struct lws *wsi);
4297 * lws_get_reserved_bits() - access reserved bits of ws frame
4298 * \param wsi: lws connection
4300 LWS_VISIBLE LWS_EXTERN unsigned char
4301 lws_get_reserved_bits(struct lws *wsi);
4304 * lws_partial_buffered() - find out if lws buffered the last write
4305 * \param wsi: websocket connection to check
4307 * Returns 1 if you cannot use lws_write because the last
4308 * write on this connection is still buffered, and can't be cleared without
4309 * returning to the service loop and waiting for the connection to be
4312 * If you will try to do >1 lws_write call inside a single
4313 * WRITEABLE callback, you must check this after every write and bail if
4314 * set, ask for a new writeable callback and continue writing from there.
4316 * This is never set at the start of a writeable callback, but any write
4319 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4320 lws_partial_buffered(struct lws *wsi);
4323 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4325 * \param wsi: the connection we are inquiring about
4327 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4328 * it's interested to see if the frame it's dealing with was sent in binary
4331 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4332 lws_frame_is_binary(struct lws *wsi);
4335 * lws_is_ssl() - Find out if connection is using SSL
4336 * \param wsi: websocket connection to check
4338 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4339 * using verified cert, and 2 if using SSL but the cert was not
4340 * checked (appears for client wsi told to skip check on connection)
4342 LWS_VISIBLE LWS_EXTERN int
4343 lws_is_ssl(struct lws *wsi);
4345 * lws_is_cgi() - find out if this wsi is running a cgi process
4346 * \param wsi: lws connection
4348 LWS_VISIBLE LWS_EXTERN int
4349 lws_is_cgi(struct lws *wsi);
4351 #ifdef LWS_OPENSSL_SUPPORT
4353 * lws_get_ssl() - Return wsi's SSL context structure
4354 * \param wsi: websocket connection
4356 * Returns pointer to the SSL library's context structure
4358 LWS_VISIBLE LWS_EXTERN SSL*
4359 lws_get_ssl(struct lws *wsi);
4364 /** \defgroup sha SHA and B64 helpers
4365 * ##SHA and B64 helpers
4367 * These provide SHA-1 and B64 helper apis
4370 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4371 #define lws_SHA1 SHA1
4374 * lws_SHA1(): make a SHA-1 digest of a buffer
4376 * \param d: incoming buffer
4377 * \param n: length of incoming buffer
4378 * \param md: buffer for message digest (must be >= 20 bytes)
4380 * Reduces any size buffer into a 20-byte SHA-1 hash.
4382 LWS_VISIBLE LWS_EXTERN unsigned char *
4383 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4386 * lws_b64_encode_string(): encode a string into base 64
4388 * \param in: incoming buffer
4389 * \param in_len: length of incoming buffer
4390 * \param out: result buffer
4391 * \param out_size: length of result buffer
4393 * Encodes a string using b64
4395 LWS_VISIBLE LWS_EXTERN int
4396 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4398 * lws_b64_decode_string(): decode a string from base 64
4400 * \param in: incoming buffer
4401 * \param out: result buffer
4402 * \param out_size: length of result buffer
4404 * Decodes a string using b64
4406 LWS_VISIBLE LWS_EXTERN int
4407 lws_b64_decode_string(const char *in, char *out, int out_size);
4411 /*! \defgroup cgi cgi handling
4415 * These functions allow low-level control over stdin/out/err of the cgi.
4417 * However for most cases, binding the cgi to http in and out, the default
4418 * lws implementation already does the right thing.
4421 enum lws_enum_stdinouterr {
4427 enum lws_cgi_hdr_state {
4439 struct lws_cgi_args {
4440 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4441 enum lws_enum_stdinouterr ch; /**< channel index */
4442 unsigned char *data; /**< for messages with payload */
4443 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4444 int len; /**< length */
4449 * lws_cgi: spawn network-connected cgi process
4451 * \param wsi: connection to own the process
4452 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4453 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4454 * \param timeout_secs: seconds script should be allowed to run
4455 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4457 LWS_VISIBLE LWS_EXTERN int
4458 lws_cgi(struct lws *wsi, const char * const *exec_array,
4459 int script_uri_path_len, int timeout_secs,
4460 const struct lws_protocol_vhost_options *mp_cgienv);
4463 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4465 * \param wsi: connection to own the process
4467 LWS_VISIBLE LWS_EXTERN int
4468 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4471 * lws_cgi_kill: terminate cgi process associated with wsi
4473 * \param wsi: connection to own the process
4475 LWS_VISIBLE LWS_EXTERN int
4476 lws_cgi_kill(struct lws *wsi);
4481 /*! \defgroup fops file operation wrapping
4483 * ##File operation wrapping
4485 * Use these helper functions if you want to access a file from the perspective
4486 * of a specific wsi, which is usually the case. If you just want contextless
4487 * file access, use the fops callbacks directly with NULL wsi instead of these
4490 * If so, then it calls the platform handler or user overrides where present
4491 * (as defined in info->fops)
4493 * The advantage from all this is user code can be portable for file operations
4494 * without having to deal with differences between platforms.
4498 /** struct lws_plat_file_ops - Platform-specific file operations
4500 * These provide platform-agnostic ways to deal with filesystem access in the
4501 * library and in the user code.
4504 #if defined(LWS_WITH_ESP32)
4505 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4506 #define LWS_FOP_OPEN _open
4507 #define LWS_FOP_CLOSE _close
4508 #define LWS_FOP_SEEK_CUR _seek_cur
4509 #define LWS_FOP_READ _read
4510 #define LWS_FOP_WRITE _write
4512 #define LWS_FOP_OPEN open
4513 #define LWS_FOP_CLOSE close
4514 #define LWS_FOP_SEEK_CUR seek_cur
4515 #define LWS_FOP_READ read
4516 #define LWS_FOP_WRITE write
4519 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4520 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4521 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4522 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4523 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4525 struct lws_plat_file_ops;
4527 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
4529 #if !defined(ssize_t)
4530 typedef SSIZE_T ssize_t;
4534 #if defined(LWS_HAVE_STDINT_H)
4537 #if defined(WIN32) || defined(_WIN32)
4539 typedef unsigned __int32 uint32_t;
4540 typedef unsigned __int16 uint16_t;
4541 typedef unsigned __int8 uint8_t;
4543 typedef unsigned int uint32_t;
4544 typedef unsigned short uint16_t;
4545 typedef unsigned char uint8_t;
4549 typedef size_t lws_filepos_t;
4550 typedef ssize_t lws_fileofs_t;
4551 typedef uint32_t lws_fop_flags_t;
4555 /**< real file descriptor related to the file... */
4556 const struct lws_plat_file_ops *fops;
4557 /**< fops that apply to this fop_fd */
4558 void *filesystem_priv;
4559 /**< ignored by lws; owned by the fops handlers */
4561 /**< generic "position in file" */
4563 /**< generic "length of file" */
4564 lws_fop_flags_t flags;
4565 /**< copy of the returned flags */
4567 /**< optional "modification time of file", only valid if .open()
4568 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4570 typedef struct lws_fop_fd *lws_fop_fd_t;
4572 struct lws_fops_index {
4573 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4574 uint8_t len; /* length of above string */
4577 struct lws_plat_file_ops {
4578 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4579 const char *filename, const char *vpath,
4580 lws_fop_flags_t *flags);
4581 /**< Open file (always binary access if plat supports it)
4582 * vpath may be NULL, or if the fops understands it, the point at which
4583 * the filename's virtual part starts.
4584 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4585 * If the file may be gzip-compressed,
4586 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4587 * gzip-compressed, then the open handler should OR
4588 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4590 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4591 /**< close file AND set the pointer to NULL */
4592 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4593 lws_fileofs_t offset_from_cur_pos);
4594 /**< seek from current position */
4595 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4596 uint8_t *buf, lws_filepos_t len);
4597 /**< Read from file, on exit *amount is set to amount actually read */
4598 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4599 uint8_t *buf, lws_filepos_t len);
4600 /**< Write to file, on exit *amount is set to amount actually written */
4602 struct lws_fops_index fi[3];
4603 /**< vfs path signatures implying use of this fops */
4605 const struct lws_plat_file_ops *next;
4606 /**< NULL or next fops in list */
4608 /* Add new things just above here ---^
4609 * This is part of the ABI, don't needlessly break compatibility */
4613 * lws_get_fops() - get current file ops
4615 * \param context: context
4617 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4618 lws_get_fops(struct lws_context *context);
4619 LWS_VISIBLE LWS_EXTERN void
4620 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4622 * lws_vfs_tell() - get current file position
4624 * \param fop_fd: fop_fd we are asking about
4626 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4627 lws_vfs_tell(lws_fop_fd_t fop_fd);
4629 * lws_vfs_get_length() - get current file total length in bytes
4631 * \param fop_fd: fop_fd we are asking about
4633 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4634 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4636 * lws_vfs_get_mod_time() - get time file last modified
4638 * \param fop_fd: fop_fd we are asking about
4640 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4641 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4643 * lws_vfs_file_seek_set() - seek relative to start of file
4645 * \param fop_fd: fop_fd we are seeking in
4646 * \param offset: offset from start of file
4648 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4649 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4651 * lws_vfs_file_seek_end() - seek relative to end of file
4653 * \param fop_fd: fop_fd we are seeking in
4654 * \param offset: offset from start of file
4656 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4657 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4659 extern struct lws_plat_file_ops fops_zip;
4662 * lws_plat_file_open() - open vfs filepath
4664 * \param fops: file ops struct that applies to this descriptor
4665 * \param vfs_path: filename to open
4666 * \param flags: pointer to open flags
4668 * The vfs_path is scanned for known fops signatures, and the open directed
4669 * to any matching fops open.
4671 * User code should use this api to perform vfs opens.
4673 * returns semi-opaque handle
4675 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4676 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4677 lws_fop_flags_t *flags);
4680 * lws_plat_file_close() - close file
4682 * \param fop_fd: file handle to close
4684 static LWS_INLINE int
4685 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4687 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4691 * lws_plat_file_seek_cur() - close file
4694 * \param fop_fd: file handle
4695 * \param offset: position to seek to
4697 static LWS_INLINE lws_fileofs_t
4698 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4700 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4703 * lws_plat_file_read() - read from file
4705 * \param fop_fd: file handle
4706 * \param amount: how much to read (rewritten by call)
4707 * \param buf: buffer to write to
4708 * \param len: max length
4710 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4711 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4712 uint8_t *buf, lws_filepos_t len)
4714 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4717 * lws_plat_file_write() - write from file
4719 * \param fop_fd: file handle
4720 * \param amount: how much to write (rewritten by call)
4721 * \param buf: buffer to read from
4722 * \param len: max length
4724 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4725 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4726 uint8_t *buf, lws_filepos_t len)
4728 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4731 /* these are the platform file operations implementations... they can
4732 * be called directly and used in fops arrays
4735 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4736 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4737 const char *vpath, lws_fop_flags_t *flags);
4738 LWS_VISIBLE LWS_EXTERN int
4739 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4740 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4741 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4742 LWS_VISIBLE LWS_EXTERN int
4743 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4744 uint8_t *buf, lws_filepos_t len);
4745 LWS_VISIBLE LWS_EXTERN int
4746 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4747 uint8_t *buf, lws_filepos_t len);
4749 LWS_VISIBLE LWS_EXTERN int
4750 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4751 lws_filepos_t *amount);
4756 * ##SMTP related functions
4758 * These apis let you communicate with a local SMTP server to send email from
4759 * lws. It handles all the SMTP sequencing and protocol actions.
4761 * Your system should have postfix, sendmail or another MTA listening on port
4762 * 25 and able to send email using the "mail" commandline app. Usually distro
4763 * MTAs are configured for this by default.
4765 * It runs via its own libuv events if initialized (which requires giving it
4766 * a libuv loop to attach to).
4768 * It operates using three callbacks, on_next() queries if there is a new email
4769 * to send, on_get_body() asks for the body of the email, and on_sent() is
4770 * called after the email is successfully sent.
4774 * - create an lws_email struct
4776 * - initialize data, loop, the email_* strings, max_content_size and
4779 * - call lws_email_init()
4781 * When you have at least one email to send, call lws_email_check() to
4782 * schedule starting to send it.
4785 #ifdef LWS_WITH_SMTP
4787 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
4788 enum lwsgs_smtp_states {
4789 LGSSMTP_IDLE, /**< awaiting new email */
4790 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
4791 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
4792 LGSSMTP_SENT_HELO, /**< sent the HELO */
4793 LGSSMTP_SENT_FROM, /**< sent FROM */
4794 LGSSMTP_SENT_TO, /**< sent TO */
4795 LGSSMTP_SENT_DATA, /**< sent DATA request */
4796 LGSSMTP_SENT_BODY, /**< sent the email body */
4797 LGSSMTP_SENT_QUIT, /**< sent the session quit */
4800 /** struct lws_email - abstract context for performing SMTP operations */
4803 /**< opaque pointer set by user code and available to the callbacks */
4805 /**< the libuv loop we will work on */
4807 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
4808 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
4809 char email_from[100]; /**< Fill before init or on_next */
4810 char email_to[100]; /**< Fill before init or on_next */
4812 unsigned int max_content_size;
4813 /**< largest possible email body size */
4815 /* Fill all the callbacks before init */
4817 int (*on_next)(struct lws_email *email);
4818 /**< (Fill in before calling lws_email_init)
4819 * called when idle, 0 = another email to send, nonzero is idle.
4820 * If you return 0, all of the email_* char arrays must be set
4821 * to something useful. */
4822 int (*on_sent)(struct lws_email *email);
4823 /**< (Fill in before calling lws_email_init)
4824 * called when transfer of the email to the SMTP server was
4825 * successful, your callback would remove the current email
4827 int (*on_get_body)(struct lws_email *email, char *buf, int len);
4828 /**< (Fill in before calling lws_email_init)
4829 * called when the body part of the queued email is about to be
4830 * sent to the SMTP server. */
4833 /* private things */
4834 uv_timer_t timeout_email; /**< private */
4835 enum lwsgs_smtp_states estate; /**< private */
4836 uv_connect_t email_connect_req; /**< private */
4837 uv_tcp_t email_client; /**< private */
4838 time_t email_connect_started; /**< private */
4839 char email_buf[256]; /**< private */
4840 char *content; /**< private */
4844 * lws_email_init() - Initialize a struct lws_email
4846 * \param email: struct lws_email to init
4847 * \param loop: libuv loop to use
4848 * \param max_content: max email content size
4850 * Prepares a struct lws_email for use ending SMTP
4852 LWS_VISIBLE LWS_EXTERN int
4853 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4856 * lws_email_check() - Request check for new email
4858 * \param email: struct lws_email context to check
4860 * Schedules a check for new emails in 1s... call this when you have queued an
4863 LWS_VISIBLE LWS_EXTERN void
4864 lws_email_check(struct lws_email *email);
4866 * lws_email_destroy() - stop using the struct lws_email
4868 * \param email: the struct lws_email context
4870 * Stop sending email using email and free allocations
4872 LWS_VISIBLE LWS_EXTERN void
4873 lws_email_destroy(struct lws_email *email);
4879 * Stats are all uint64_t numbers that start at 0.
4880 * Index names here have the convention
4884 * _MS_ millisecond count
4888 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
4889 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
4890 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
4891 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
4892 LWSSTATS_C_API_WRITE, /**< count calls to write API */
4893 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
4894 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
4895 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
4896 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
4897 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
4898 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
4899 LWSSTATS_C_SSL_CONNS_HAD_RX, /**< count of accepted SSL conns that have had some RX */
4900 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
4901 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
4902 LWSSTATS_B_READ, /**< aggregate bytes read */
4903 LWSSTATS_B_WRITE, /**< aggregate bytes written */
4904 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
4905 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
4906 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
4907 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
4908 LWSSTATS_MS_SSL_RX_DELAY, /**< aggregate delay between ssl accept complete and first RX */
4910 /* Add new things just above here ---^
4911 * This is part of the ABI, don't needlessly break compatibility */
4915 #if defined(LWS_WITH_STATS)
4917 LWS_VISIBLE LWS_EXTERN uint64_t
4918 lws_stats_get(struct lws_context *context, int index);
4919 LWS_VISIBLE LWS_EXTERN void
4920 lws_stats_log_dump(struct lws_context *context);
4922 static LWS_INLINE uint64_t
4923 lws_stats_get(struct lws_context *context, int index) { return 0; }
4924 static LWS_INLINE void
4925 lws_stats_log_dump(struct lws_context *context) { }
projects / platform / upstream / libwebsockets.git / blob