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 #include "lws_config.h"
39 * CARE: everything using cmake defines needs to be below here
42 #if defined(LWS_WITH_ESP8266)
49 #if defined(LWS_HAS_INTPTR_T)
51 #define lws_intptr_t intptr_t
53 typedef unsigned long long lws_intptr_t;
56 #if defined(WIN32) || defined(_WIN32)
57 #ifndef WIN32_LEAN_AND_MEAN
58 #define WIN32_LEAN_AND_MEAN
68 #define _O_RDONLY 0x0000
69 #define O_RDONLY _O_RDONLY
72 // Visual studio older than 2015 and WIN_CE has only _stricmp
73 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
74 #define strcasecmp _stricmp
75 #elif !defined(__MINGW32__)
76 #define strcasecmp stricmp
78 #define getdtablesize() 30000
80 #define LWS_INLINE __inline
82 #define LWS_WARN_UNUSED_RESULT
83 #define LWS_WARN_DEPRECATED
84 #define LWS_FORMAT(string_index)
88 #define LWS_EXTERN extern __declspec(dllexport)
90 #define LWS_EXTERN extern __declspec(dllimport)
96 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
97 #define LWS_O_RDONLY _O_RDONLY
98 #define LWS_O_WRONLY _O_WRONLY
99 #define LWS_O_CREAT _O_CREAT
100 #define LWS_O_TRUNC _O_TRUNC
102 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
103 #define lws_snprintf _snprintf
107 #define __func__ __FUNCTION__
110 #if !defined(__MINGW32__) &&(!defined(_MSC_VER) || _MSC_VER < 1900) && !defined(snprintf)
111 #define snprintf(buf,len, format,...) _snprintf_s(buf, len,len, format, __VA_ARGS__)
114 #else /* NOT WIN32 */
116 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
117 #include <sys/capability.h>
120 #if defined(__NetBSD__) || defined(__FreeBSD__)
121 #include <netinet/in.h>
124 #define LWS_INLINE inline
125 #define LWS_O_RDONLY O_RDONLY
126 #define LWS_O_WRONLY O_WRONLY
127 #define LWS_O_CREAT O_CREAT
128 #define LWS_O_TRUNC O_TRUNC
130 #if !defined(LWS_WITH_ESP8266) && !defined(OPTEE_TA) && !defined(LWS_WITH_ESP32)
133 #define LWS_INVALID_FILE -1
135 #define getdtablesize() (30)
136 #if defined(LWS_WITH_ESP32)
137 #define LWS_INVALID_FILE NULL
139 #define LWS_INVALID_FILE NULL
143 #if defined(__GNUC__)
145 /* warn_unused_result attribute only supported by GCC 3.4 or later */
146 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
147 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
149 #define LWS_WARN_UNUSED_RESULT
152 #define LWS_VISIBLE __attribute__((visibility("default")))
153 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
154 #define LWS_FORMAT(string_index) __attribute__ ((format(printf, string_index, string_index+1)))
157 #define LWS_WARN_UNUSED_RESULT
158 #define LWS_WARN_DEPRECATED
159 #define LWS_FORMAT(string_index)
162 #if defined(__ANDROID__)
164 #define getdtablesize() sysconf(_SC_OPEN_MAX)
171 #endif /* LWS_USE_LIBEV */
174 #ifdef LWS_HAVE_UV_VERSION_H
175 #include <uv-version.h>
177 #endif /* LWS_USE_LIBUV */
178 #ifdef LWS_USE_LIBEVENT
179 #include <event2/event.h>
180 #endif /* LWS_USE_LIBEVENT */
183 #define LWS_EXTERN extern
189 #if !defined(OPTEE_TA)
190 #include <sys/time.h>
195 #ifdef LWS_OPENSSL_SUPPORT
198 #ifdef USE_OLD_CYASSL
199 #include <cyassl/openssl/ssl.h>
200 #include <cyassl/error-ssl.h>
202 #include <wolfssl/openssl/ssl.h>
203 #include <wolfssl/error-ssl.h>
204 #endif /* not USE_OLD_CYASSL */
206 #include <openssl/ssl.h>
207 #if !defined(LWS_WITH_ESP32)
208 #include <openssl/err.h>
210 #endif /* not USE_WOLFSSL */
214 #define CONTEXT_PORT_NO_LISTEN -1
215 #define CONTEXT_PORT_NO_LISTEN_SERVER -2
217 /** \defgroup log Logging
221 * Lws provides flexible and filterable logging facilities, which can be
222 * used inside lws and in user code.
224 * Log categories may be individually filtered bitwise, and directed to built-in
225 * sinks for syslog-compatible logging, or a user-defined function.
229 enum lws_log_levels {
239 LLL_LATENCY = 1 << 9,
242 LLL_COUNT = 11 /* set to count of valid flags */
245 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...) LWS_FORMAT(2);
246 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
248 * lwsl_timestamp: generate logging timestamp string
250 * \param level: logging level
251 * \param p: char * buffer to take timestamp
252 * \param len: length of p
254 * returns length written in p
256 LWS_VISIBLE LWS_EXTERN int
257 lwsl_timestamp(int level, char *p, int len);
259 /* these guys are unconditionally included */
261 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
262 #define lwsl_user(...) _lws_log(LLL_USER, __VA_ARGS__)
264 #if !defined(LWS_WITH_NO_LOGS)
265 /* notice and warn are usually included by being compiled in */
266 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
267 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
270 * weaker logging can be deselected by telling CMake to build in RELEASE mode
271 * that gets rid of the overhead of checking while keeping _warn and _err
275 #if defined(LWS_WITH_ESP8266)
280 #if defined(LWS_WITH_NO_LOGS)
281 /* notice, warn and log are always compiled in */
282 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
283 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
285 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
286 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
287 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
288 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
289 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
290 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
291 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
293 * lwsl_hexdump() - helper to hexdump a buffer (DEBUG builds only)
295 * \param buf: buffer start to dump
296 * \param len: length of buffer to dump
298 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
301 #if defined(LWS_WITH_NO_LOGS)
302 #define lwsl_warn(...) do {} while(0)
303 #define lwsl_notice(...) do {} while(0)
305 #define lwsl_info(...) do {} while(0)
306 #define lwsl_debug(...) do {} while(0)
307 #define lwsl_parser(...) do {} while(0)
308 #define lwsl_header(...) do {} while(0)
309 #define lwsl_ext(...) do {} while(0)
310 #define lwsl_client(...) do {} while(0)
311 #define lwsl_latency(...) do {} while(0)
312 #define lwsl_hexdump(a, b)
316 static LWS_INLINE int lws_is_be(void) {
317 const int probe = ~0xff;
319 return *(const char *)&probe;
323 * lws_set_log_level() - Set the logging bitfield
324 * \param level: OR together the LLL_ debug contexts you want output from
325 * \param log_emit_function: NULL to leave it as it is, or a user-supplied
326 * function to perform log string emission instead of
327 * the default stderr one.
329 * log level defaults to "err", "warn" and "notice" contexts enabled and
330 * emission on stderr.
332 LWS_VISIBLE LWS_EXTERN void
333 lws_set_log_level(int level,
334 void (*log_emit_function)(int level, const char *line));
337 * lwsl_emit_syslog() - helper log emit function writes to system log
339 * \param level: one of LLL_ log level indexes
340 * \param line: log string
342 * You use this by passing the function pointer to lws_set_log_level(), to set
343 * it as the log emit function, it is not called directly.
345 LWS_VISIBLE LWS_EXTERN void
346 lwsl_emit_syslog(int level, const char *line);
349 * lwsl_visible() - returns true if the log level should be printed
351 * \param level: one of LLL_ log level indexes
353 * This is useful if you have to do work to generate the log content, you
354 * can skip the work if the log level used to print it is not actually
355 * enabled at runtime.
357 LWS_VISIBLE LWS_EXTERN int
358 lwsl_visible(int level);
365 #ifndef lws_container_of
366 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
372 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
375 /* api change list for user code to test against */
377 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
379 /* the struct lws_protocols has the id field present */
380 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
382 /* you can call lws_get_peer_write_allowance */
383 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
385 /* extra parameter introduced in 917f43ab821 */
386 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
388 /* File operations stuff exists */
389 #define LWS_FEATURE_FOPS
393 typedef SOCKET lws_sockfd_type;
394 typedef HANDLE lws_filefd_type;
395 #define lws_sockfd_valid(sfd) (!!sfd)
397 lws_sockfd_type fd; /**< file descriptor */
398 SHORT events; /**< which events to respond to */
399 SHORT revents; /**< which events happened */
401 #define LWS_POLLHUP (FD_CLOSE)
402 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
403 #define LWS_POLLOUT (FD_WRITE)
407 #if defined(LWS_WITH_ESP8266)
409 #include <user_interface.h>
412 typedef struct espconn * lws_sockfd_type;
413 typedef void * lws_filefd_type;
414 #define lws_sockfd_valid(sfd) (!!sfd)
416 lws_sockfd_type fd; /**< fd related to */
417 short events; /**< which POLL... events to respond to */
418 short revents; /**< which POLL... events occurred */
420 #define POLLIN 0x0001
421 #define POLLPRI 0x0002
422 #define POLLOUT 0x0004
423 #define POLLERR 0x0008
424 #define POLLHUP 0x0010
425 #define POLLNVAL 0x0020
429 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
430 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
436 int ets_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
437 #define snprintf ets_snprintf
439 typedef os_timer_t uv_timer_t;
440 typedef void uv_cb_t(uv_timer_t *);
442 void os_timer_disarm(void *);
443 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
445 void ets_timer_arm_new(os_timer_t *, int, int, int);
447 //void os_timer_arm(os_timer_t *, int, int);
449 #define UV_VERSION_MAJOR 1
451 #define lws_uv_getloop(a, b) (NULL)
453 static inline void uv_timer_init(void *l, uv_timer_t *t)
456 memset(t, 0, sizeof(*t));
460 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
462 os_timer_setfn(t, (os_timer_func_t *)cb, t);
464 os_timer_arm(t, first, !!rep);
467 static inline void uv_timer_stop(uv_timer_t *t)
473 #if defined(LWS_WITH_ESP32)
475 typedef int lws_sockfd_type;
476 typedef int lws_filefd_type;
477 #define lws_sockfd_valid(sfd) (sfd >= 0)
479 lws_sockfd_type fd; /**< fd related to */
480 short events; /**< which POLL... events to respond to */
481 short revents; /**< which POLL... events occurred */
483 #define POLLIN 0x0001
484 #define POLLPRI 0x0002
485 #define POLLOUT 0x0004
486 #define POLLERR 0x0008
487 #define POLLHUP 0x0010
488 #define POLLNVAL 0x0020
490 #include <freertos/FreeRTOS.h>
491 #include <freertos/event_groups.h>
493 #include "esp_wifi.h"
494 #include "esp_system.h"
495 #include "esp_event.h"
496 #include "esp_event_loop.h"
498 #include "driver/gpio.h"
499 #include "esp_spi_flash.h"
500 #include "freertos/timers.h"
502 #if !defined(CONFIG_FREERTOS_HZ)
503 #define CONFIG_FREERTOS_HZ 100
506 typedef TimerHandle_t uv_timer_t;
507 typedef void uv_cb_t(uv_timer_t *);
508 typedef void * uv_handle_t;
510 struct timer_mapping {
515 #define UV_VERSION_MAJOR 1
517 #define lws_uv_getloop(a, b) (NULL)
519 static inline void uv_timer_init(void *l, uv_timer_t *t)
525 extern void esp32_uvtimer_cb(TimerHandle_t t);
527 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
529 struct timer_mapping *tm = (struct timer_mapping *)malloc(sizeof(*tm));
537 *t = xTimerCreate("x", pdMS_TO_TICKS(first), !!rep, tm,
538 (TimerCallbackFunction_t)esp32_uvtimer_cb);
542 static inline void uv_timer_stop(uv_timer_t *t)
547 static inline void uv_close(uv_handle_t *h, void *v)
549 free(pvTimerGetTimerID((uv_timer_t)h));
550 xTimerDelete(*(uv_timer_t *)h, 0);
553 /* ESP32 helper declarations */
556 #include <esp_partition.h>
558 #define LWS_PLUGIN_STATIC
559 #define LWS_MAGIC_REBOOT_TYPE_ADS 0x50001ffc
560 #define LWS_MAGIC_REBOOT_TYPE_REQ_FACTORY 0xb00bcafe
561 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY 0xfaceb00b
562 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY_BUTTON 0xf0cedfac
565 /* user code provides these */
568 lws_esp32_identify_physical_device(void);
570 /* lws-plat-esp32 provides these */
572 typedef void (*lws_cb_scan_done)(uint16_t count, wifi_ap_record_t *recs, void *arg);
575 LWSESP32_GENLED__INIT,
576 LWSESP32_GENLED__LOST_NETWORK,
577 LWSESP32_GENLED__NO_NETWORK,
578 LWSESP32_GENLED__CONN_AP,
579 LWSESP32_GENLED__GOT_IP,
583 struct lws_group_member {
584 struct lws_group_member *next;
591 struct ip4_addr addr;
592 struct ip6_addr addrv6;
596 #define LWS_SYSTEM_GROUP_MEMBER_ADD 1
597 #define LWS_SYSTEM_GROUP_MEMBER_CHANGE 2
598 #define LWS_SYSTEM_GROUP_MEMBER_REMOVE 3
600 #define LWS_GROUP_FLAG_SELF 1
612 char password[4][32];
613 char active_ssid[32];
622 enum genled_state genled;
625 lws_cb_scan_done scan_consumer;
626 void *scan_consumer_arg;
627 struct lws_group_member *first;
628 int extant_group_members;
631 struct lws_esp32_image {
638 extern struct lws_esp32 lws_esp32;
641 lws_esp32_event_passthru(void *ctx, system_event_t *event);
643 lws_esp32_wlan_config(void);
645 lws_esp32_wlan_start_ap(void);
647 lws_esp32_wlan_start_station(void);
648 struct lws_context_creation_info;
650 lws_esp32_set_creation_defaults(struct lws_context_creation_info *info);
651 extern struct lws_context *
652 lws_esp32_init(struct lws_context_creation_info *);
654 lws_esp32_wlan_nvs_get(int retry);
656 lws_nvs_set_str(nvs_handle handle, const char* key, const char* value);
658 lws_esp32_restart_guided(uint32_t type);
659 extern const esp_partition_t *
660 lws_esp_ota_get_boot_partition(void);
662 lws_esp32_get_image_info(const esp_partition_t *part, struct lws_esp32_image *i, char *json, int json_len);
664 lws_esp32_leds_network_indication(void);
666 extern uint32_t lws_esp32_get_reboot_type(void);
667 extern uint16_t lws_esp32_sine_interp(int n);
669 /* required in external code by esp32 plat (may just return if no leds) */
670 extern void lws_esp32_leds_timer_cb(TimerHandle_t th);
672 typedef int lws_sockfd_type;
673 typedef int lws_filefd_type;
674 #define lws_sockfd_valid(sfd) (sfd >= 0)
678 #define lws_pollfd pollfd
679 #define LWS_POLLHUP (POLLHUP|POLLERR)
680 #define LWS_POLLIN (POLLIN)
681 #define LWS_POLLOUT (POLLOUT)
685 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
687 #define ssize_t SSIZE_T
690 #if defined(WIN32) && defined(LWS_HAVE__STAT32I64)
691 #include <sys/types.h>
692 #include <sys/stat.h>
695 #if defined(LWS_HAVE_STDINT_H)
698 #if defined(WIN32) || defined(_WIN32)
700 typedef unsigned __int32 uint32_t;
701 typedef unsigned __int16 uint16_t;
702 typedef unsigned __int8 uint8_t;
704 typedef unsigned int uint32_t;
705 typedef unsigned short uint16_t;
706 typedef unsigned char uint8_t;
710 typedef unsigned long long lws_filepos_t;
711 typedef long long lws_fileofs_t;
712 typedef uint32_t lws_fop_flags_t;
714 /** struct lws_pollargs - argument structure for all external poll related calls
715 * passed in via 'in' */
716 struct lws_pollargs {
717 lws_sockfd_type fd; /**< applicable socket descriptor */
718 int events; /**< the new event mask */
719 int prev_events; /**< the previous event mask */
723 struct lws_token_limits;
725 /*! \defgroup wsclose Websocket Close
727 * ##Websocket close frame control
729 * When we close a ws connection, we can send a reason code and a short
730 * UTF-8 description back with the close packet.
735 * NOTE: These public enums are part of the abi. If you want to add one,
736 * add it at where specified so existing users are unaffected.
738 /** enum lws_close_status - RFC6455 close status codes */
739 enum lws_close_status {
740 LWS_CLOSE_STATUS_NOSTATUS = 0,
741 LWS_CLOSE_STATUS_NORMAL = 1000,
742 /**< 1000 indicates a normal closure, meaning that the purpose for
743 which the connection was established has been fulfilled. */
744 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
745 /**< 1001 indicates that an endpoint is "going away", such as a server
746 going down or a browser having navigated away from a page. */
747 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
748 /**< 1002 indicates that an endpoint is terminating the connection due
749 to a protocol error. */
750 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
751 /**< 1003 indicates that an endpoint is terminating the connection
752 because it has received a type of data it cannot accept (e.g., an
753 endpoint that understands only text data MAY send this if it
754 receives a binary message). */
755 LWS_CLOSE_STATUS_RESERVED = 1004,
756 /**< Reserved. The specific meaning might be defined in the future. */
757 LWS_CLOSE_STATUS_NO_STATUS = 1005,
758 /**< 1005 is a reserved value and MUST NOT be set as a status code in a
759 Close control frame by an endpoint. It is designated for use in
760 applications expecting a status code to indicate that no status
761 code was actually present. */
762 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
763 /**< 1006 is a reserved value and MUST NOT be set as a status code in a
764 Close control frame by an endpoint. It is designated for use in
765 applications expecting a status code to indicate that the
766 connection was closed abnormally, e.g., without sending or
767 receiving a Close control frame. */
768 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
769 /**< 1007 indicates that an endpoint is terminating the connection
770 because it has received data within a message that was not
771 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
772 data within a text message). */
773 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
774 /**< 1008 indicates that an endpoint is terminating the connection
775 because it has received a message that violates its policy. This
776 is a generic status code that can be returned when there is no
777 other more suitable status code (e.g., 1003 or 1009) or if there
778 is a need to hide specific details about the policy. */
779 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
780 /**< 1009 indicates that an endpoint is terminating the connection
781 because it has received a message that is too big for it to
783 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
784 /**< 1010 indicates that an endpoint (client) is terminating the
785 connection because it has expected the server to negotiate one or
786 more extension, but the server didn't return them in the response
787 message of the WebSocket handshake. The list of extensions that
788 are needed SHOULD appear in the /reason/ part of the Close frame.
789 Note that this status code is not used by the server, because it
790 can fail the WebSocket handshake instead */
791 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
792 /**< 1011 indicates that a server is terminating the connection because
793 it encountered an unexpected condition that prevented it from
794 fulfilling the request. */
795 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
796 /**< 1015 is a reserved value and MUST NOT be set as a status code in a
797 Close control frame by an endpoint. It is designated for use in
798 applications expecting a status code to indicate that the
799 connection was closed due to a failure to perform a TLS handshake
800 (e.g., the server certificate can't be verified). */
802 /****** add new things just above ---^ ******/
804 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
808 * lws_close_reason - Set reason and aux data to send with Close packet
809 * If you are going to return nonzero from the callback
810 * requesting the connection to close, you can optionally
811 * call this to set the reason the peer will be told if
814 * \param wsi: The websocket connection to set the close reason on
815 * \param status: A valid close status from websocket standard
816 * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data
817 * \param len: Length of data in \param buf to send
819 LWS_VISIBLE LWS_EXTERN void
820 lws_close_reason(struct lws *wsi, enum lws_close_status status,
821 unsigned char *buf, size_t len);
827 /* needed even with extensions disabled for create context */
828 struct lws_extension;
830 /*! \defgroup lwsmeta lws-meta
832 * ##lws-meta protocol
834 * The protocol wraps other muxed connections inside one tcp connection.
836 * Commands are assigned from 0x41 up (so they are valid unicode)
840 enum lws_meta_commands {
841 LWS_META_CMD_OPEN_SUBCHANNEL = 'A',
842 /**< Client requests to open new subchannel
844 LWS_META_CMD_OPEN_RESULT,
845 /**< Result of client request to open new subchannel */
846 LWS_META_CMD_CLOSE_NOTIFY,
847 /**< Notification of subchannel closure */
848 LWS_META_CMD_CLOSE_RQ,
849 /**< client requests to close a subchannel */
851 /**< connection writes something to specific channel index */
853 /****** add new things just above ---^ ******/
856 /* channel numbers are transported offset by 0x20 so they are valid unicode */
858 #define LWS_META_TRANSPORT_OFFSET 0x20
862 /*! \defgroup usercb User Callback
864 * ##User protocol callback
866 * The protocol callback is the primary way lws interacts with
867 * user code. For one of a list of a few dozen reasons the callback gets
868 * called at some event to be handled.
870 * All of the events can be ignored, returning 0 is taken as "OK" and returning
871 * nonzero in most cases indicates that the connection should be closed.
875 struct lws_ssl_info {
881 * NOTE: These public enums are part of the abi. If you want to add one,
882 * add it at where specified so existing users are unaffected.
884 /** enum lws_callback_reasons - reason you're getting a protocol callback */
885 enum lws_callback_reasons {
886 LWS_CALLBACK_ESTABLISHED = 0,
887 /**< (VH) after the server completes a handshake with an incoming
888 * client. If you built the library with ssl support, in is a
889 * pointer to the ssl struct associated with the connection or NULL.*/
890 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
891 /**< the request client connection has been unable to complete a
892 * handshake with the remote server. If in is non-NULL, you can
893 * find an error string of length len where it points to
895 * Diagnostic strings that may be returned include
897 * "getaddrinfo (ipv6) failed"
898 * "unknown address family"
899 * "getaddrinfo (ipv4) failed"
900 * "set socket opts failed"
901 * "insert wsi failed"
902 * "lws_ssl_client_connect1 failed"
903 * "lws_ssl_client_connect2 failed"
907 * "HS: Redirect code but no Location"
908 * "HS: URI did not parse"
909 * "HS: Redirect failed"
910 * "HS: Server did not return 200"
912 * "HS: disallowed by client filter"
913 * "HS: disallowed at ESTABLISHED"
914 * "HS: ACCEPT missing"
915 * "HS: ws upgrade response not 101"
916 * "HS: UPGRADE missing"
917 * "HS: Upgrade to something other than websocket"
918 * "HS: CONNECTION missing"
919 * "HS: UPGRADE malformed"
920 * "HS: PROTOCOL malformed"
921 * "HS: Cannot match protocol"
922 * "HS: EXT: list too big"
923 * "HS: EXT: failed setting defaults"
924 * "HS: EXT: failed parsing defaults"
925 * "HS: EXT: failed parsing options"
926 * "HS: EXT: Rejects server options"
927 * "HS: EXT: unknown ext"
928 * "HS: Accept hash wrong"
929 * "HS: Rejected by filter cb"
931 * "HS: SO_SNDBUF failed"
932 * "HS: Rejected at CLIENT_ESTABLISHED"
934 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
935 /**< this is the last chance for the client user code to examine the
936 * http headers and decide to reject the connection. If the
937 * content in the headers is interesting to the
938 * client (url, etc) it needs to copy it out at
939 * this point since it will be destroyed before
940 * the CLIENT_ESTABLISHED call */
941 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
942 /**< after your client connection completed
943 * a handshake with the remote server */
944 LWS_CALLBACK_CLOSED = 4,
945 /**< when the websocket session ends */
946 LWS_CALLBACK_CLOSED_HTTP = 5,
947 /**< when a HTTP (non-websocket) session ends */
948 LWS_CALLBACK_RECEIVE = 6,
949 /**< data has appeared for this server endpoint from a
950 * remote client, it can be found at *in and is
952 LWS_CALLBACK_RECEIVE_PONG = 7,
953 /**< servers receive PONG packets with this callback reason */
954 LWS_CALLBACK_CLIENT_RECEIVE = 8,
955 /**< data has appeared from the server for the client connection, it
956 * can be found at *in and is len bytes long */
957 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
958 /**< clients receive PONG packets with this callback reason */
959 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
960 /**< If you call lws_callback_on_writable() on a connection, you will
961 * get one of these callbacks coming when the connection socket
962 * is able to accept another write packet without blocking.
963 * If it already was able to take another packet without blocking,
964 * you'll get this callback at the next call to the service loop
965 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
966 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
967 LWS_CALLBACK_SERVER_WRITEABLE = 11,
968 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
969 LWS_CALLBACK_HTTP = 12,
970 /**< an http request has come from a client that is not
971 * asking to upgrade the connection to a websocket
972 * one. This is a chance to serve http content,
973 * for example, to send a script to the client
974 * which will then open the websockets connection.
975 * in points to the URI path requested and
976 * lws_serve_http_file() makes it very
977 * simple to send back a file to the client.
978 * Normally after sending the file you are done
979 * with the http connection, since the rest of the
980 * activity will come by websockets from the script
981 * that was delivered by http, so you will want to
982 * return 1; to close and free up the connection. */
983 LWS_CALLBACK_HTTP_BODY = 13,
984 /**< the next len bytes data from the http
985 * request body HTTP connection is now available in in. */
986 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
987 /**< the expected amount of http request body has been delivered */
988 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
989 /**< a file requested to be sent down http link has completed. */
990 LWS_CALLBACK_HTTP_WRITEABLE = 16,
991 /**< you can write more down the http protocol link now. */
992 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
993 /**< called when a client connects to
994 * the server at network level; the connection is accepted but then
995 * passed to this callback to decide whether to hang up immediately
996 * or not, based on the client IP. in contains the connection
997 * socket's descriptor. Since the client connection information is
998 * not available yet, wsi still pointing to the main server socket.
999 * Return non-zero to terminate the connection before sending or
1000 * receiving anything. Because this happens immediately after the
1001 * network connection from the client, there's no websocket protocol
1002 * selected yet so this callback is issued only to protocol 0. */
1003 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
1004 /**< called when the request has
1005 * been received and parsed from the client, but the response is
1006 * not sent yet. Return non-zero to disallow the connection.
1007 * user is a pointer to the connection user space allocation,
1008 * in is the URI, eg, "/"
1009 * In your handler you can use the public APIs
1010 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
1011 * headers using the header enums lws_token_indexes from
1012 * libwebsockets.h to check for and read the supported header
1013 * presence and content before deciding to allow the http
1014 * connection to proceed or to kill the connection. */
1015 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
1016 /**< A new client just had
1017 * been connected, accepted, and instantiated into the pool. This
1018 * callback allows setting any relevant property to it. Because this
1019 * happens immediately after the instantiation of a new client,
1020 * there's no websocket protocol selected yet so this callback is
1021 * issued only to protocol 0. Only wsi is defined, pointing to the
1022 * new client, and the return value is ignored. */
1023 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
1024 /**< called when the handshake has
1025 * been received and parsed from the client, but the response is
1026 * not sent yet. Return non-zero to disallow the connection.
1027 * user is a pointer to the connection user space allocation,
1028 * in is the requested protocol name
1029 * In your handler you can use the public APIs
1030 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
1031 * headers using the header enums lws_token_indexes from
1032 * libwebsockets.h to check for and read the supported header
1033 * presence and content before deciding to allow the handshake
1034 * to proceed or to kill the connection. */
1035 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
1036 /**< if configured for
1037 * including OpenSSL support, this callback allows your user code
1038 * to perform extra SSL_CTX_load_verify_locations() or similar
1039 * calls to direct OpenSSL where to find certificates the client
1040 * can use to confirm the remote server identity. user is the
1041 * OpenSSL SSL_CTX* */
1042 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
1043 /**< if configured for
1044 * including OpenSSL support, this callback allows your user code
1045 * to load extra certifcates into the server which allow it to
1046 * verify the validity of certificates returned by clients. user
1047 * is the server's OpenSSL SSL_CTX* */
1048 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
1049 /**< if the libwebsockets vhost was created with the option
1050 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
1051 * callback is generated during OpenSSL verification of the cert
1052 * sent from the client. It is sent to protocol[0] callback as
1053 * no protocol has been negotiated on the connection yet.
1054 * Notice that the libwebsockets context and wsi are both NULL
1055 * during this callback. See
1056 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1057 * to understand more detail about the OpenSSL callback that
1058 * generates this libwebsockets callback and the meanings of the
1059 * arguments passed. In this callback, user is the x509_ctx,
1060 * in is the ssl pointer and len is preverify_ok
1061 * Notice that this callback maintains libwebsocket return
1062 * conventions, return 0 to mean the cert is OK or 1 to fail it.
1063 * This also means that if you don't handle this callback then
1064 * the default callback action of returning 0 allows the client
1066 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
1067 /**< this callback happens
1068 * when a client handshake is being compiled. user is NULL,
1069 * in is a char **, it's pointing to a char * which holds the
1070 * next location in the header buffer where you can add
1071 * headers, and len is the remaining space in the header buffer,
1072 * which is typically some hundreds of bytes. So, to add a canned
1073 * cookie, your handler code might look similar to:
1075 * char **p = (char **)in;
1080 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1084 * Notice if you add anything, you just have to take care about
1085 * the CRLF on the line you added. Obviously this callback is
1086 * optional, if you don't handle it everything is fine.
1088 * Notice the callback is coming to protocols[0] all the time,
1089 * because there is no specific protocol negotiated yet. */
1090 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
1091 /**< When the server handshake code
1092 * sees that it does support a requested extension, before
1093 * accepting the extension by additing to the list sent back to
1094 * the client it gives this callback just to check that it's okay
1095 * to use that extension. It calls back to the requested protocol
1096 * and with in being the extension name, len is 0 and user is
1097 * valid. Note though at this time the ESTABLISHED callback hasn't
1098 * happened yet so if you initialize user content there, user
1099 * content during this callback might not be useful for anything. */
1100 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
1102 * connection is being prepared to start a handshake to a server,
1103 * each supported extension is checked with protocols[0] callback
1104 * with this reason, giving the user code a chance to suppress the
1105 * claim to support that extension by returning non-zero. If
1106 * unhandled, by default 0 will be returned and the extension
1107 * support included in the header to the server. Notice this
1108 * callback comes to protocols[0]. */
1109 LWS_CALLBACK_PROTOCOL_INIT = 27,
1110 /**< One-time call per protocol, per-vhost using it, so it can
1111 * do initial setup / allocations etc */
1112 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
1113 /**< One-time call per protocol, per-vhost using it, indicating
1114 * this protocol won't get used at all after this callback, the
1115 * vhost is getting destroyed. Take the opportunity to
1116 * deallocate everything that was allocated by the protocol. */
1117 LWS_CALLBACK_WSI_CREATE = 29,
1118 /**< outermost (earliest) wsi create notification to protocols[0] */
1119 LWS_CALLBACK_WSI_DESTROY = 30,
1120 /**< outermost (latest) wsi destroy notification to protocols[0] */
1121 LWS_CALLBACK_GET_THREAD_ID = 31,
1122 /**< lws can accept callback when writable requests from other
1123 * threads, if you implement this callback and return an opaque
1124 * current thread ID integer. */
1126 /* external poll() management support */
1127 LWS_CALLBACK_ADD_POLL_FD = 32,
1128 /**< lws normally deals with its poll() or other event loop
1129 * internally, but in the case you are integrating with another
1130 * server you will need to have lws sockets share a
1131 * polling array with the other server. This and the other
1132 * POLL_FD related callbacks let you put your specialized
1133 * poll array interface code in the callback for protocol 0, the
1134 * first protocol you support, usually the HTTP protocol in the
1136 * This callback happens when a socket needs to be
1137 * added to the polling loop: in points to a struct
1138 * lws_pollargs; the fd member of the struct is the file
1139 * descriptor, and events contains the active events
1141 * If you are using the internal lws polling / event loop
1142 * you can just ignore these callbacks. */
1143 LWS_CALLBACK_DEL_POLL_FD = 33,
1144 /**< This callback happens when a socket descriptor
1145 * needs to be removed from an external polling array. in is
1146 * again the struct lws_pollargs containing the fd member
1147 * to be removed. If you are using the internal polling
1148 * loop, you can just ignore it. */
1149 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1150 /**< This callback happens when lws wants to modify the events for
1152 * in is the struct lws_pollargs with the fd to change.
1153 * The new event mask is in events member and the old mask is in
1154 * the prev_events member.
1155 * If you are using the internal polling loop, you can just ignore
1157 LWS_CALLBACK_LOCK_POLL = 35,
1158 /**< These allow the external poll changes driven
1159 * by lws to participate in an external thread locking
1160 * scheme around the changes, so the whole thing is threadsafe.
1161 * These are called around three activities in the library,
1162 * - inserting a new wsi in the wsi / fd table (len=1)
1163 * - deleting a wsi from the wsi / fd table (len=1)
1164 * - changing a wsi's POLLIN/OUT state (len=0)
1165 * Locking and unlocking external synchronization objects when
1166 * len == 1 allows external threads to be synchronized against
1167 * wsi lifecycle changes if it acquires the same lock for the
1168 * duration of wsi dereference from the other thread context. */
1169 LWS_CALLBACK_UNLOCK_POLL = 36,
1170 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1172 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1173 /**< if configured for including OpenSSL support but no private key
1174 * file has been specified (ssl_private_key_filepath is NULL), this is
1175 * called to allow the user to set the private key directly via
1176 * libopenssl and perform further operations if required; this might be
1177 * useful in situations where the private key is not directly accessible
1178 * by the OS, for example if it is stored on a smartcard.
1179 * user is the server's OpenSSL SSL_CTX* */
1180 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1181 /**< The peer has sent an unsolicited Close WS packet. in and
1182 * len are the optional close code (first 2 bytes, network
1183 * order) and the optional additional information which is not
1184 * defined in the standard, and may be a string or non-human- readable data.
1185 * If you return 0 lws will echo the close and then close the
1186 * connection. If you return nonzero lws will just close the
1189 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1192 LWS_CALLBACK_CGI = 40,
1194 LWS_CALLBACK_CGI_TERMINATED = 41,
1196 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1198 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1200 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1202 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1204 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1206 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1208 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1210 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1212 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1214 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1216 LWS_CALLBACK_PROCESS_HTML = 52,
1218 LWS_CALLBACK_ADD_HEADERS = 53,
1220 LWS_CALLBACK_SESSION_INFO = 54,
1223 LWS_CALLBACK_GS_EVENT = 55,
1225 LWS_CALLBACK_HTTP_PMO = 56,
1226 /**< per-mount options for this connection, called before
1227 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1230 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1231 /**< when doing an HTTP type client connection, you can call
1232 * lws_client_http_body_pending(wsi, 1) from
1233 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1234 * sending the HTTP headers.
1236 * From this callback, when you have sent everything, you should let
1237 * lws know by calling lws_client_http_body_pending(wsi, 0)
1239 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1240 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1241 * this callback is called during OpenSSL verification of the cert
1242 * sent from the server to the client. It is sent to protocol[0]
1243 * callback as no protocol has been negotiated on the connection yet.
1244 * Notice that the wsi is set because lws_client_connect_via_info was
1247 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1248 * to understand more detail about the OpenSSL callback that
1249 * generates this libwebsockets callback and the meanings of the
1250 * arguments passed. In this callback, user is the x509_ctx,
1251 * in is the ssl pointer and len is preverify_ok.
1253 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1254 * overruled and cert shall be accepted as ok,
1255 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1256 * called and return value must be 0 to mean the cert is OK;
1257 * returning 1 will fail the cert in any case.
1259 * This also means that if you don't handle this callback then
1260 * the default callback action of returning 0 will not accept the
1261 * certificate in case of a validation error decided by the SSL lib.
1263 * This is expected and secure behaviour when validating certificates.
1265 * Note: LCCSCF_ALLOW_SELFSIGNED and
1266 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1267 * callback being implemented.
1269 LWS_CALLBACK_RAW_RX = 59,
1270 /**< RAW mode connection RX */
1271 LWS_CALLBACK_RAW_CLOSE = 60,
1272 /**< RAW mode connection is closing */
1273 LWS_CALLBACK_RAW_WRITEABLE = 61,
1274 /**< RAW mode connection may be written */
1275 LWS_CALLBACK_RAW_ADOPT = 62,
1276 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1277 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1278 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1279 LWS_CALLBACK_RAW_RX_FILE = 64,
1280 /**< RAW mode file has something to read */
1281 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1282 /**< RAW mode file is writeable */
1283 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1284 /**< RAW mode wsi that adopted a file is closing */
1285 LWS_CALLBACK_SSL_INFO = 67,
1286 /**< SSL connections only. An event you registered an
1287 * interest in at the vhost has occurred on a connection
1288 * using the vhost. @in is a pointer to a
1289 * struct lws_ssl_info containing information about the
1291 LWS_CALLBACK_CHILD_WRITE_VIA_PARENT = 68,
1292 /**< Child has been marked with parent_carries_io attribute, so
1293 * lws_write directs the to this callback at the parent,
1294 * @in is a struct lws_write_passthru containing the args
1295 * the lws_write() was called with.
1297 LWS_CALLBACK_CHILD_CLOSING = 69,
1298 /**< Sent to parent to notify them a child is closing / being
1299 * destroyed. @in is the child wsi.
1302 /****** add new things just above ---^ ******/
1304 LWS_CALLBACK_USER = 1000,
1305 /**< user code can use any including above without fear of clashes */
1311 * typedef lws_callback_function() - User server actions
1312 * \param wsi: Opaque websocket instance pointer
1313 * \param reason: The reason for the call
1314 * \param user: Pointer to per-session user data allocated by library
1315 * \param in: Pointer used for some callback reasons
1316 * \param len: Length set for some callback reasons
1318 * This callback is the way the user controls what is served. All the
1319 * protocol detail is hidden and handled by the library.
1321 * For each connection / session there is user data allocated that is
1322 * pointed to by "user". You set the size of this user data area when
1323 * the library is initialized with lws_create_server.
1326 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1327 void *user, void *in, size_t len);
1330 /*! \defgroup extensions
1332 * ##Extension releated functions
1334 * Ws defines optional extensions, lws provides the ability to implement these
1335 * in user code if so desired.
1337 * We provide one extensions permessage-deflate.
1342 * NOTE: These public enums are part of the abi. If you want to add one,
1343 * add it at where specified so existing users are unaffected.
1345 enum lws_extension_callback_reasons {
1346 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1347 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1348 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1349 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1350 LWS_EXT_CB_CONSTRUCT = 4,
1351 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1352 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1353 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1354 LWS_EXT_CB_DESTROY = 8,
1355 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1356 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1357 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1358 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1359 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1360 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1361 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1362 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1363 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1364 LWS_EXT_CB_1HZ = 18,
1365 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1366 LWS_EXT_CB_IS_WRITEABLE = 20,
1367 LWS_EXT_CB_PAYLOAD_TX = 21,
1368 LWS_EXT_CB_PAYLOAD_RX = 22,
1369 LWS_EXT_CB_OPTION_DEFAULT = 23,
1370 LWS_EXT_CB_OPTION_SET = 24,
1371 LWS_EXT_CB_OPTION_CONFIRM = 25,
1372 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1374 /****** add new things just above ---^ ******/
1377 /** enum lws_ext_options_types */
1378 enum lws_ext_options_types {
1379 EXTARG_NONE, /**< does not take an argument */
1380 EXTARG_DEC, /**< requires a decimal argument */
1381 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1383 /* Add new things just above here ---^
1384 * This is part of the ABI, don't needlessly break compatibility */
1387 /** struct lws_ext_options - Option arguments to the extension. These are
1388 * used in the negotiation at ws upgrade time.
1389 * The helper function lws_ext_parse_options()
1390 * uses these to generate callbacks */
1391 struct lws_ext_options {
1392 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1393 enum lws_ext_options_types type; /**< What kind of args the option can take */
1395 /* Add new things just above here ---^
1396 * This is part of the ABI, don't needlessly break compatibility */
1399 /** struct lws_ext_option_arg */
1400 struct lws_ext_option_arg {
1401 const char *option_name; /**< may be NULL, option_index used then */
1402 int option_index; /**< argument ordinal to use if option_name missing */
1403 const char *start; /**< value */
1404 int len; /**< length of value */
1408 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1409 * \param context: Websockets context
1410 * \param ext: This extension
1411 * \param wsi: Opaque websocket instance pointer
1412 * \param reason: The reason for the call
1413 * \param user: Pointer to ptr to per-session user data allocated by library
1414 * \param in: Pointer used for some callback reasons
1415 * \param len: Length set for some callback reasons
1417 * Each extension that is active on a particular connection receives
1418 * callbacks during the connection lifetime to allow the extension to
1419 * operate on websocket data and manage itself.
1421 * Libwebsockets takes care of allocating and freeing "user" memory for
1422 * each active extension on each connection. That is what is pointed to
1423 * by the user parameter.
1425 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1426 * select this extension from the list provided by the client,
1427 * just before the server will send back the handshake accepting
1428 * the connection with this extension active. This gives the
1429 * extension a chance to initialize its connection context found
1432 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1433 * but called when client is instantiating this extension. Some
1434 * extensions will work the same on client and server side and then
1435 * you can just merge handlers for both CONSTRUCTS.
1437 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1438 * being used on is about to be closed and deallocated. It's the
1439 * last chance for the extension to deallocate anything it has
1440 * allocated in the user data (pointed to by user) before the
1441 * user data is deleted. This same callback is used whether you
1442 * are in client or server instantiation context.
1444 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1445 * a connection, and a packet of data arrived at the connection,
1446 * it is passed to this callback to give the extension a chance to
1447 * change the data, eg, decompress it. user is pointing to the
1448 * extension's private connection context data, in is pointing
1449 * to an lws_tokens struct, it consists of a char * pointer called
1450 * token, and an int called token_len. At entry, these are
1451 * set to point to the received buffer and set to the content
1452 * length. If the extension will grow the content, it should use
1453 * a new buffer allocated in its private user context data and
1454 * set the pointed-to lws_tokens members to point to its buffer.
1456 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1457 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1458 * extension a chance to change websocket data just before it will
1459 * be sent out. Using the same lws_token pointer scheme in in,
1460 * the extension can change the buffer and the length to be
1461 * transmitted how it likes. Again if it wants to grow the
1462 * buffer safely, it should copy the data into its own buffer and
1463 * set the lws_tokens token pointer to it.
1465 * LWS_EXT_CB_ARGS_VALIDATE:
1468 lws_extension_callback_function(struct lws_context *context,
1469 const struct lws_extension *ext, struct lws *wsi,
1470 enum lws_extension_callback_reasons reason,
1471 void *user, void *in, size_t len);
1473 /** struct lws_extension - An extension we support */
1474 struct lws_extension {
1475 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1476 lws_extension_callback_function *callback; /**< Service callback */
1477 const char *client_offer; /**< String containing exts and options client offers */
1479 /* Add new things just above here ---^
1480 * This is part of the ABI, don't needlessly break compatibility */
1484 * lws_set_extension_option(): set extension option if possible
1486 * \param wsi: websocket connection
1487 * \param ext_name: name of ext, like "permessage-deflate"
1488 * \param opt_name: name of option, like "rx_buf_size"
1489 * \param opt_val: value to set option to
1491 LWS_VISIBLE LWS_EXTERN int
1492 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1493 const char *opt_name, const char *opt_val);
1495 #ifndef LWS_NO_EXTENSIONS
1496 /* lws_get_internal_extensions() - DEPRECATED
1498 * \Deprecated There is no longer a set internal extensions table. The table is provided
1499 * by user code along with application-specific settings. See the test
1500 * client and server for how to do.
1502 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1503 lws_get_internal_extensions(void) { return NULL; }
1506 * lws_ext_parse_options() - deal with parsing negotiated extension options
1508 * \param ext: related extension struct
1509 * \param wsi: websocket connection
1510 * \param ext_user: per-connection extension private data
1511 * \param opts: list of supported options
1512 * \param o: option string to parse
1513 * \param len: length
1515 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1516 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1517 void *ext_user, const struct lws_ext_options *opts,
1518 const char *o, int len);
1521 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1523 * \param context: lws context
1524 * \param ext: related lws_extension struct
1525 * \param wsi: websocket connection
1526 * \param reason: incoming callback reason
1527 * \param user: per-connection extension private data
1528 * \param in: pointer parameter
1529 * \param len: length parameter
1531 * Built-in callback implementing RFC7692 permessage-deflate
1534 int lws_extension_callback_pm_deflate(
1535 struct lws_context *context, const struct lws_extension *ext,
1536 struct lws *wsi, enum lws_extension_callback_reasons reason,
1537 void *user, void *in, size_t len);
1540 * The internal exts are part of the public abi
1541 * If we add more extensions, publish the callback here ------v
1545 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1548 * ##Protocol and protocol plugin -related apis
1550 * Protocols bind ws protocol names to a custom callback specific to that
1551 * protocol implementaion.
1553 * A list of protocols can be passed in at context creation time, but it is
1554 * also legal to leave that NULL and add the protocols and their callback code
1557 * Plugins are much preferable compared to cut and pasting code into an
1558 * application each time, since they can be used standalone.
1561 /** struct lws_protocols - List of protocols and handlers client or server
1564 struct lws_protocols {
1566 /**< Protocol name that must match the one given in the client
1567 * Javascript new WebSocket(url, 'protocol') name. */
1568 lws_callback_function *callback;
1569 /**< The service callback used for this protocol. It allows the
1570 * service action for an entire protocol to be encapsulated in
1571 * the protocol-specific callback */
1572 size_t per_session_data_size;
1573 /**< Each new connection using this protocol gets
1574 * this much memory allocated on connection establishment and
1575 * freed on connection takedown. A pointer to this per-connection
1576 * allocation is passed into the callback in the 'user' parameter */
1577 size_t rx_buffer_size;
1578 /**< lws allocates this much space for rx data and informs callback
1579 * when something came. Due to rx flow control, the callback may not
1580 * be able to consume it all without having to return to the event
1581 * loop. That is supported in lws.
1583 * If .tx_packet_size is 0, this also controls how much may be sent at once
1584 * for backwards compatibility.
1587 /**< ignored by lws, but useful to contain user information bound
1588 * to the selected protocol. For example if this protocol was
1589 * called "myprotocol-v2", you might set id to 2, and the user
1590 * code that acts differently according to the version can do so by
1591 * switch (wsi->protocol->id), user code might use some bits as
1592 * capability flags based on selected protocol version, etc. */
1593 void *user; /**< ignored by lws, but user code can pass a pointer
1594 here it can later access from the protocol callback */
1595 size_t tx_packet_size;
1596 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1598 * If greater than zero, a single send() is restricted to this amount
1599 * and any remainder is buffered by lws and sent afterwards also in
1600 * these size chunks. Since that is expensive, it's preferable
1601 * to restrict one fragment you are trying to send to match this
1605 /* Add new things just above here ---^
1606 * This is part of the ABI, don't needlessly break compatibility */
1612 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1614 * \param vh: vhost to search
1615 * \param name: protocol name
1617 * Returns NULL or a pointer to the vhost's protocol of the requested name
1619 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1620 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1623 * lws_get_protocol() - Returns a protocol pointer from a websocket
1625 * \param wsi: pointer to struct websocket you want to know the protocol of
1628 * Some apis can act on all live connections of a given protocol,
1629 * this is how you can get a pointer to the active protocol if needed.
1631 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1632 lws_get_protocol(struct lws *wsi);
1634 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1635 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1636 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1639 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1641 * \param vhost: vhost the instance is related to
1642 * \param prot: protocol the instance is related to
1643 * \param size: bytes to allocate
1645 * Protocols often find it useful to allocate a per-vhost struct, this is a
1646 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1648 LWS_VISIBLE LWS_EXTERN void *
1649 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1653 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1655 * \param vhost: vhost the instance is related to
1656 * \param prot: protocol the instance is related to
1658 * Recover a pointer to the allocated per-vhost storage for the protocol created
1659 * by lws_protocol_vh_priv_zalloc() earlier
1661 LWS_VISIBLE LWS_EXTERN void *
1662 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1665 * lws_finalize_startup() - drop initial process privileges
1667 * \param context: lws context
1669 * This is called after the end of the vhost protocol initializations, but
1670 * you may choose to call it earlier
1672 LWS_VISIBLE LWS_EXTERN int
1673 lws_finalize_startup(struct lws_context *context);
1675 LWS_VISIBLE LWS_EXTERN int
1676 lws_protocol_init(struct lws_context *context);
1678 #ifdef LWS_WITH_PLUGINS
1680 /* PLUGINS implies LIBUV */
1682 #define LWS_PLUGIN_API_MAGIC 180
1684 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1685 struct lws_plugin_capability {
1686 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1687 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1688 int count_protocols; /**< how many protocols */
1689 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1690 int count_extensions; /**< how many extensions */
1693 typedef int (*lws_plugin_init_func)(struct lws_context *,
1694 struct lws_plugin_capability *);
1695 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1697 /** struct lws_plugin */
1699 struct lws_plugin *list; /**< linked list */
1700 #if (UV_VERSION_MAJOR > 0)
1701 uv_lib_t lib; /**< shared library pointer */
1703 void *l; /**< so we can compile on ancient libuv */
1705 char name[64]; /**< name of the plugin */
1706 struct lws_plugin_capability caps; /**< plugin capabilities */
1714 /*! \defgroup generic-sessions plugin: generic-sessions
1715 * \ingroup Protocols-and-Plugins
1717 * ##Plugin Generic-sessions related
1719 * generic-sessions plugin provides a reusable, generic session and login /
1720 * register / forgot password framework including email verification.
1724 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1725 /**< Maximum size of email we might send */
1727 /* SHA-1 binary and hexified versions */
1728 /** typedef struct lwsgw_hash_bin */
1729 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1730 /** typedef struct lwsgw_hash */
1731 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1733 /** enum lwsgs_auth_bits */
1734 enum lwsgs_auth_bits {
1735 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1736 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1737 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1738 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1741 /** struct lws_session_info - information about user session status */
1742 struct lws_session_info {
1743 char username[32]; /**< username logged in as, or empty string */
1744 char email[100]; /**< email address associated with login, or empty string */
1745 char ip[72]; /**< ip address session was started from */
1746 unsigned int mask; /**< access rights mask associated with session
1747 * see enum lwsgs_auth_bits */
1748 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1751 /** enum lws_gs_event */
1753 LWSGSE_CREATED, /**< a new user was created */
1754 LWSGSE_DELETED /**< an existing user was deleted */
1757 /** struct lws_gs_event_args */
1758 struct lws_gs_event_args {
1759 enum lws_gs_event event; /**< which event happened */
1760 const char *username; /**< which username the event happened to */
1761 const char *email; /**< the email address of that user */
1767 /*! \defgroup context-and-vhost
1770 * ##Context and Vhost releated functions
1772 * LWS requires that there is one context, in which you may define multiple
1773 * vhosts. Each vhost is a virtual host, with either its own listen port
1774 * or sharing an existing one. Each vhost has its own SSL context that can
1775 * be set up individually or left disabled.
1777 * If you don't care about multiple "site" support, you can ignore it and
1778 * lws will create a single default vhost at context creation time.
1783 * NOTE: These public enums are part of the abi. If you want to add one,
1784 * add it at where specified so existing users are unaffected.
1787 /** enum lws_context_options - context and vhost options */
1788 enum lws_context_options {
1789 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1791 /**< (VH) Don't allow the connection unless the client has a
1792 * client cert that we recognize; provides
1793 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1794 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1795 /**< (CTX) Don't try to get the server's hostname */
1796 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1798 /**< (VH) Allow non-SSL (plaintext) connections on the same
1799 * port as SSL is listening... undermines the security of SSL;
1800 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1801 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1802 /**< (CTX) Use libev event loop */
1803 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1804 /**< (VH) Disable IPV6 support */
1805 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1806 /**< (VH) Don't load OS CA certs, you will need to load your
1808 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1809 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1810 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1811 /**< (VH) Check UT-8 correctness */
1812 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1814 /**< (VH) initialize ECDH ciphers */
1815 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1816 /**< (CTX) Use libuv event loop */
1817 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1819 /**< (VH) Use http redirect to force http to https
1820 * (deprecated: use mount redirection) */
1821 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1822 /**< (CTX) Initialize the SSL library at all */
1823 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1824 /**< (CTX) Only create the context when calling context
1825 * create api, implies user code will create its own vhosts */
1826 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1827 /**< (VH) Use Unix socket */
1828 LWS_SERVER_OPTION_STS = (1 << 15),
1829 /**< (VH) Send Strict Transport Security header, making
1830 * clients subsequently go to https even if user asked for http */
1831 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1832 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1833 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1834 /**< (VH) if set, only ipv6 allowed on the vhost */
1835 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1836 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1837 * normally makes the lib spin so you can attach a debugger to it
1838 * even if it happened without a debugger in place. You can disable
1839 * that by giving this option.
1841 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1842 /**< For backwards-compatibility reasons, by default
1843 * lws prepends "http://" to the origin you give in the client
1844 * connection info struct. If you give this flag when you create
1845 * the context, only the string you give in the client connect
1846 * info for .origin (if any) will be used directly.
1848 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1849 /**< (VH) if invalid http is coming in the first line, */
1850 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1851 /**< (CTX) Use libevent event loop */
1852 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1853 /**< (VH) All connections to this vhost / port are RAW as soon as
1854 * the connection is accepted, no HTTP is going to be coming.
1856 LWS_SERVER_OPTION_ALLOW_LISTEN_SHARE = (1 << 23),
1857 /**< (VH) Set to allow multiple listen sockets on one interface +
1858 * address + port. The default is to strictly allow only one
1859 * listen socket at a time. This is automatically selected if you
1860 * have multiple service threads.
1863 /****** add new things just above ---^ ******/
1866 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1868 struct lws_plat_file_ops;
1870 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1872 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1873 * is not given, then for backwards compatibility one vhost is created at
1874 * context-creation time using the info from this struct.
1876 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1877 * at the same time as the context, they are expected to be created afterwards.
1879 struct lws_context_creation_info {
1881 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1882 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1883 * writing a server but you are using \ref sock-adopt instead of the
1884 * built-in listener */
1886 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1887 * interface name, eg, "eth2"
1888 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1889 * the pathname of a UNIX domain socket. you can use the UNIX domain
1890 * sockets in abstract namespace, by prepending an at symbol to the
1892 const struct lws_protocols *protocols;
1893 /**< VHOST: Array of structures listing supported protocols and a protocol-
1894 * specific callback for each one. The list is ended with an
1895 * entry that has a NULL callback pointer. */
1896 const struct lws_extension *extensions;
1897 /**< VHOST: NULL or array of lws_extension structs listing the
1898 * extensions this context supports. */
1899 const struct lws_token_limits *token_limits;
1900 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1901 * with a token length limit for each possible WSI_TOKEN_ */
1902 const char *ssl_private_key_password;
1903 /**< VHOST: NULL or the passphrase needed for the private key */
1904 const char *ssl_cert_filepath;
1905 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1906 * to listen using SSL, set to the filepath to fetch the
1907 * server cert from, otherwise NULL for unencrypted */
1908 const char *ssl_private_key_filepath;
1909 /**< VHOST: filepath to private key if wanting SSL mode;
1910 * if this is set to NULL but sll_cert_filepath is set, the
1911 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1912 * to allow setting of the private key directly via openSSL
1914 const char *ssl_ca_filepath;
1915 /**< VHOST: CA certificate filepath or NULL */
1916 const char *ssl_cipher_list;
1917 /**< VHOST: List of valid ciphers to use (eg,
1918 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1919 * or you can leave it as NULL to get "DEFAULT" */
1920 const char *http_proxy_address;
1921 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1922 * If proxy auth is required, use format "username:password\@server:port" */
1923 unsigned int http_proxy_port;
1924 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1926 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1928 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1929 unsigned int options;
1930 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1932 /**< CONTEXT: optional user pointer that can be recovered via the context
1933 * pointer using lws_context_user */
1935 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1936 * timeout to all libwebsocket sockets, client or server */
1938 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1939 * times to try to get a response from the peer before giving up
1940 * and killing the connection */
1942 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1944 #ifdef LWS_OPENSSL_SUPPORT
1945 SSL_CTX *provided_client_ssl_ctx;
1946 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1947 * implementation for the one provided by provided_ssl_ctx.
1948 * Libwebsockets no longer is responsible for freeing the context
1949 * if this option is selected. */
1950 #else /* maintain structure layout either way */
1951 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1954 short max_http_header_data;
1955 /**< CONTEXT: The max amount of header payload that can be handled
1956 * in an http request (unrecognized header payload is dropped) */
1957 short max_http_header_pool;
1958 /**< CONTEXT: The max number of connections with http headers that
1959 * can be processed simultaneously (the corresponding memory is
1960 * allocated for the lifetime of the context). If the pool is
1961 * busy new incoming connections must wait for accept until one
1964 unsigned int count_threads;
1965 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1966 unsigned int fd_limit_per_thread;
1967 /**< CONTEXT: nonzero means restrict each service thread to this
1968 * many fds, 0 means the default which is divide the process fd
1969 * limit by the number of threads. */
1970 unsigned int timeout_secs;
1971 /**< VHOST: various processes involving network roundtrips in the
1972 * library are protected from hanging forever by timeouts. If
1973 * nonzero, this member lets you set the timeout used in seconds.
1974 * Otherwise a default timeout is used. */
1975 const char *ecdh_curve;
1976 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1977 const char *vhost_name;
1978 /**< VHOST: name of vhost, must match external DNS name used to
1979 * access the site, like "warmcat.com" as it's used to match
1980 * Host: header and / or SNI name for SSL. */
1981 const char * const *plugin_dirs;
1982 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1983 * scan for lws protocol plugins at context creation time */
1984 const struct lws_protocol_vhost_options *pvo;
1985 /**< VHOST: pointer to optional linked list of per-vhost
1986 * options made accessible to protocols */
1987 int keepalive_timeout;
1988 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1989 * client to hold on to an idle HTTP/1.1 connection */
1990 const char *log_filepath;
1991 /**< VHOST: filepath to append logs to... this is opened before
1992 * any dropping of initial privileges */
1993 const struct lws_http_mount *mounts;
1994 /**< VHOST: optional linked list of mounts for this vhost */
1995 const char *server_string;
1996 /**< CONTEXT: string used in HTTP headers to identify server
1997 * software, if NULL, "libwebsockets". */
1998 unsigned int pt_serv_buf_size;
1999 /**< CONTEXT: 0 = default of 4096. This buffer is used by
2000 * various service related features including file serving, it
2001 * defines the max chunk of file that can be sent at once.
2002 * At the risk of lws having to buffer failed large sends, it
2003 * can be increased to, eg, 128KiB to improve throughput. */
2004 unsigned int max_http_header_data2;
2005 /**< CONTEXT: if max_http_header_data is 0 and this
2006 * is nonzero, this will be used in place of the default. It's
2007 * like this for compatibility with the original short version,
2008 * this is unsigned int length. */
2009 long ssl_options_set;
2010 /**< VHOST: Any bits set here will be set as SSL options */
2011 long ssl_options_clear;
2012 /**< VHOST: Any bits set here will be cleared as SSL options */
2013 unsigned short ws_ping_pong_interval;
2014 /**< CONTEXT: 0 for none, else interval in seconds between sending
2015 * PINGs on idle websocket connections. When the PING is sent,
2016 * the PONG must come within the normal timeout_secs timeout period
2017 * or the connection will be dropped.
2018 * Any RX or TX traffic on the connection restarts the interval timer,
2019 * so a connection which always sends or receives something at intervals
2020 * less than the interval given here will never send PINGs / expect
2021 * PONGs. Conversely as soon as the ws connection is established, an
2022 * idle connection will do the PING / PONG roundtrip as soon as
2023 * ws_ping_pong_interval seconds has passed without traffic
2025 const struct lws_protocol_vhost_options *headers;
2026 /**< VHOST: pointer to optional linked list of per-vhost
2027 * canned headers that are added to server responses */
2029 const struct lws_protocol_vhost_options *reject_service_keywords;
2030 /**< CONTEXT: Optional list of keywords and rejection codes + text.
2032 * The keywords are checked for existing in the user agent string.
2034 * Eg, "badrobot" "404 Not Found"
2036 void *external_baggage_free_on_destroy;
2037 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
2038 * should be freed when the context is destroyed. This allows you to
2039 * automatically sync the freeing action to the context destruction
2040 * action, so there is no need for an external free() if the context
2041 * succeeded to create.
2044 #ifdef LWS_OPENSSL_SUPPORT
2045 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
2046 * with a token length limit for each possible WSI_TOKEN_ */
2047 const char *client_ssl_private_key_password;
2048 /**< VHOST: NULL or the passphrase needed for the private key */
2049 const char *client_ssl_cert_filepath;
2050 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
2051 * to listen using SSL, set to the filepath to fetch the
2052 * server cert from, otherwise NULL for unencrypted */
2053 const char *client_ssl_private_key_filepath;
2054 /**< VHOST: filepath to private key if wanting SSL mode;
2055 * if this is set to NULL but sll_cert_filepath is set, the
2056 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
2057 * to allow setting of the private key directly via openSSL
2059 const char *client_ssl_ca_filepath;
2060 /**< VHOST: CA certificate filepath or NULL */
2061 const char *client_ssl_cipher_list;
2062 /**< VHOST: List of valid ciphers to use (eg,
2063 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
2064 * or you can leave it as NULL to get "DEFAULT" */
2067 const struct lws_plat_file_ops *fops;
2068 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
2069 * by a sentinel with NULL .open.
2071 * If NULL, lws provides just the platform file operations struct for
2072 * backwards compatibility.
2074 int simultaneous_ssl_restriction;
2075 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
2076 const char *socks_proxy_address;
2077 /**< VHOST: If non-NULL, attempts to proxy via the given address.
2078 * If proxy auth is required, use format "username:password\@server:port" */
2079 unsigned int socks_proxy_port;
2080 /**< VHOST: If socks_proxy_address was non-NULL, uses this port */
2081 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
2082 cap_value_t caps[4];
2083 /**< CONTEXT: array holding Linux capabilities you want to
2084 * continue to be available to the server after it transitions
2085 * to a noprivileged user. Usually none are needed but for, eg,
2086 * .bind_iface, CAP_NET_RAW is required. This gives you a way
2087 * to still have the capability but drop root.
2090 /**< CONTEXT: count of Linux capabilities in .caps[]. 0 means
2091 * no capabilities will be inherited from root (the default) */
2094 /**< VHOST: nonzero to strictly bind sockets to the interface name in
2095 * .iface (eg, "eth2"), using SO_BIND_TO_DEVICE.
2097 * Requires SO_BINDTODEVICE support from your OS and CAP_NET_RAW
2100 * Notice that common things like access network interface IP from
2101 * your local machine use your lo / loopback interface and will be
2102 * disallowed by this.
2105 /* Add new things just above here ---^
2106 * This is part of the ABI, don't needlessly break compatibility
2108 * The below is to ensure later library versions with new
2109 * members added above will see 0 (default) even if the app
2110 * was not built against the newer headers.
2112 int ssl_info_event_mask;
2113 /**< VHOST: mask of ssl events to be reported on LWS_CALLBACK_SSL_INFO
2114 * callback for connections on this vhost. The mask values are of
2115 * the form SSL_CB_ALERT, defined in openssl/ssl.h. The default of
2116 * 0 means no info events will be reported.
2119 void *_unused[8]; /**< dummy */
2123 * lws_create_context() - Create the websocket handler
2124 * \param info: pointer to struct with parameters
2126 * This function creates the listening socket (if serving) and takes care
2127 * of all initialization in one step.
2129 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
2130 * created; you're expected to create your own vhosts afterwards using
2131 * lws_create_vhost(). Otherwise a vhost named "default" is also created
2132 * using the information in the vhost-related members, for compatibility.
2134 * After initialization, it returns a struct lws_context * that
2135 * represents this server. After calling, user code needs to take care
2136 * of calling lws_service() with the context pointer to get the
2137 * server's sockets serviced. This must be done in the same process
2138 * context as the initialization call.
2140 * The protocol callback functions are called for a handful of events
2141 * including http requests coming in, websocket connections becoming
2142 * established, and data arriving; it's also called periodically to allow
2143 * async transmission.
2145 * HTTP requests are sent always to the FIRST protocol in protocol, since
2146 * at that time websocket protocol has not been negotiated. Other
2147 * protocols after the first one never see any HTTP callback activity.
2149 * The server created is a simple http server by default; part of the
2150 * websocket standard is upgrading this http connection to a websocket one.
2152 * This allows the same server to provide files like scripts and favicon /
2153 * images or whatever over http and dynamic data over websockets all in
2154 * one place; they're all handled in the user callback.
2156 LWS_VISIBLE LWS_EXTERN struct lws_context *
2157 lws_create_context(struct lws_context_creation_info *info);
2160 * lws_context_destroy() - Destroy the websocket context
2161 * \param context: Websocket context
2163 * This function closes any active connections and then frees the
2164 * context. After calling this, any further use of the context is
2167 LWS_VISIBLE LWS_EXTERN void
2168 lws_context_destroy(struct lws_context *context);
2170 LWS_VISIBLE LWS_EXTERN void
2171 lws_context_destroy2(struct lws_context *context);
2173 typedef int (*lws_reload_func)(void);
2176 * lws_context_deprecate() - Deprecate the websocket context
2177 * \param context: Websocket context
2179 * This function is used on an existing context before superceding it
2180 * with a new context.
2182 * It closes any listen sockets in the context, so new connections are
2185 * And it marks the context to be deleted when the number of active
2186 * connections into it falls to zero.
2188 * Otherwise if you attach the deprecated context to the replacement
2189 * context when it has been created using lws_context_attach_deprecated()
2190 * both any deprecated and the new context will service their connections.
2192 * This is aimed at allowing seamless configuration reloads.
2194 * The callback cb will be called after the listen sockets are actually
2195 * closed and may be reopened. In the callback the new context should be
2196 * configured and created. (With libuv, socket close happens async after
2197 * more loop events).
2199 LWS_VISIBLE LWS_EXTERN void
2200 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2202 LWS_VISIBLE LWS_EXTERN int
2203 lws_context_is_deprecated(struct lws_context *context);
2206 * lws_set_proxy() - Setups proxy to lws_context.
2207 * \param vhost: pointer to struct lws_vhost you want set proxy for
2208 * \param proxy: pointer to c string containing proxy in format address:port
2210 * Returns 0 if proxy string was parsed and proxy was setup.
2211 * Returns -1 if proxy is NULL or has incorrect format.
2213 * This is only required if your OS does not provide the http_proxy
2214 * environment variable (eg, OSX)
2216 * IMPORTANT! You should call this function right after creation of the
2217 * lws_context and before call to connect. If you call this
2218 * function after connect behavior is undefined.
2219 * This function will override proxy settings made on lws_context
2220 * creation with genenv() call.
2222 LWS_VISIBLE LWS_EXTERN int
2223 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2226 * lws_set_socks() - Setup socks to lws_context.
2227 * \param vhost: pointer to struct lws_vhost you want set socks for
2228 * \param socks: pointer to c string containing socks in format address:port
2230 * Returns 0 if socks string was parsed and socks was setup.
2231 * Returns -1 if socks is NULL or has incorrect format.
2233 * This is only required if your OS does not provide the socks_proxy
2234 * environment variable (eg, OSX)
2236 * IMPORTANT! You should call this function right after creation of the
2237 * lws_context and before call to connect. If you call this
2238 * function after connect behavior is undefined.
2239 * This function will override proxy settings made on lws_context
2240 * creation with genenv() call.
2242 LWS_VISIBLE LWS_EXTERN int
2243 lws_set_socks(struct lws_vhost *vhost, const char *socks);
2248 * lws_create_vhost() - Create a vhost (virtual server context)
2249 * \param context: pointer to result of lws_create_context()
2250 * \param info: pointer to struct with parameters
2252 * This function creates a virtual server (vhost) using the vhost-related
2253 * members of the info struct. You can create many vhosts inside one context
2254 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2256 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2257 lws_create_vhost(struct lws_context *context,
2258 struct lws_context_creation_info *info);
2261 * lws_destroy_vhost() - Destroy a vhost (virtual server context)
2262 * \param vhost: pointer to result of lws_create_vhost()
2264 * This function destroys a vhost. Normally, if you just want to exit,
2265 * then lws_destroy_context() will take care of everything. If you want
2266 * to destroy an individual vhost and all connections and allocations, you
2267 * can do it with this.
2269 LWS_VISIBLE LWS_EXTERN void
2270 lws_vhost_destroy(struct lws_vhost *vh);
2273 * lwsws_get_config_globals() - Parse a JSON server config file
2274 * \param info: pointer to struct with parameters
2275 * \param d: filepath of the config file
2276 * \param config_strings: storage for the config strings extracted from JSON,
2277 * the pointer is incremented as strings are stored
2278 * \param len: pointer to the remaining length left in config_strings
2279 * the value is decremented as strings are stored
2281 * This function prepares a n lws_context_creation_info struct with global
2282 * settings from a file d.
2284 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2286 LWS_VISIBLE LWS_EXTERN int
2287 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2288 char **config_strings, int *len);
2291 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2292 * \param context: pointer to result of lws_create_context()
2293 * \param info: pointer to struct with parameters
2294 * \param d: filepath of the config file
2295 * \param config_strings: storage for the config strings extracted from JSON,
2296 * the pointer is incremented as strings are stored
2297 * \param len: pointer to the remaining length left in config_strings
2298 * the value is decremented as strings are stored
2300 * This function creates vhosts into a context according to the settings in
2301 *JSON files found in directory d.
2303 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2305 LWS_VISIBLE LWS_EXTERN int
2306 lwsws_get_config_vhosts(struct lws_context *context,
2307 struct lws_context_creation_info *info, const char *d,
2308 char **config_strings, int *len);
2310 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2311 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2312 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2315 * lws_get_vhost() - return the vhost a wsi belongs to
2317 * \param wsi: which connection
2319 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2320 lws_get_vhost(struct lws *wsi);
2323 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2325 * \param vh: the vhost
2326 * \param buf: buffer to fill with JSON
2327 * \param len: max length of buf
2329 LWS_VISIBLE LWS_EXTERN int
2330 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2333 * lws_json_dump_context() - describe context state and stats in JSON
2335 * \param context: the context
2336 * \param buf: buffer to fill with JSON
2337 * \param len: max length of buf
2339 LWS_VISIBLE LWS_EXTERN int
2340 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2344 * lws_context_user() - get the user data associated with the context
2345 * \param context: Websocket context
2347 * This returns the optional user allocation that can be attached to
2348 * the context the sockets live in at context_create time. It's a way
2349 * to let all sockets serviced in the same context share data without
2350 * using globals statics in the user code.
2352 LWS_VISIBLE LWS_EXTERN void *
2353 lws_context_user(struct lws_context *context);
2355 /*! \defgroup vhost-mounts Vhost mounts and options
2356 * \ingroup context-and-vhost-creation
2358 * ##Vhost mounts and options
2361 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2362 * name=value options
2364 * This provides a general way to attach a linked-list of name=value pairs,
2365 * which can also have an optional child link-list using the options member.
2367 struct lws_protocol_vhost_options {
2368 const struct lws_protocol_vhost_options *next; /**< linked list */
2369 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2370 const char *name; /**< name of name=value pair */
2371 const char *value; /**< value of name=value pair */
2374 /** enum lws_mount_protocols
2375 * This specifies the mount protocol for a mountpoint, whether it is to be
2376 * served from a filesystem, or it is a cgi etc.
2378 enum lws_mount_protocols {
2379 LWSMPRO_HTTP = 0, /**< http reverse proxy */
2380 LWSMPRO_HTTPS = 1, /**< https reverse proxy */
2381 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2382 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2383 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2384 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2385 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2388 /** struct lws_http_mount
2390 * arguments for mounting something in a vhost's url namespace
2392 struct lws_http_mount {
2393 const struct lws_http_mount *mount_next;
2394 /**< pointer to next struct lws_http_mount */
2395 const char *mountpoint;
2396 /**< mountpoint in http pathspace, eg, "/" */
2398 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2400 /**< default target, eg, "index.html" */
2401 const char *protocol;
2402 /**<"protocol-name" to handle mount */
2404 const struct lws_protocol_vhost_options *cgienv;
2405 /**< optional linked-list of cgi options. These are created
2406 * as environment variables for the cgi process
2408 const struct lws_protocol_vhost_options *extra_mimetypes;
2409 /**< optional linked-list of mimetype mappings */
2410 const struct lws_protocol_vhost_options *interpret;
2411 /**< optional linked-list of files to be interpreted */
2414 /**< seconds cgi is allowed to live, if cgi://mount type */
2416 /**< max-age for reuse of client cache of files, seconds */
2417 unsigned int auth_mask;
2418 /**< bits set here must be set for authorized client session */
2420 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2421 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2422 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2424 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2425 unsigned char mountpoint_len; /**< length of mountpoint string */
2427 const char *basic_auth_login_file;
2428 /**<NULL, or filepath to use to check basic auth logins against */
2430 /* Add new things just above here ---^
2431 * This is part of the ABI, don't needlessly break compatibility
2433 * The below is to ensure later library versions with new
2434 * members added above will see 0 (default) even if the app
2435 * was not built against the newer headers.
2438 void *_unused[2]; /**< dummy */
2443 /*! \defgroup client
2446 * ##Client releated functions
2450 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2451 * with struct lws_client_connect_info ssl_connection member to control if
2452 * and how SSL checks apply to the client connection being created
2455 enum lws_client_connect_ssl_connection_flags {
2456 LCCSCF_USE_SSL = (1 << 0),
2457 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2458 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2459 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2462 /** struct lws_client_connect_info - parameters to connect with when using
2463 * lws_client_connect_via_info() */
2465 struct lws_client_connect_info {
2466 struct lws_context *context;
2467 /**< lws context to create connection in */
2468 const char *address;
2469 /**< remote address to connect to */
2471 /**< remote port to connect to */
2473 /**< nonzero for ssl */
2477 /**< content of host header */
2479 /**< content of origin header */
2480 const char *protocol;
2481 /**< list of ws protocols we could accept */
2482 int ietf_version_or_minus_one;
2483 /**< deprecated: currently leave at 0 or -1 */
2485 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2486 const void *client_exts;
2487 /**< UNUSED... provide in info.extensions at context creation time */
2489 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2490 * use "GET" to be a simple http client connection */
2491 struct lws *parent_wsi;
2492 /**< if another wsi is responsible for this connection, give it here.
2493 * this is used to make sure if the parent closes so do any
2494 * child connections first. */
2495 const char *uri_replace_from;
2496 /**< if non-NULL, when this string is found in URIs in
2497 * text/html content-encoding, it's replaced with uri_replace_to */
2498 const char *uri_replace_to;
2499 /**< see uri_replace_from */
2500 struct lws_vhost *vhost;
2501 /**< vhost to bind to (used to determine related SSL_CTX) */
2503 /**< if not NULL, store the new wsi here early in the connection
2504 * process. Although we return the new wsi, the call to create the
2505 * client connection does progress the connection somewhat and may
2506 * meet an error that will result in the connection being scrubbed and
2507 * NULL returned. While the wsi exists though, he may process a
2508 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2509 * user callback a way to identify which wsi it is that faced the error
2510 * even before the new wsi is returned and even if ultimately no wsi
2514 /**< NULL to allow routing on any interface, or interface name or IP
2515 * to bind the socket to */
2517 /* Add new things just above here ---^
2518 * This is part of the ABI, don't needlessly break compatibility
2520 * The below is to ensure later library versions with new
2521 * members added above will see 0 (default) even if the app
2522 * was not built against the newer headers.
2525 void *_unused[4]; /**< dummy */
2529 * lws_client_connect_via_info() - Connect to another websocket server
2530 * \param ccinfo: pointer to lws_client_connect_info struct
2532 * This function creates a connection to a remote server using the
2533 * information provided in ccinfo.
2535 LWS_VISIBLE LWS_EXTERN struct lws *
2536 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2539 * lws_client_connect() - Connect to another websocket server
2540 * \deprecated DEPRECATED use lws_client_connect_via_info
2541 * \param clients: Websocket context
2542 * \param address: Remote server address, eg, "myserver.com"
2543 * \param port: Port to connect to on the remote server, eg, 80
2544 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2546 * \param path: Websocket path on server
2547 * \param host: Hostname on server
2548 * \param origin: Socket origin name
2549 * \param protocol: Comma-separated list of protocols being asked for from
2550 * the server, or just one. The server will pick the one it
2551 * likes best. If you don't want to specify a protocol, which is
2552 * legal, use NULL here.
2553 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2554 * protocol supported, or the specific protocol ordinal
2556 * This function creates a connection to a remote server
2558 /* deprecated, use lws_client_connect_via_info() */
2559 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2560 lws_client_connect(struct lws_context *clients, const char *address,
2561 int port, int ssl_connection, const char *path,
2562 const char *host, const char *origin, const char *protocol,
2563 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2564 /* deprecated, use lws_client_connect_via_info() */
2566 * lws_client_connect_extended() - Connect to another websocket server
2567 * \deprecated DEPRECATED use lws_client_connect_via_info
2568 * \param clients: Websocket context
2569 * \param address: Remote server address, eg, "myserver.com"
2570 * \param port: Port to connect to on the remote server, eg, 80
2571 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2573 * \param path: Websocket path on server
2574 * \param host: Hostname on server
2575 * \param origin: Socket origin name
2576 * \param protocol: Comma-separated list of protocols being asked for from
2577 * the server, or just one. The server will pick the one it
2579 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2580 * protocol supported, or the specific protocol ordinal
2581 * \param userdata: Pre-allocated user data
2583 * This function creates a connection to a remote server
2585 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2586 lws_client_connect_extended(struct lws_context *clients, const char *address,
2587 int port, int ssl_connection, const char *path,
2588 const char *host, const char *origin,
2589 const char *protocol, int ietf_version_or_minus_one,
2590 void *userdata) LWS_WARN_DEPRECATED;
2593 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2595 * \param info: client ssl related info
2596 * \param vhost: which vhost to initialize client ssl operations on
2598 * You only need to call this if you plan on using SSL client connections on
2599 * the vhost. For non-SSL client connections, it's not necessary to call this.
2601 * The following members of info are used during the call
2603 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2604 * otherwise the call does nothing
2605 * - provided_client_ssl_ctx must be NULL to get a generated client
2606 * ssl context, otherwise you can pass a prepared one in by setting it
2607 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2608 * - ssl_ca_filepath may be NULL or client cert filepath
2609 * - ssl_cert_filepath may be NULL or client cert filepath
2610 * - ssl_private_key_filepath may be NULL or client cert private key
2612 * You must create your vhost explicitly if you want to use this, so you have
2613 * a pointer to the vhost. Create the context first with the option flag
2614 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2615 * the same info struct.
2617 LWS_VISIBLE LWS_EXTERN int
2618 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2619 struct lws_vhost *vhost);
2621 * lws_http_client_read() - consume waiting received http client data
2623 * \param wsi: client connection
2624 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2625 * \param len: pointer to chunk length - fill with max length of buffer
2627 * This is called when the user code is notified client http data has arrived.
2628 * The user code may choose to delay calling it to consume the data, for example
2629 * waiting until an onward connection is writeable.
2631 * For non-chunked connections, up to len bytes of buf are filled with the
2632 * received content. len is set to the actual amount filled before return.
2634 * For chunked connections, the linear buffer content contains the chunking
2635 * headers and it cannot be passed in one lump. Instead, this function will
2636 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2637 * chunk start and len set to the chunk length. There will be as many calls
2638 * as there are chunks or partial chunks in the buffer.
2640 LWS_VISIBLE LWS_EXTERN int
2641 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2644 * lws_http_client_http_response() - get last HTTP response code
2646 * \param wsi: client connection
2648 * Returns the last server response code, eg, 200 for client http connections.
2650 LWS_VISIBLE LWS_EXTERN unsigned int
2651 lws_http_client_http_response(struct lws *wsi);
2653 LWS_VISIBLE LWS_EXTERN void
2654 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2657 * lws_client_http_body_pending() - control if client connection neeeds to send body
2659 * \param wsi: client connection
2660 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2661 * if nothing more to send
2663 * If you will send payload data with your HTTP client connection, eg, for POST,
2664 * when you set the related http headers in
2665 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2666 * this API with something_left_to_send nonzero, and call
2667 * lws_callback_on_writable(wsi);
2669 * After sending the headers, lws will call your callback with
2670 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2671 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2672 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2673 * let lws know the last part is sent and the connection can move on.
2678 /** \defgroup service Built-in service loop entry
2680 * ##Built-in service loop entry
2682 * If you're not using libev / libuv, these apis are needed to enter the poll()
2683 * wait in lws and service any connections with pending events.
2688 * lws_service() - Service any pending websocket activity
2689 * \param context: Websocket context
2690 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2691 * service otherwise block and service immediately, returning
2692 * after the timeout if nothing needed service.
2694 * This function deals with any pending websocket traffic, for three
2695 * kinds of event. It handles these events on both server and client
2696 * types of connection the same.
2698 * 1) Accept new connections to our context's server
2700 * 2) Call the receive callback for incoming frame data received by
2701 * server or client connections.
2703 * You need to call this service function periodically to all the above
2704 * functions to happen; if your application is single-threaded you can
2705 * just call it in your main event loop.
2707 * Alternatively you can fork a new process that asynchronously handles
2708 * calling this service in a loop. In that case you are happy if this
2709 * call blocks your thread until it needs to take care of something and
2710 * would call it with a large nonzero timeout. Your loop then takes no
2711 * CPU while there is nothing happening.
2713 * If you are calling it in a single-threaded app, you don't want it to
2714 * wait around blocking other things in your loop from happening, so you
2715 * would call it with a timeout_ms of 0, so it returns immediately if
2716 * nothing is pending, or as soon as it services whatever was pending.
2718 LWS_VISIBLE LWS_EXTERN int
2719 lws_service(struct lws_context *context, int timeout_ms);
2722 * lws_service() - Service any pending websocket activity
2724 * \param context: Websocket context
2725 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2726 * service otherwise block and service immediately, returning
2727 * after the timeout if nothing needed service.
2729 * Same as lws_service(), but for a specific thread service index. Only needed
2730 * if you are spawning multiple service threads.
2732 LWS_VISIBLE LWS_EXTERN int
2733 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2736 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2738 * \param wsi: Cancel service on the thread this wsi is serviced by
2740 * This function lets a call to lws_service() waiting for a timeout
2741 * immediately return.
2743 * It works by creating a phony event and then swallowing it silently.
2745 * The reason it may be needed is when waiting in poll(), changes to
2746 * the event masks are ignored by the OS until poll() is reentered. This
2747 * lets you halt the poll() wait and make the reentry happen immediately
2748 * instead of having the wait out the rest of the poll timeout.
2750 LWS_VISIBLE LWS_EXTERN void
2751 lws_cancel_service_pt(struct lws *wsi);
2754 * lws_cancel_service() - Cancel wait for new pending socket activity
2755 * \param context: Websocket context
2757 * This function let a call to lws_service() waiting for a timeout
2758 * immediately return.
2760 * What it basically does is provide a fake event that will be swallowed,
2761 * so the wait in poll() is ended. That's useful because poll() doesn't
2762 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2764 LWS_VISIBLE LWS_EXTERN void
2765 lws_cancel_service(struct lws_context *context);
2768 * lws_service_fd() - Service polled socket with something waiting
2769 * \param context: Websocket context
2770 * \param pollfd: The pollfd entry describing the socket fd and which events
2771 * happened, or NULL to tell lws to do only timeout servicing.
2773 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2774 * services it according to the state of the associated
2777 * The one call deals with all "service" that might happen on a socket
2778 * including listen accepts, http files as well as websocket protocol.
2780 * If a pollfd says it has something, you can just pass it to
2781 * lws_service_fd() whether it is a socket handled by lws or not.
2782 * If it sees it is a lws socket, the traffic will be handled and
2783 * pollfd->revents will be zeroed now.
2785 * If the socket is foreign to lws, it leaves revents alone. So you can
2786 * see if you should service yourself by checking the pollfd revents
2787 * after letting lws try to service it.
2789 * You should also call this with pollfd = NULL to just allow the
2790 * once-per-second global timeout checks; if less than a second since the last
2791 * check it returns immediately then.
2793 LWS_VISIBLE LWS_EXTERN int
2794 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2797 * lws_service_fd_tsi() - Service polled socket in specific service thread
2798 * \param context: Websocket context
2799 * \param pollfd: The pollfd entry describing the socket fd and which events
2801 * \param tsi: thread service index
2803 * Same as lws_service_fd() but used with multiple service threads
2805 LWS_VISIBLE LWS_EXTERN int
2806 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2810 * lws_service_adjust_timeout() - Check for any connection needing forced service
2811 * \param context: Websocket context
2812 * \param timeout_ms: The original poll timeout value. You can just set this
2813 * to 1 if you don't really have a poll timeout.
2814 * \param tsi: thread service index
2816 * Under some conditions connections may need service even though there is no
2817 * pending network action on them, this is "forced service". For default
2818 * poll() and libuv / libev, the library takes care of calling this and
2819 * dealing with it for you. But for external poll() integration, you need
2820 * access to the apis.
2822 * If anybody needs "forced service", returned timeout is zero. In that case,
2823 * you can call lws_service_tsi() with a timeout of -1 to only service
2824 * guys who need forced service.
2826 LWS_VISIBLE LWS_EXTERN int
2827 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2829 /* Backwards compatibility */
2830 #define lws_plat_service_tsi lws_service_tsi
2832 LWS_VISIBLE LWS_EXTERN int
2833 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
2837 /*! \defgroup http HTTP
2839 Modules related to handling HTTP
2843 /*! \defgroup httpft HTTP File transfer
2846 APIs for sending local files in response to HTTP requests
2851 * lws_get_mimetype() - Determine mimetype to use from filename
2853 * \param file: filename
2854 * \param m: NULL, or mount context
2856 * This uses a canned list of known filetypes first, if no match and m is
2857 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2859 * Returns either NULL or a pointer to the mimetype matching the file.
2861 LWS_VISIBLE LWS_EXTERN const char *
2862 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2865 * lws_serve_http_file() - Send a file back to the client using http
2866 * \param wsi: Websocket instance (available from user callback)
2867 * \param file: The file to issue over http
2868 * \param content_type: The http content type, eg, text/html
2869 * \param other_headers: NULL or pointer to header string
2870 * \param other_headers_len: length of the other headers if non-NULL
2872 * This function is intended to be called from the callback in response
2873 * to http requests from the client. It allows the callback to issue
2874 * local files down the http link in a single step.
2876 * Returning <0 indicates error and the wsi should be closed. Returning
2877 * >0 indicates the file was completely sent and
2878 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2879 * ==0 indicates the file transfer is started and needs more service later,
2880 * the wsi should be left alone.
2882 LWS_VISIBLE LWS_EXTERN int
2883 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2884 const char *other_headers, int other_headers_len);
2886 LWS_VISIBLE LWS_EXTERN int
2887 lws_serve_http_file_fragment(struct lws *wsi);
2890 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2893 * ##HTML chunked Substitution
2895 * APIs for receiving chunks of text, replacing a set of variable names via
2896 * a callback, and then prepending and appending HTML chunked encoding
2902 HTTP_STATUS_OK = 200,
2903 HTTP_STATUS_NO_CONTENT = 204,
2904 HTTP_STATUS_PARTIAL_CONTENT = 206,
2906 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2907 HTTP_STATUS_FOUND = 302,
2908 HTTP_STATUS_SEE_OTHER = 303,
2909 HTTP_STATUS_NOT_MODIFIED = 304,
2911 HTTP_STATUS_BAD_REQUEST = 400,
2912 HTTP_STATUS_UNAUTHORIZED,
2913 HTTP_STATUS_PAYMENT_REQUIRED,
2914 HTTP_STATUS_FORBIDDEN,
2915 HTTP_STATUS_NOT_FOUND,
2916 HTTP_STATUS_METHOD_NOT_ALLOWED,
2917 HTTP_STATUS_NOT_ACCEPTABLE,
2918 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2919 HTTP_STATUS_REQUEST_TIMEOUT,
2920 HTTP_STATUS_CONFLICT,
2922 HTTP_STATUS_LENGTH_REQUIRED,
2923 HTTP_STATUS_PRECONDITION_FAILED,
2924 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2925 HTTP_STATUS_REQ_URI_TOO_LONG,
2926 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2927 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2928 HTTP_STATUS_EXPECTATION_FAILED,
2930 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2931 HTTP_STATUS_NOT_IMPLEMENTED,
2932 HTTP_STATUS_BAD_GATEWAY,
2933 HTTP_STATUS_SERVICE_UNAVAILABLE,
2934 HTTP_STATUS_GATEWAY_TIMEOUT,
2935 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2938 struct lws_process_html_args {
2939 char *p; /**< pointer to the buffer containing the data */
2940 int len; /**< length of the original data at p */
2941 int max_len; /**< maximum length we can grow the data to */
2942 int final; /**< set if this is the last chunk of the file */
2945 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2947 struct lws_process_html_state {
2948 char *start; /**< pointer to start of match */
2949 char swallow[16]; /**< matched character buffer */
2950 int pos; /**< position in match */
2951 void *data; /**< opaque pointer */
2952 const char * const *vars; /**< list of variable names */
2953 int count_vars; /**< count of variable names */
2955 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2958 /*! lws_chunked_html_process() - generic chunked substitution
2959 * \param args: buffer to process using chunked encoding
2960 * \param s: current processing state
2962 LWS_VISIBLE LWS_EXTERN int
2963 lws_chunked_html_process(struct lws_process_html_args *args,
2964 struct lws_process_html_state *s);
2967 /** \defgroup HTTP-headers-read HTTP headers: read
2970 * ##HTTP header releated functions
2972 * In lws the client http headers are temporarily stored in a pool, only for the
2973 * duration of the http part of the handshake. It's because in most cases,
2974 * the header content is ignored for the whole rest of the connection lifetime
2975 * and would then just be taking up space needlessly.
2977 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2978 * the http headers are still allocated, you can use these apis then to
2979 * look at and copy out interesting header content (cookies, etc)
2981 * Notice that the header total length reported does not include a terminating
2982 * '\0', however you must allocate for it when using the _copy apis. So the
2983 * length reported for a header containing "123" is 3, but you must provide
2984 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2985 * will fail with a nonzero return code.
2987 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2988 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2989 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2990 * length to confirm the method.
2992 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2993 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2994 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2996 * As a convenience, lws has an api that will find the fragment with a
2997 * given name= part, lws_get_urlarg_by_name().
3001 /** struct lws_tokens
3002 * you need these to look at headers that have been parsed if using the
3003 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
3004 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
3005 * points to .token_len chars containing that header content.
3008 char *token; /**< pointer to start of the token */
3009 int token_len; /**< length of the token's value */
3012 /* enum lws_token_indexes
3013 * these have to be kept in sync with lextable.h / minilex.c
3015 * NOTE: These public enums are part of the abi. If you want to add one,
3016 * add it at where specified so existing users are unaffected.
3018 enum lws_token_indexes {
3019 WSI_TOKEN_GET_URI = 0,
3020 WSI_TOKEN_POST_URI = 1,
3021 WSI_TOKEN_OPTIONS_URI = 2,
3023 WSI_TOKEN_CONNECTION = 4,
3024 WSI_TOKEN_UPGRADE = 5,
3025 WSI_TOKEN_ORIGIN = 6,
3026 WSI_TOKEN_DRAFT = 7,
3027 WSI_TOKEN_CHALLENGE = 8,
3028 WSI_TOKEN_EXTENSIONS = 9,
3029 WSI_TOKEN_KEY1 = 10,
3030 WSI_TOKEN_KEY2 = 11,
3031 WSI_TOKEN_PROTOCOL = 12,
3032 WSI_TOKEN_ACCEPT = 13,
3033 WSI_TOKEN_NONCE = 14,
3034 WSI_TOKEN_HTTP = 15,
3035 WSI_TOKEN_HTTP2_SETTINGS = 16,
3036 WSI_TOKEN_HTTP_ACCEPT = 17,
3037 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
3038 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
3039 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
3040 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
3041 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
3042 WSI_TOKEN_HTTP_PRAGMA = 23,
3043 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
3044 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
3045 WSI_TOKEN_HTTP_COOKIE = 26,
3046 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
3047 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
3048 WSI_TOKEN_HTTP_DATE = 29,
3049 WSI_TOKEN_HTTP_RANGE = 30,
3050 WSI_TOKEN_HTTP_REFERER = 31,
3052 WSI_TOKEN_VERSION = 33,
3053 WSI_TOKEN_SWORIGIN = 34,
3055 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
3056 WSI_TOKEN_HTTP_COLON_METHOD = 36,
3057 WSI_TOKEN_HTTP_COLON_PATH = 37,
3058 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
3059 WSI_TOKEN_HTTP_COLON_STATUS = 39,
3061 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
3062 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
3063 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
3064 WSI_TOKEN_HTTP_AGE = 43,
3065 WSI_TOKEN_HTTP_ALLOW = 44,
3066 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
3067 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
3068 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
3069 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
3070 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
3071 WSI_TOKEN_HTTP_ETAG = 50,
3072 WSI_TOKEN_HTTP_EXPECT = 51,
3073 WSI_TOKEN_HTTP_EXPIRES = 52,
3074 WSI_TOKEN_HTTP_FROM = 53,
3075 WSI_TOKEN_HTTP_IF_MATCH = 54,
3076 WSI_TOKEN_HTTP_IF_RANGE = 55,
3077 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
3078 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
3079 WSI_TOKEN_HTTP_LINK = 58,
3080 WSI_TOKEN_HTTP_LOCATION = 59,
3081 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
3082 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
3083 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
3084 WSI_TOKEN_HTTP_REFRESH = 63,
3085 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
3086 WSI_TOKEN_HTTP_SERVER = 65,
3087 WSI_TOKEN_HTTP_SET_COOKIE = 66,
3088 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
3089 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
3090 WSI_TOKEN_HTTP_USER_AGENT = 69,
3091 WSI_TOKEN_HTTP_VARY = 70,
3092 WSI_TOKEN_HTTP_VIA = 71,
3093 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
3095 WSI_TOKEN_PATCH_URI = 73,
3096 WSI_TOKEN_PUT_URI = 74,
3097 WSI_TOKEN_DELETE_URI = 75,
3099 WSI_TOKEN_HTTP_URI_ARGS = 76,
3100 WSI_TOKEN_PROXY = 77,
3101 WSI_TOKEN_HTTP_X_REAL_IP = 78,
3102 WSI_TOKEN_HTTP1_0 = 79,
3103 WSI_TOKEN_X_FORWARDED_FOR = 80,
3104 WSI_TOKEN_CONNECT = 81,
3105 /****** add new things just above ---^ ******/
3107 /* use token storage to stash these internally, not for
3110 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
3111 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
3112 _WSI_TOKEN_CLIENT_URI,
3113 _WSI_TOKEN_CLIENT_HOST,
3114 _WSI_TOKEN_CLIENT_ORIGIN,
3115 _WSI_TOKEN_CLIENT_METHOD,
3116 _WSI_TOKEN_CLIENT_IFACE,
3118 /* always last real token index*/
3121 /* parser state additions, no storage associated */
3122 WSI_TOKEN_NAME_PART,
3124 WSI_TOKEN_SKIPPING_SAW_CR,
3125 WSI_PARSING_COMPLETE,
3126 WSI_INIT_TOKEN_MUXURL,
3129 struct lws_token_limits {
3130 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
3134 * lws_token_to_string() - returns a textual representation of a hdr token index
3136 * \param: token index
3138 LWS_VISIBLE LWS_EXTERN const unsigned char *
3139 lws_token_to_string(enum lws_token_indexes token);
3143 * lws_hdr_total_length: report length of all fragments of a header totalled up
3144 * The returned length does not include the space for a
3147 * \param wsi: websocket connection
3148 * \param h: which header index we are interested in
3150 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3151 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
3154 * lws_hdr_fragment_length: report length of a single fragment of a header
3155 * The returned length does not include the space for a
3158 * \param wsi: websocket connection
3159 * \param h: which header index we are interested in
3160 * \param frag_idx: which fragment of h we want to get the length of
3162 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3163 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
3166 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
3167 * The buffer length len must include space for an additional
3168 * terminating '\0', or it will fail returning -1.
3170 * \param wsi: websocket connection
3171 * \param dest: destination buffer
3172 * \param len: length of destination buffer
3173 * \param h: which header index we are interested in
3175 * copies the whole, aggregated header, even if it was delivered in
3176 * several actual headers piece by piece
3178 LWS_VISIBLE LWS_EXTERN int
3179 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
3182 * lws_hdr_copy_fragment() - copy a single fragment of the given header to a buffer
3183 * The buffer length len must include space for an additional
3184 * terminating '\0', or it will fail returning -1.
3185 * If the requested fragment index is not present, it fails
3188 * \param wsi: websocket connection
3189 * \param dest: destination buffer
3190 * \param len: length of destination buffer
3191 * \param h: which header index we are interested in
3192 * \param frag_idx: which fragment of h we want to copy
3194 * Normally this is only useful
3195 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
3196 * fragment 0 will contain "x=1" and fragment 1 "y=2"
3198 LWS_VISIBLE LWS_EXTERN int
3199 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
3200 enum lws_token_indexes h, int frag_idx);
3203 * lws_get_urlarg_by_name() - return pointer to arg value if present
3204 * \param wsi: the connection to check
3205 * \param name: the arg name, like "token="
3206 * \param buf: the buffer to receive the urlarg (including the name= part)
3207 * \param len: the length of the buffer to receive the urlarg
3209 * Returns NULL if not found or a pointer inside buf to just after the
3212 LWS_VISIBLE LWS_EXTERN const char *
3213 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
3216 /*! \defgroup HTTP-headers-create HTTP headers: create
3218 * ## HTTP headers: Create
3220 * These apis allow you to create HTTP response headers in a way compatible with
3221 * both HTTP/1.x and HTTP/2.
3223 * They each append to a buffer taking care about the buffer end, which is
3224 * passed in as a pointer. When data is written to the buffer, the current
3225 * position p is updated accordingly.
3227 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3228 * and fail with nonzero return.
3232 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3233 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3236 * lws_add_http_header_status() - add the HTTP response status code
3238 * \param wsi: the connection to check
3239 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3240 * \param p: pointer to current position in buffer pointer
3241 * \param end: pointer to end of buffer
3243 * Adds the initial response code, so should be called first.
3245 * Code may additionally take OR'd flags:
3247 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3249 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3250 lws_add_http_header_status(struct lws *wsi,
3251 unsigned int code, unsigned char **p,
3252 unsigned char *end);
3254 * lws_add_http_header_by_name() - append named header and value
3256 * \param wsi: the connection to check
3257 * \param name: the hdr name, like "my-header"
3258 * \param value: the value after the = for this header
3259 * \param length: the length of the value
3260 * \param p: pointer to current position in buffer pointer
3261 * \param end: pointer to end of buffer
3263 * Appends name: value to the headers
3265 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3266 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3267 const unsigned char *value, int length,
3268 unsigned char **p, unsigned char *end);
3270 * lws_add_http_header_by_token() - append given header and value
3272 * \param wsi: the connection to check
3273 * \param token: the token index for the hdr
3274 * \param value: the value after the = for this header
3275 * \param length: the length of the value
3276 * \param p: pointer to current position in buffer pointer
3277 * \param end: pointer to end of buffer
3279 * Appends name=value to the headers, but is able to take advantage of better
3280 * HTTP/2 coding mechanisms where possible.
3282 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3283 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3284 const unsigned char *value, int length,
3285 unsigned char **p, unsigned char *end);
3287 * lws_add_http_header_content_length() - append content-length helper
3289 * \param wsi: the connection to check
3290 * \param content_length: the content length to use
3291 * \param p: pointer to current position in buffer pointer
3292 * \param end: pointer to end of buffer
3294 * Appends content-length: content_length to the headers
3296 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3297 lws_add_http_header_content_length(struct lws *wsi,
3298 lws_filepos_t content_length,
3299 unsigned char **p, unsigned char *end);
3301 * lws_finalize_http_header() - terminate header block
3303 * \param wsi: the connection to check
3304 * \param p: pointer to current position in buffer pointer
3305 * \param end: pointer to end of buffer
3307 * Indicates no more headers will be added
3309 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3310 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3311 unsigned char *end);
3314 /** \defgroup form-parsing Form Parsing
3316 * ##POSTed form parsing functions
3318 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3319 * POSTed form arguments, both using simple urlencoded and multipart transfer
3322 * It's capable of handling file uploads as well a named input parsing,
3323 * and the apis are the same for both form upload styles.
3325 * You feed it a list of parameter names and it creates pointers to the
3326 * urldecoded arguments: file upload parameters pass the file data in chunks to
3327 * a user-supplied callback as they come.
3329 * Since it's stateful, it handles the incoming data needing more than one
3330 * POST_BODY callback and has no limit on uploaded file size.
3334 /** enum lws_spa_fileupload_states */
3335 enum lws_spa_fileupload_states {
3337 /**< a chunk of file content has arrived */
3338 LWS_UFS_FINAL_CONTENT,
3339 /**< the last chunk (possibly zero length) of file content has arrived */
3341 /**< a new file is starting to arrive */
3345 * lws_spa_fileupload_cb() - callback to receive file upload data
3347 * \param data: opt_data pointer set in lws_spa_create
3348 * \param name: name of the form field being uploaded
3349 * \param filename: original filename from client
3350 * \param buf: start of data to receive
3351 * \param len: length of data to receive
3352 * \param state: information about how this call relates to file
3354 * Notice name and filename shouldn't be trusted, as they are passed from
3355 * HTTP provided by the client.
3357 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3358 const char *filename, char *buf, int len,
3359 enum lws_spa_fileupload_states state);
3361 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3362 * and file uploads */
3366 * lws_spa_create() - create urldecode parser
3368 * \param wsi: lws connection (used to find Content Type)
3369 * \param param_names: array of form parameter names, like "username"
3370 * \param count_params: count of param_names
3371 * \param max_storage: total amount of form parameter values we can store
3372 * \param opt_cb: NULL, or callback to receive file upload data.
3373 * \param opt_data: NULL, or user pointer provided to opt_cb.
3375 * Creates a urldecode parser and initializes it.
3377 * opt_cb can be NULL if you just want normal name=value parsing, however
3378 * if one or more entries in your form are bulk data (file transfer), you
3379 * can provide this callback and filter on the name callback parameter to
3380 * treat that urldecoded data separately. The callback should return -1
3381 * in case of fatal error, and 0 if OK.
3383 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3384 lws_spa_create(struct lws *wsi, const char * const *param_names,
3385 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3389 * lws_spa_process() - parses a chunk of input data
3391 * \param spa: the parser object previously created
3392 * \param in: incoming, urlencoded data
3393 * \param len: count of bytes valid at \param in
3395 LWS_VISIBLE LWS_EXTERN int
3396 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3399 * lws_spa_finalize() - indicate incoming data completed
3401 * \param spa: the parser object previously created
3403 LWS_VISIBLE LWS_EXTERN int
3404 lws_spa_finalize(struct lws_spa *spa);
3407 * lws_spa_get_length() - return length of parameter value
3409 * \param spa: the parser object previously created
3410 * \param n: parameter ordinal to return length of value for
3412 LWS_VISIBLE LWS_EXTERN int
3413 lws_spa_get_length(struct lws_spa *spa, int n);
3416 * lws_spa_get_string() - return pointer to parameter value
3417 * \param spa: the parser object previously created
3418 * \param n: parameter ordinal to return pointer to value for
3420 LWS_VISIBLE LWS_EXTERN const char *
3421 lws_spa_get_string(struct lws_spa *spa, int n);
3424 * lws_spa_destroy() - destroy parser object
3426 * \param spa: the parser object previously created
3428 LWS_VISIBLE LWS_EXTERN int
3429 lws_spa_destroy(struct lws_spa *spa);
3432 /*! \defgroup urlendec Urlencode and Urldecode
3435 * ##HTML chunked Substitution
3437 * APIs for receiving chunks of text, replacing a set of variable names via
3438 * a callback, and then prepending and appending HTML chunked encoding
3444 * lws_urlencode() - like strncpy but with urlencoding
3446 * \param escaped: output buffer
3447 * \param string: input buffer ('/0' terminated)
3448 * \param len: output buffer max length
3450 * Because urlencoding expands the output string, it's not
3451 * possible to do it in-place, ie, with escaped == string
3453 LWS_VISIBLE LWS_EXTERN const char *
3454 lws_urlencode(char *escaped, const char *string, int len);
3459 * This simple urldecode only operates until the first '\0' and requires the
3460 * data to exist all at once
3463 * lws_urldecode() - like strncpy but with urldecoding
3465 * \param string: output buffer
3466 * \param escaped: input buffer ('\0' terminated)
3467 * \param len: output buffer max length
3469 * This is only useful for '\0' terminated strings
3471 * Since urldecoding only shrinks the output string, it is possible to
3472 * do it in-place, ie, string == escaped
3474 LWS_VISIBLE LWS_EXTERN int
3475 lws_urldecode(char *string, const char *escaped, int len);
3478 * lws_return_http_status() - Return simple http status
3479 * \param wsi: Websocket instance (available from user callback)
3480 * \param code: Status index, eg, 404
3481 * \param html_body: User-readable HTML description < 1KB, or NULL
3483 * Helper to report HTTP errors back to the client cleanly and
3486 LWS_VISIBLE LWS_EXTERN int
3487 lws_return_http_status(struct lws *wsi, unsigned int code,
3488 const char *html_body);
3491 * lws_http_redirect() - write http redirect into buffer
3493 * \param wsi: websocket connection
3494 * \param code: HTTP response code (eg, 301)
3495 * \param loc: where to redirect to
3496 * \param len: length of loc
3497 * \param p: pointer current position in buffer (updated as we write)
3498 * \param end: pointer to end of buffer
3500 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3501 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3502 unsigned char **p, unsigned char *end);
3505 * lws_http_transaction_completed() - wait for new http transaction or close
3506 * \param wsi: websocket connection
3508 * Returns 1 if the HTTP connection must close now
3509 * Returns 0 and resets connection to wait for new HTTP header /
3510 * transaction if possible
3512 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3513 lws_http_transaction_completed(struct lws *wsi);
3516 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3518 * ##Sanitize / purify SQL and JSON helpers
3520 * APIs for escaping untrusted JSON and SQL safely before use
3525 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3527 * \param escaped: output buffer
3528 * \param string: input buffer ('/0' terminated)
3529 * \param len: output buffer max length
3531 * Because escaping expands the output string, it's not
3532 * possible to do it in-place, ie, with escaped == string
3534 LWS_VISIBLE LWS_EXTERN const char *
3535 lws_sql_purify(char *escaped, const char *string, int len);
3538 * lws_json_purify() - like strncpy but with escaping for json chars
3540 * \param escaped: output buffer
3541 * \param string: input buffer ('/0' terminated)
3542 * \param len: output buffer max length
3544 * Because escaping expands the output string, it's not
3545 * possible to do it in-place, ie, with escaped == string
3547 LWS_VISIBLE LWS_EXTERN const char *
3548 lws_json_purify(char *escaped, const char *string, int len);
3551 /*! \defgroup ev libev helpers
3555 * APIs specific to libev event loop itegration
3559 #ifdef LWS_USE_LIBEV
3560 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3562 LWS_VISIBLE LWS_EXTERN int
3563 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3564 lws_ev_signal_cb_t *cb);
3566 LWS_VISIBLE LWS_EXTERN int
3567 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3569 LWS_VISIBLE LWS_EXTERN void
3570 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3571 #endif /* LWS_USE_LIBEV */
3575 /*! \defgroup uv libuv helpers
3579 * APIs specific to libuv event loop itegration
3582 #ifdef LWS_USE_LIBUV
3583 LWS_VISIBLE LWS_EXTERN int
3584 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3587 LWS_VISIBLE LWS_EXTERN void
3588 lws_libuv_run(const struct lws_context *context, int tsi);
3590 LWS_VISIBLE LWS_EXTERN void
3591 lws_libuv_stop(struct lws_context *context);
3593 LWS_VISIBLE LWS_EXTERN void
3594 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3596 LWS_VISIBLE LWS_EXTERN int
3597 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3599 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3600 lws_uv_getloop(struct lws_context *context, int tsi);
3602 LWS_VISIBLE LWS_EXTERN void
3603 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3605 LWS_VISIBLE LWS_EXTERN void
3606 lws_close_all_handles_in_loop(uv_loop_t *loop);
3607 #endif /* LWS_USE_LIBUV */
3610 /*! \defgroup event libevent helpers
3612 * ##libevent helpers
3614 * APIs specific to libevent event loop itegration
3618 #ifdef LWS_USE_LIBEVENT
3619 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3622 LWS_VISIBLE LWS_EXTERN int
3623 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3624 lws_event_signal_cb_t cb);
3626 LWS_VISIBLE LWS_EXTERN int
3627 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3630 LWS_VISIBLE LWS_EXTERN void
3631 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3633 #endif /* LWS_USE_LIBEVENT */
3637 /*! \defgroup timeout Connection timeouts
3639 APIs related to setting connection timeouts
3644 * NOTE: These public enums are part of the abi. If you want to add one,
3645 * add it at where specified so existing users are unaffected.
3647 enum pending_timeout {
3648 NO_PENDING_TIMEOUT = 0,
3649 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3650 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3651 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3652 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3653 PENDING_TIMEOUT_AWAITING_PING = 5,
3654 PENDING_TIMEOUT_CLOSE_ACK = 6,
3655 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3656 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3657 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3658 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3659 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3660 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3661 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3662 PENDING_TIMEOUT_CGI = 14,
3663 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3664 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3665 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3666 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3667 PENDING_TIMEOUT_AWAITING_SOCKS_GREETING_REPLY = 19,
3668 PENDING_TIMEOUT_AWAITING_SOCKS_CONNECT_REPLY = 20,
3669 PENDING_TIMEOUT_AWAITING_SOCKS_AUTH_REPLY = 21,
3670 PENDING_TIMEOUT_KILLED_BY_SSL_INFO = 22,
3671 PENDING_TIMEOUT_KILLED_BY_PARENT = 23,
3672 PENDING_TIMEOUT_CLOSE_SEND = 24,
3674 /****** add new things just above ---^ ******/
3677 #define LWS_TO_KILL_ASYNC -1
3678 /**< If LWS_TO_KILL_ASYNC is given as the timeout sec in a lws_set_timeout()
3679 * call, then the connection is marked to be killed at the next timeout
3680 * check. This is how you should force-close the wsi being serviced if
3681 * you are doing it outside the callback (where you should close by nonzero
3684 #define LWS_TO_KILL_SYNC -2
3685 /**< If LWS_TO_KILL_SYNC is given as the timeout sec in a lws_set_timeout()
3686 * call, then the connection is closed before returning (which may delete
3687 * the wsi). This should only be used where the wsi being closed is not the
3688 * wsi currently being serviced.
3691 * lws_set_timeout() - marks the wsi as subject to a timeout
3693 * You will not need this unless you are doing something special
3695 * \param wsi: Websocket connection instance
3696 * \param reason: timeout reason
3697 * \param secs: how many seconds. You may set to LWS_TO_KILL_ASYNC to
3698 * force the connection to timeout at the next opportunity, or
3699 * LWS_TO_KILL_SYNC to close it synchronously if you know the
3700 * wsi is not the one currently being serviced.
3702 LWS_VISIBLE LWS_EXTERN void
3703 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3706 /*! \defgroup sending-data Sending data
3708 APIs related to writing data on a connection
3711 #if !defined(LWS_SIZEOFPTR)
3712 #define LWS_SIZEOFPTR (sizeof (void *))
3714 #if !defined(u_int64_t)
3715 #define u_int64_t unsigned long long
3718 #if defined(__x86_64__)
3719 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3721 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3723 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3724 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3725 /* last 2 is for lws-meta */
3726 #define LWS_PRE _LWS_PAD(4 + 10 + 2)
3727 /* used prior to 1.7 and retained for backward compatibility */
3728 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3729 #define LWS_SEND_BUFFER_POST_PADDING 0
3732 * NOTE: These public enums are part of the abi. If you want to add one,
3733 * add it at where specified so existing users are unaffected.
3735 enum lws_write_protocol {
3737 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3738 * memory behind it. The receiver expects only valid utf-8 in the
3740 LWS_WRITE_BINARY = 1,
3741 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3742 * memory behind it. Any sequence of bytes is valid */
3743 LWS_WRITE_CONTINUATION = 2,
3744 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3745 * memory behind it */
3747 /**< Send HTTP content */
3749 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3753 /* Same as write_http but we know this write ends the transaction */
3754 LWS_WRITE_HTTP_FINAL = 7,
3758 LWS_WRITE_HTTP_HEADERS = 8,
3759 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3760 * payload differently, http 1.x links also handle this correctly. so
3761 * to be compatible with both in the future,header response part should
3762 * be sent using this regardless of http version expected)
3765 /****** add new things just above ---^ ******/
3769 LWS_WRITE_NO_FIN = 0x40,
3770 /**< This part of the message is not the end of the message */
3772 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3773 /**< client packet payload goes out on wire unmunged
3774 * only useful for security tests since normal servers cannot
3775 * decode the content if used */
3778 /* used with LWS_CALLBACK_CHILD_WRITE_VIA_PARENT */
3780 struct lws_write_passthru {
3784 enum lws_write_protocol wp;
3789 * lws_write() - Apply protocol then write data to client
3790 * \param wsi: Websocket instance (available from user callback)
3791 * \param buf: The data to send. For data being sent on a websocket
3792 * connection (ie, not default http), this buffer MUST have
3793 * LWS_PRE bytes valid BEFORE the pointer.
3794 * This is so the protocol header data can be added in-situ.
3795 * \param len: Count of the data bytes in the payload starting from buf
3796 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3797 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3798 * data on a websockets connection. Remember to allow the extra
3799 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3802 * This function provides the way to issue data back to the client
3803 * for both http and websocket protocols.
3807 * When sending with websocket protocol
3811 * LWS_WRITE_CONTINUATION,
3815 * the send buffer has to have LWS_PRE bytes valid BEFORE
3816 * the buffer pointer you pass to lws_write().
3818 * This allows us to add protocol info before and after the data, and send as
3819 * one packet on the network without payload copying, for maximum efficiency.
3821 * So for example you need this kind of code to use lws_write with a
3824 * char buf[LWS_PRE + 128];
3826 * // fill your part of the buffer... for example here it's all zeros
3827 * memset(&buf[LWS_PRE], 0, 128);
3829 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3831 * When sending HTTP, with
3834 * LWS_WRITE_HTTP_HEADERS
3835 * LWS_WRITE_HTTP_FINAL
3837 * there is no protocol data prepended, and don't need to take care about the
3838 * LWS_PRE bytes valid before the buffer pointer.
3840 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3841 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3842 * The example apps no longer use it.
3844 * Pad LWS_PRE to the CPU word size, so that word references
3845 * to the address immediately after the padding won't cause an unaligned access
3846 * error. Sometimes for performance reasons the recommended padding is even
3847 * larger than sizeof(void *).
3849 * In the case of sending using websocket protocol, be sure to allocate
3850 * valid storage before and after buf as explained above. This scheme
3851 * allows maximum efficiency of sending data and protocol in a single
3852 * packet while not burdening the user code with any protocol knowledge.
3854 * Return may be -1 for a fatal error needing connection close, or the
3855 * number of bytes sent.
3860 * The OS may not accept everything you asked to write on the connection.
3862 * Posix defines POLLOUT indication from poll() to show that the connection
3863 * will accept more write data, but it doesn't specifiy how much. It may just
3864 * accept one byte of whatever you wanted to send.
3866 * LWS will buffer the remainder automatically, and send it out autonomously.
3868 * During that time, WRITABLE callbacks will be suppressed.
3870 * This is to handle corner cases where unexpectedly the OS refuses what we
3871 * usually expect it to accept. You should try to send in chunks that are
3872 * almost always accepted in order to avoid the inefficiency of the buffering.
3874 LWS_VISIBLE LWS_EXTERN int
3875 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3876 enum lws_write_protocol protocol);
3878 /* helper for case where buffer may be const */
3879 #define lws_write_http(wsi, buf, len) \
3880 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3883 /** \defgroup callback-when-writeable Callback when writeable
3885 * ##Callback When Writeable
3887 * lws can only write data on a connection when it is able to accept more
3888 * data without blocking.
3890 * So a basic requirement is we should only use the lws_write() apis when the
3891 * connection we want to write on says that he can accept more data.
3893 * When lws cannot complete your send at the time, it will buffer the data
3894 * and send it in the background, suppressing any further WRITEABLE callbacks
3895 * on that connection until it completes. So it is important to write new
3896 * things in a new writeable callback.
3898 * These apis reflect the various ways we can indicate we would like to be
3899 * called back when one or more connections is writeable.
3904 * lws_callback_on_writable() - Request a callback when this socket
3905 * becomes able to be written to without
3908 * \param wsi: Websocket connection instance to get callback for
3910 * - Which: only this wsi
3911 * - When: when the individual connection becomes writeable
3912 * - What: LWS_CALLBACK_*_WRITEABLE
3914 LWS_VISIBLE LWS_EXTERN int
3915 lws_callback_on_writable(struct lws *wsi);
3918 * lws_callback_on_writable_all_protocol() - Request a callback for all
3919 * connections on same vhost using the given protocol when it
3920 * becomes possible to write to each socket without
3923 * \param context: lws_context
3924 * \param protocol: Protocol whose connections will get callbacks
3926 * - Which: connections using this protocol on ANY VHOST
3927 * - When: when the individual connection becomes writeable
3928 * - What: LWS_CALLBACK_*_WRITEABLE
3930 LWS_VISIBLE LWS_EXTERN int
3931 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3932 const struct lws_protocols *protocol);
3935 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3936 * all connections using the given protocol when it
3937 * becomes possible to write to each socket without
3940 * \param vhost: Only consider connections on this lws_vhost
3941 * \param protocol: Protocol whose connections will get callbacks
3943 * - Which: connections using this protocol on GIVEN VHOST ONLY
3944 * - When: when the individual connection becomes writeable
3945 * - What: LWS_CALLBACK_*_WRITEABLE
3947 LWS_VISIBLE LWS_EXTERN int
3948 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3949 const struct lws_protocols *protocol);
3952 * lws_callback_all_protocol() - Callback all connections using
3953 * the given protocol with the given reason
3955 * \param context: lws_context
3956 * \param protocol: Protocol whose connections will get callbacks
3957 * \param reason: Callback reason index
3959 * - Which: connections using this protocol on ALL VHOSTS
3960 * - When: before returning
3963 * This isn't normally what you want... normally any update of connection-
3964 * specific information can wait until a network-related callback like rx,
3965 * writable, or close.
3967 LWS_VISIBLE LWS_EXTERN int
3968 lws_callback_all_protocol(struct lws_context *context,
3969 const struct lws_protocols *protocol, int reason);
3972 * lws_callback_all_protocol_vhost() - Callback all connections using
3973 * the given protocol with the given reason
3975 * \param vh: Vhost whose connections will get callbacks
3976 * \param protocol: Which protocol to match
3977 * \param reason: Callback reason index
3979 * - Which: connections using this protocol on GIVEN VHOST ONLY
3983 LWS_VISIBLE LWS_EXTERN int
3984 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3985 const struct lws_protocols *protocol, int reason);
3988 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3989 * with the given reason
3991 * \param wsi: wsi whose vhost will get callbacks
3992 * \param reason: Callback reason index
3993 * \param in: in argument to callback
3994 * \param len: len argument to callback
3996 * - Which: connections using this protocol on same VHOST as wsi ONLY
4000 LWS_VISIBLE LWS_EXTERN int
4001 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
4003 LWS_VISIBLE LWS_EXTERN int
4004 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
4005 void *user, void *in, size_t len);
4008 * lws_get_socket_fd() - returns the socket file descriptor
4010 * You will not need this unless you are doing something special
4012 * \param wsi: Websocket connection instance
4014 LWS_VISIBLE LWS_EXTERN int
4015 lws_get_socket_fd(struct lws *wsi);
4018 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
4021 * \param wsi: Websocket connection instance
4023 * if the protocol does not have any guidance, returns -1. Currently only
4024 * http2 connections get send window information from this API. But your code
4025 * should use it so it can work properly with any protocol.
4027 * If nonzero return is the amount of payload data the peer or intermediary has
4028 * reported it has buffer space for. That has NO relationship with the amount
4029 * of buffer space your OS can accept on this connection for a write action.
4031 * This number represents the maximum you could send to the peer or intermediary
4032 * on this connection right now without the protocol complaining.
4034 * lws manages accounting for send window updates and payload writes
4035 * automatically, so this number reflects the situation at the peer or
4036 * intermediary dynamically.
4038 LWS_VISIBLE LWS_EXTERN size_t
4039 lws_get_peer_write_allowance(struct lws *wsi);
4043 * lws_rx_flow_control() - Enable and disable socket servicing for
4046 * If the output side of a server process becomes choked, this allows flow
4047 * control for the input side.
4049 * \param wsi: Websocket connection instance to get callback for
4050 * \param enable: 0 = disable read servicing for this connection, 1 = enable
4052 LWS_VISIBLE LWS_EXTERN int
4053 lws_rx_flow_control(struct lws *wsi, int enable);
4056 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
4058 * When the user server code realizes it can accept more input, it can
4059 * call this to have the RX flow restriction removed from all connections using
4060 * the given protocol.
4061 * \param context: lws_context
4062 * \param protocol: all connections using this protocol will be allowed to receive
4064 LWS_VISIBLE LWS_EXTERN void
4065 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
4066 const struct lws_protocols *protocol);
4069 * lws_remaining_packet_payload() - Bytes to come before "overall"
4070 * rx packet is complete
4071 * \param wsi: Websocket instance (available from user callback)
4073 * This function is intended to be called from the callback if the
4074 * user code is interested in "complete packets" from the client.
4075 * libwebsockets just passes through payload as it comes and issues a buffer
4076 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
4077 * callback handler can use this API to find out if the buffer it has just
4078 * been given is the last piece of a "complete packet" from the client --
4079 * when that is the case lws_remaining_packet_payload() will return
4082 * Many protocols won't care becuse their packets are always small.
4084 LWS_VISIBLE LWS_EXTERN size_t
4085 lws_remaining_packet_payload(struct lws *wsi);
4088 /** \defgroup sock-adopt Socket adoption helpers
4089 * ##Socket adoption helpers
4091 * When integrating with an external app with its own event loop, these can
4092 * be used to accept connections from someone else's listening socket.
4094 * When using lws own event loop, these are not needed.
4099 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
4100 * for the default vhost of context.
4101 * \param context: lws context
4102 * \param accept_fd: fd of already-accepted socket to adopt
4104 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4105 * returns NULL, having cleaned up any new wsi pieces.
4107 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4108 * to ws or just serve http.
4110 LWS_VISIBLE LWS_EXTERN struct lws *
4111 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
4113 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
4115 * \param vhost: lws vhost
4116 * \param accept_fd: fd of already-accepted socket to adopt
4118 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4119 * returns NULL, having cleaned up any new wsi pieces.
4121 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4122 * to ws or just serve http.
4124 LWS_VISIBLE LWS_EXTERN struct lws *
4125 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
4128 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
4129 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
4130 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
4131 LWS_ADOPT_ALLOW_SSL = 4, /* flag: if set requires LWS_ADOPT_SOCKET */
4132 LWS_ADOPT_WS_PARENTIO = 8, /* flag: ws mode parent handles IO
4133 * if given must be only flag
4134 * wsi put directly into ws mode
4136 } lws_adoption_type;
4139 lws_sockfd_type sockfd;
4140 lws_filefd_type filefd;
4141 } lws_sock_file_fd_type;
4144 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
4145 * if socket descriptor, should already have been accepted from listen socket
4147 * \param vhost: lws vhost
4148 * \param type: OR-ed combinations of lws_adoption_type flags
4149 * \param fd: union with either .sockfd or .filefd set
4150 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
4151 * \param parent: NULL or struct lws to attach new_wsi to as a child
4153 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4154 * returns NULL, having cleaned up any new wsi pieces.
4156 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
4157 * ready to accept an upgrade to ws or just serve http.
4159 * parent may be NULL, if given it should be an existing wsi that will become the
4160 * parent of the new wsi created by this call.
4162 LWS_VISIBLE LWS_EXTERN struct lws *
4163 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
4164 lws_sock_file_fd_type fd, const char *vh_prot_name,
4165 struct lws *parent);
4168 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
4169 * for the default vhost of context.
4170 * \param context: lws context
4171 * \param accept_fd: fd of already-accepted socket to adopt
4172 * \param readbuf: NULL or pointer to data that must be drained before reading from
4174 * \param len: The length of the data held at \param readbuf
4176 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4177 * returns NULL, having cleaned up any new wsi pieces.
4179 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4180 * to ws or just serve http.
4182 * If your external code did not already read from the socket, you can use
4183 * lws_adopt_socket() instead.
4185 * This api is guaranteed to use the data at \param readbuf first, before reading from
4188 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4190 LWS_VISIBLE LWS_EXTERN struct lws *
4191 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
4192 const char *readbuf, size_t len);
4194 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
4195 * accepted it for vhost.
4196 * \param vhost: lws vhost
4197 * \param accept_fd: fd of already-accepted socket to adopt
4198 * \param readbuf: NULL or pointer to data that must be drained before reading from
4200 * \param len: The length of the data held at \param readbuf
4202 * Either returns new wsi bound to accept_fd, or closes accept_fd and
4203 * returns NULL, having cleaned up any new wsi pieces.
4205 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
4206 * to ws or just serve http.
4208 * If your external code did not already read from the socket, you can use
4209 * lws_adopt_socket() instead.
4211 * This api is guaranteed to use the data at \param readbuf first, before reading from
4214 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
4216 LWS_VISIBLE LWS_EXTERN struct lws *
4217 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
4218 const char *readbuf, size_t len);
4221 /** \defgroup net Network related helper APIs
4222 * ##Network related helper APIs
4224 * These wrap miscellaneous useful network-related functions
4229 * lws_canonical_hostname() - returns this host's hostname
4231 * This is typically used by client code to fill in the host parameter
4232 * when making a client connection. You can only call it after the context
4235 * \param context: Websocket context
4237 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4238 lws_canonical_hostname(struct lws_context *context);
4241 * lws_get_peer_addresses() - Get client address information
4242 * \param wsi: Local struct lws associated with
4243 * \param fd: Connection socket descriptor
4244 * \param name: Buffer to take client address name
4245 * \param name_len: Length of client address name buffer
4246 * \param rip: Buffer to take client address IP dotted quad
4247 * \param rip_len: Length of client address IP buffer
4249 * This function fills in name and rip with the name and IP of
4250 * the client connected with socket descriptor fd. Names may be
4251 * truncated if there is not enough room. If either cannot be
4252 * determined, they will be returned as valid zero-length strings.
4254 LWS_VISIBLE LWS_EXTERN void
4255 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
4256 int name_len, char *rip, int rip_len);
4259 * lws_get_peer_simple() - Get client address information without RDNS
4261 * \param wsi: Local struct lws associated with
4262 * \param name: Buffer to take client address name
4263 * \param namelen: Length of client address name buffer
4265 * This provides a 123.123.123.123 type IP address in name from the
4266 * peer that has connected to wsi
4268 LWS_VISIBLE LWS_EXTERN const char *
4269 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4270 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4272 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4274 * \param ipv6: Allow IPV6 addresses
4275 * \param ifname: Interface name or IP
4276 * \param addr: struct sockaddr_in * to be written
4277 * \param addrlen: Length of addr
4279 * This converts a textual network interface name to a sockaddr usable by
4280 * other network functions
4282 LWS_VISIBLE LWS_EXTERN int
4283 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4288 /** \defgroup misc Miscellaneous APIs
4289 * ##Miscellaneous APIs
4291 * Various APIs outside of other categories
4296 * lws_start_foreach_ll(): linkedlist iterator helper start
4298 * \param type: type of iteration, eg, struct xyz *
4299 * \param it: iterator var name to create
4300 * \param start: start of list
4302 * This helper creates an iterator and starts a while (it) {
4303 * loop. The iterator runs through the linked list starting at start and
4304 * ends when it gets a NULL.
4305 * The while loop should be terminated using lws_start_foreach_ll().
4307 #define lws_start_foreach_ll(type, it, start)\
4313 * lws_end_foreach_ll(): linkedlist iterator helper end
4315 * \param it: same iterator var name given when starting
4316 * \param nxt: member name in the iterator pointing to next list element
4318 * This helper is the partner for lws_start_foreach_ll() that ends the
4322 #define lws_end_foreach_ll(it, nxt) \
4328 * lws_start_foreach_llp(): linkedlist pointer iterator helper start
4330 * \param type: type of iteration, eg, struct xyz **
4331 * \param it: iterator var name to create
4332 * \param start: start of list
4334 * This helper creates an iterator and starts a while (it) {
4335 * loop. The iterator runs through the linked list starting at the
4336 * address of start and ends when it gets a NULL.
4337 * The while loop should be terminated using lws_start_foreach_llp().
4339 * This helper variant iterates using a pointer to the previous linked-list
4340 * element. That allows you to easily delete list members by rewriting the
4341 * previous pointer to the element's next pointer.
4343 #define lws_start_foreach_llp(type, it, start)\
4345 type it = &(start); \
4349 * lws_end_foreach_llp(): linkedlist pointer iterator helper end
4351 * \param it: same iterator var name given when starting
4352 * \param nxt: member name in the iterator pointing to next list element
4354 * This helper is the partner for lws_start_foreach_llp() that ends the
4358 #define lws_end_foreach_llp(it, nxt) \
4359 it = &(*(it))->nxt; \
4364 * lws_snprintf(): snprintf that truncates the returned length too
4366 * \param str: destination buffer
4367 * \param size: bytes left in destination buffer
4368 * \param format: format string
4369 * \param ...: args for format
4371 * This lets you correctly truncate buffers by concatenating lengths, if you
4372 * reach the limit the reported length doesn't exceed the limit.
4374 LWS_VISIBLE LWS_EXTERN int
4375 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4378 * lws_get_random(): fill a buffer with platform random data
4380 * \param context: the lws context
4381 * \param buf: buffer to fill
4382 * \param len: how much to fill
4384 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4385 * it's interested to see if the frame it's dealing with was sent in binary
4388 LWS_VISIBLE LWS_EXTERN int
4389 lws_get_random(struct lws_context *context, void *buf, int len);
4391 * lws_daemonize(): make current process run in the background
4393 * \param _lock_path: the filepath to write the lock file
4395 * Spawn lws as a background process, taking care of various things
4397 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4398 lws_daemonize(const char *_lock_path);
4400 * lws_get_library_version(): return string describing the version of lws
4402 * On unix, also includes the git describe
4404 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4405 lws_get_library_version(void);
4408 * lws_wsi_user() - get the user data associated with the connection
4409 * \param wsi: lws connection
4411 * Not normally needed since it's passed into the callback
4413 LWS_VISIBLE LWS_EXTERN void *
4414 lws_wsi_user(struct lws *wsi);
4417 * lws_wsi_set_user() - set the user data associated with the client connection
4418 * \param wsi: lws connection
4419 * \param user: user data
4421 * By default lws allocates this and it's not legal to externally set it
4422 * yourself. However client connections may have it set externally when the
4423 * connection is created... if so, this api can be used to modify it at
4424 * runtime additionally.
4426 LWS_VISIBLE LWS_EXTERN void
4427 lws_set_wsi_user(struct lws *wsi, void *user);
4430 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4431 * Notice it does so by dropping '\0' into input string
4432 * and the leading / on the path is consequently lost
4434 * \param p: incoming uri string.. will get written to
4435 * \param prot: result pointer for protocol part (https://)
4436 * \param ads: result pointer for address part
4437 * \param port: result pointer for port part
4438 * \param path: result pointer for path part
4440 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4441 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4445 * lws_now_secs(): return seconds since 1970-1-1
4447 LWS_VISIBLE LWS_EXTERN unsigned long
4451 * lws_get_context - Allow geting lws_context from a Websocket connection
4454 * With this function, users can access context in the callback function.
4455 * Otherwise users may have to declare context as a global variable.
4457 * \param wsi: Websocket connection instance
4459 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4460 lws_get_context(const struct lws *wsi);
4463 * lws_get_count_threads(): how many service threads the context uses
4465 * \param context: the lws context
4467 * By default this is always 1, if you asked for more than lws can handle it
4468 * will clip the number of threads. So you can use this to find out how many
4469 * threads are actually in use.
4471 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4472 lws_get_count_threads(struct lws_context *context);
4475 * lws_get_parent() - get parent wsi or NULL
4476 * \param wsi: lws connection
4478 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4479 * this allows you to get their parent.
4481 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4482 lws_get_parent(const struct lws *wsi);
4485 * lws_get_child() - get child wsi or NULL
4486 * \param wsi: lws connection
4488 * Allows you to find a related wsi from the parent wsi.
4490 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4491 lws_get_child(const struct lws *wsi);
4494 * lws_parent_carries_io() - mark wsi as needing to send messages via parent
4496 * \param wsi: child lws connection
4499 LWS_VISIBLE LWS_EXTERN void
4500 lws_set_parent_carries_io(struct lws *wsi);
4502 LWS_VISIBLE LWS_EXTERN void *
4503 lws_get_opaque_parent_data(const struct lws *wsi);
4505 LWS_VISIBLE LWS_EXTERN void
4506 lws_set_opaque_parent_data(struct lws *wsi, void *data);
4508 LWS_VISIBLE LWS_EXTERN int
4509 lws_get_child_pending_on_writable(const struct lws *wsi);
4511 LWS_VISIBLE LWS_EXTERN void
4512 lws_clear_child_pending_on_writable(struct lws *wsi);
4514 LWS_VISIBLE LWS_EXTERN int
4515 lws_get_close_length(struct lws *wsi);
4517 LWS_VISIBLE LWS_EXTERN unsigned char *
4518 lws_get_close_payload(struct lws *wsi);
4521 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4522 * It's provided in case it is
4523 * useful when integrating with other app poll loop service code.
4525 LWS_VISIBLE LWS_EXTERN int
4526 lws_read(struct lws *wsi, unsigned char *buf, lws_filepos_t len);
4529 * lws_set_allocator() - custom allocator support
4533 * Allows you to replace the allocator (and deallocator) used by lws
4535 LWS_VISIBLE LWS_EXTERN void
4536 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4539 /** \defgroup wsstatus Websocket status APIs
4540 * ##Websocket connection status APIs
4542 * These provide information about ws connection or message status
4546 * lws_send_pipe_choked() - tests if socket is writable or not
4547 * \param wsi: lws connection
4549 * Allows you to check if you can write more on the socket
4551 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4552 lws_send_pipe_choked(struct lws *wsi);
4555 * lws_is_final_fragment() - tests if last part of ws message
4557 * \param wsi: lws connection
4559 LWS_VISIBLE LWS_EXTERN int
4560 lws_is_final_fragment(struct lws *wsi);
4563 * lws_is_first_fragment() - tests if first part of ws message
4565 * \param wsi: lws connection
4567 LWS_VISIBLE LWS_EXTERN int
4568 lws_is_first_fragment(struct lws *wsi);
4571 * lws_get_reserved_bits() - access reserved bits of ws frame
4572 * \param wsi: lws connection
4574 LWS_VISIBLE LWS_EXTERN unsigned char
4575 lws_get_reserved_bits(struct lws *wsi);
4578 * lws_partial_buffered() - find out if lws buffered the last write
4579 * \param wsi: websocket connection to check
4581 * Returns 1 if you cannot use lws_write because the last
4582 * write on this connection is still buffered, and can't be cleared without
4583 * returning to the service loop and waiting for the connection to be
4586 * If you will try to do >1 lws_write call inside a single
4587 * WRITEABLE callback, you must check this after every write and bail if
4588 * set, ask for a new writeable callback and continue writing from there.
4590 * This is never set at the start of a writeable callback, but any write
4593 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4594 lws_partial_buffered(struct lws *wsi);
4597 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4599 * \param wsi: the connection we are inquiring about
4601 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4602 * it's interested to see if the frame it's dealing with was sent in binary
4605 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4606 lws_frame_is_binary(struct lws *wsi);
4609 * lws_is_ssl() - Find out if connection is using SSL
4610 * \param wsi: websocket connection to check
4612 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4613 * using verified cert, and 2 if using SSL but the cert was not
4614 * checked (appears for client wsi told to skip check on connection)
4616 LWS_VISIBLE LWS_EXTERN int
4617 lws_is_ssl(struct lws *wsi);
4619 * lws_is_cgi() - find out if this wsi is running a cgi process
4620 * \param wsi: lws connection
4622 LWS_VISIBLE LWS_EXTERN int
4623 lws_is_cgi(struct lws *wsi);
4625 #ifdef LWS_OPENSSL_SUPPORT
4627 * lws_get_ssl() - Return wsi's SSL context structure
4628 * \param wsi: websocket connection
4630 * Returns pointer to the SSL library's context structure
4632 LWS_VISIBLE LWS_EXTERN SSL*
4633 lws_get_ssl(struct lws *wsi);
4638 /** \defgroup sha SHA and B64 helpers
4639 * ##SHA and B64 helpers
4641 * These provide SHA-1 and B64 helper apis
4644 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4645 #define lws_SHA1 SHA1
4648 * lws_SHA1(): make a SHA-1 digest of a buffer
4650 * \param d: incoming buffer
4651 * \param n: length of incoming buffer
4652 * \param md: buffer for message digest (must be >= 20 bytes)
4654 * Reduces any size buffer into a 20-byte SHA-1 hash.
4656 LWS_VISIBLE LWS_EXTERN unsigned char *
4657 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4660 * lws_b64_encode_string(): encode a string into base 64
4662 * \param in: incoming buffer
4663 * \param in_len: length of incoming buffer
4664 * \param out: result buffer
4665 * \param out_size: length of result buffer
4667 * Encodes a string using b64
4669 LWS_VISIBLE LWS_EXTERN int
4670 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4672 * lws_b64_decode_string(): decode a string from base 64
4674 * \param in: incoming buffer
4675 * \param out: result buffer
4676 * \param out_size: length of result buffer
4678 * Decodes a string using b64
4680 LWS_VISIBLE LWS_EXTERN int
4681 lws_b64_decode_string(const char *in, char *out, int out_size);
4685 /*! \defgroup cgi cgi handling
4689 * These functions allow low-level control over stdin/out/err of the cgi.
4691 * However for most cases, binding the cgi to http in and out, the default
4692 * lws implementation already does the right thing.
4695 enum lws_enum_stdinouterr {
4701 enum lws_cgi_hdr_state {
4713 struct lws_cgi_args {
4714 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4715 enum lws_enum_stdinouterr ch; /**< channel index */
4716 unsigned char *data; /**< for messages with payload */
4717 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4718 int len; /**< length */
4723 * lws_cgi: spawn network-connected cgi process
4725 * \param wsi: connection to own the process
4726 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4727 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4728 * \param timeout_secs: seconds script should be allowed to run
4729 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4731 LWS_VISIBLE LWS_EXTERN int
4732 lws_cgi(struct lws *wsi, const char * const *exec_array,
4733 int script_uri_path_len, int timeout_secs,
4734 const struct lws_protocol_vhost_options *mp_cgienv);
4737 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4739 * \param wsi: connection to own the process
4741 LWS_VISIBLE LWS_EXTERN int
4742 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4745 * lws_cgi_kill: terminate cgi process associated with wsi
4747 * \param wsi: connection to own the process
4749 LWS_VISIBLE LWS_EXTERN int
4750 lws_cgi_kill(struct lws *wsi);
4755 /*! \defgroup fops file operation wrapping
4757 * ##File operation wrapping
4759 * Use these helper functions if you want to access a file from the perspective
4760 * of a specific wsi, which is usually the case. If you just want contextless
4761 * file access, use the fops callbacks directly with NULL wsi instead of these
4764 * If so, then it calls the platform handler or user overrides where present
4765 * (as defined in info->fops)
4767 * The advantage from all this is user code can be portable for file operations
4768 * without having to deal with differences between platforms.
4772 /** struct lws_plat_file_ops - Platform-specific file operations
4774 * These provide platform-agnostic ways to deal with filesystem access in the
4775 * library and in the user code.
4778 #if defined(LWS_WITH_ESP32)
4779 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4780 #define LWS_FOP_OPEN _open
4781 #define LWS_FOP_CLOSE _close
4782 #define LWS_FOP_SEEK_CUR _seek_cur
4783 #define LWS_FOP_READ _read
4784 #define LWS_FOP_WRITE _write
4786 #define LWS_FOP_OPEN open
4787 #define LWS_FOP_CLOSE close
4788 #define LWS_FOP_SEEK_CUR seek_cur
4789 #define LWS_FOP_READ read
4790 #define LWS_FOP_WRITE write
4793 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4794 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4795 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4796 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4797 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4799 struct lws_plat_file_ops;
4803 /**< real file descriptor related to the file... */
4804 const struct lws_plat_file_ops *fops;
4805 /**< fops that apply to this fop_fd */
4806 void *filesystem_priv;
4807 /**< ignored by lws; owned by the fops handlers */
4809 /**< generic "position in file" */
4811 /**< generic "length of file" */
4812 lws_fop_flags_t flags;
4813 /**< copy of the returned flags */
4815 /**< optional "modification time of file", only valid if .open()
4816 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4818 typedef struct lws_fop_fd *lws_fop_fd_t;
4820 struct lws_fops_index {
4821 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4822 uint8_t len; /* length of above string */
4825 struct lws_plat_file_ops {
4826 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4827 const char *filename, const char *vpath,
4828 lws_fop_flags_t *flags);
4829 /**< Open file (always binary access if plat supports it)
4830 * vpath may be NULL, or if the fops understands it, the point at which
4831 * the filename's virtual part starts.
4832 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4833 * If the file may be gzip-compressed,
4834 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4835 * gzip-compressed, then the open handler should OR
4836 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4838 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4839 /**< close file AND set the pointer to NULL */
4840 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4841 lws_fileofs_t offset_from_cur_pos);
4842 /**< seek from current position */
4843 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4844 uint8_t *buf, lws_filepos_t len);
4845 /**< Read from file, on exit *amount is set to amount actually read */
4846 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4847 uint8_t *buf, lws_filepos_t len);
4848 /**< Write to file, on exit *amount is set to amount actually written */
4850 struct lws_fops_index fi[3];
4851 /**< vfs path signatures implying use of this fops */
4853 const struct lws_plat_file_ops *next;
4854 /**< NULL or next fops in list */
4856 /* Add new things just above here ---^
4857 * This is part of the ABI, don't needlessly break compatibility */
4861 * lws_get_fops() - get current file ops
4863 * \param context: context
4865 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4866 lws_get_fops(struct lws_context *context);
4867 LWS_VISIBLE LWS_EXTERN void
4868 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4870 * lws_vfs_tell() - get current file position
4872 * \param fop_fd: fop_fd we are asking about
4874 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4875 lws_vfs_tell(lws_fop_fd_t fop_fd);
4877 * lws_vfs_get_length() - get current file total length in bytes
4879 * \param fop_fd: fop_fd we are asking about
4881 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4882 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4884 * lws_vfs_get_mod_time() - get time file last modified
4886 * \param fop_fd: fop_fd we are asking about
4888 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4889 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4891 * lws_vfs_file_seek_set() - seek relative to start of file
4893 * \param fop_fd: fop_fd we are seeking in
4894 * \param offset: offset from start of file
4896 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4897 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4899 * lws_vfs_file_seek_end() - seek relative to end of file
4901 * \param fop_fd: fop_fd we are seeking in
4902 * \param offset: offset from start of file
4904 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4905 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4907 extern struct lws_plat_file_ops fops_zip;
4910 * lws_plat_file_open() - open vfs filepath
4912 * \param fops: file ops struct that applies to this descriptor
4913 * \param vfs_path: filename to open
4914 * \param flags: pointer to open flags
4916 * The vfs_path is scanned for known fops signatures, and the open directed
4917 * to any matching fops open.
4919 * User code should use this api to perform vfs opens.
4921 * returns semi-opaque handle
4923 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4924 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4925 lws_fop_flags_t *flags);
4928 * lws_plat_file_close() - close file
4930 * \param fop_fd: file handle to close
4932 static LWS_INLINE int
4933 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4935 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4939 * lws_plat_file_seek_cur() - close file
4942 * \param fop_fd: file handle
4943 * \param offset: position to seek to
4945 static LWS_INLINE lws_fileofs_t
4946 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4948 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4951 * lws_plat_file_read() - read from file
4953 * \param fop_fd: file handle
4954 * \param amount: how much to read (rewritten by call)
4955 * \param buf: buffer to write to
4956 * \param len: max length
4958 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4959 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4960 uint8_t *buf, lws_filepos_t len)
4962 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4965 * lws_plat_file_write() - write from file
4967 * \param fop_fd: file handle
4968 * \param amount: how much to write (rewritten by call)
4969 * \param buf: buffer to read from
4970 * \param len: max length
4972 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4973 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4974 uint8_t *buf, lws_filepos_t len)
4976 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4979 /* these are the platform file operations implementations... they can
4980 * be called directly and used in fops arrays
4983 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4984 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4985 const char *vpath, lws_fop_flags_t *flags);
4986 LWS_VISIBLE LWS_EXTERN int
4987 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4988 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4989 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4990 LWS_VISIBLE LWS_EXTERN int
4991 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4992 uint8_t *buf, lws_filepos_t len);
4993 LWS_VISIBLE LWS_EXTERN int
4994 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4995 uint8_t *buf, lws_filepos_t len);
4997 LWS_VISIBLE LWS_EXTERN int
4998 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4999 lws_filepos_t *amount);
5004 * ##SMTP related functions
5006 * These apis let you communicate with a local SMTP server to send email from
5007 * lws. It handles all the SMTP sequencing and protocol actions.
5009 * Your system should have postfix, sendmail or another MTA listening on port
5010 * 25 and able to send email using the "mail" commandline app. Usually distro
5011 * MTAs are configured for this by default.
5013 * It runs via its own libuv events if initialized (which requires giving it
5014 * a libuv loop to attach to).
5016 * It operates using three callbacks, on_next() queries if there is a new email
5017 * to send, on_get_body() asks for the body of the email, and on_sent() is
5018 * called after the email is successfully sent.
5022 * - create an lws_email struct
5024 * - initialize data, loop, the email_* strings, max_content_size and
5027 * - call lws_email_init()
5029 * When you have at least one email to send, call lws_email_check() to
5030 * schedule starting to send it.
5033 #ifdef LWS_WITH_SMTP
5035 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
5036 enum lwsgs_smtp_states {
5037 LGSSMTP_IDLE, /**< awaiting new email */
5038 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
5039 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
5040 LGSSMTP_SENT_HELO, /**< sent the HELO */
5041 LGSSMTP_SENT_FROM, /**< sent FROM */
5042 LGSSMTP_SENT_TO, /**< sent TO */
5043 LGSSMTP_SENT_DATA, /**< sent DATA request */
5044 LGSSMTP_SENT_BODY, /**< sent the email body */
5045 LGSSMTP_SENT_QUIT, /**< sent the session quit */
5048 /** struct lws_email - abstract context for performing SMTP operations */
5051 /**< opaque pointer set by user code and available to the callbacks */
5053 /**< the libuv loop we will work on */
5055 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
5056 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
5057 char email_from[100]; /**< Fill before init or on_next */
5058 char email_to[100]; /**< Fill before init or on_next */
5060 unsigned int max_content_size;
5061 /**< largest possible email body size */
5063 /* Fill all the callbacks before init */
5065 int (*on_next)(struct lws_email *email);
5066 /**< (Fill in before calling lws_email_init)
5067 * called when idle, 0 = another email to send, nonzero is idle.
5068 * If you return 0, all of the email_* char arrays must be set
5069 * to something useful. */
5070 int (*on_sent)(struct lws_email *email);
5071 /**< (Fill in before calling lws_email_init)
5072 * called when transfer of the email to the SMTP server was
5073 * successful, your callback would remove the current email
5075 int (*on_get_body)(struct lws_email *email, char *buf, int len);
5076 /**< (Fill in before calling lws_email_init)
5077 * called when the body part of the queued email is about to be
5078 * sent to the SMTP server. */
5081 /* private things */
5082 uv_timer_t timeout_email; /**< private */
5083 enum lwsgs_smtp_states estate; /**< private */
5084 uv_connect_t email_connect_req; /**< private */
5085 uv_tcp_t email_client; /**< private */
5086 time_t email_connect_started; /**< private */
5087 char email_buf[256]; /**< private */
5088 char *content; /**< private */
5092 * lws_email_init() - Initialize a struct lws_email
5094 * \param email: struct lws_email to init
5095 * \param loop: libuv loop to use
5096 * \param max_content: max email content size
5098 * Prepares a struct lws_email for use ending SMTP
5100 LWS_VISIBLE LWS_EXTERN int
5101 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
5104 * lws_email_check() - Request check for new email
5106 * \param email: struct lws_email context to check
5108 * Schedules a check for new emails in 1s... call this when you have queued an
5111 LWS_VISIBLE LWS_EXTERN void
5112 lws_email_check(struct lws_email *email);
5114 * lws_email_destroy() - stop using the struct lws_email
5116 * \param email: the struct lws_email context
5118 * Stop sending email using email and free allocations
5120 LWS_VISIBLE LWS_EXTERN void
5121 lws_email_destroy(struct lws_email *email);
5127 * Stats are all uint64_t numbers that start at 0.
5128 * Index names here have the convention
5132 * _MS_ millisecond count
5136 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
5137 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
5138 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
5139 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
5140 LWSSTATS_C_API_WRITE, /**< count calls to write API */
5141 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
5142 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
5143 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
5144 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
5145 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
5146 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
5147 LWSSTATS_C_SSL_CONNS_HAD_RX, /**< count of accepted SSL conns that have had some RX */
5148 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
5149 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
5150 LWSSTATS_B_READ, /**< aggregate bytes read */
5151 LWSSTATS_B_WRITE, /**< aggregate bytes written */
5152 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
5153 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
5154 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
5155 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
5156 LWSSTATS_MS_SSL_RX_DELAY, /**< aggregate delay between ssl accept complete and first RX */
5158 /* Add new things just above here ---^
5159 * This is part of the ABI, don't needlessly break compatibility */
5163 #if defined(LWS_WITH_STATS)
5165 LWS_VISIBLE LWS_EXTERN uint64_t
5166 lws_stats_get(struct lws_context *context, int index);
5167 LWS_VISIBLE LWS_EXTERN void
5168 lws_stats_log_dump(struct lws_context *context);
5170 static LWS_INLINE uint64_t
5171 lws_stats_get(struct lws_context *context, int index) { return 0; }
5172 static LWS_INLINE void
5173 lws_stats_log_dump(struct lws_context *context) { }
projects / platform / upstream / libwebsockets.git / blob