2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
24 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
25 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
36 #if defined(LWS_WITH_ESP8266)
43 #include "lws_config.h"
45 #if defined(WIN32) || defined(_WIN32)
46 #ifndef WIN32_LEAN_AND_MEAN
47 #define WIN32_LEAN_AND_MEAN
57 #define _O_RDONLY 0x0000
58 #define O_RDONLY _O_RDONLY
61 // Visual studio older than 2015 and WIN_CE has only _stricmp
62 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_WIN32_WCE)
63 #define strcasecmp _stricmp
64 #elif !defined(__MINGW32__)
65 #define strcasecmp stricmp
67 #define getdtablesize() 30000
69 #define LWS_INLINE __inline
71 #define LWS_WARN_UNUSED_RESULT
72 #define LWS_WARN_DEPRECATED
73 #define LWS_FORMAT(string_index)
77 #define LWS_EXTERN extern __declspec(dllexport)
79 #define LWS_EXTERN extern __declspec(dllimport)
85 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
86 #define LWS_O_RDONLY _O_RDONLY
87 #define LWS_O_WRONLY _O_WRONLY
88 #define LWS_O_CREAT _O_CREAT
89 #define LWS_O_TRUNC _O_TRUNC
91 #if !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER < 1900) /* Visual Studio 2015 already defines this in <stdio.h> */
92 #define lws_snprintf _snprintf
96 #define __func__ __FUNCTION__
99 #if !defined(__MINGW32__) &&(!defined(_MSC_VER) || _MSC_VER < 1900) && !defined(snprintf)
100 #define snprintf(buf,len, format,...) _snprintf_s(buf, len,len, format, __VA_ARGS__)
103 #else /* NOT WIN32 */
106 #if defined(__NetBSD__) || defined(__FreeBSD__)
107 #include <netinet/in.h>
110 #define LWS_INLINE inline
111 #define LWS_O_RDONLY O_RDONLY
112 #define LWS_O_WRONLY O_WRONLY
113 #define LWS_O_CREAT O_CREAT
114 #define LWS_O_TRUNC O_TRUNC
116 #if !defined(LWS_WITH_ESP8266) && !defined(OPTEE_TA) && !defined(LWS_WITH_ESP32)
119 #define LWS_INVALID_FILE -1
121 #define getdtablesize() (30)
122 #if defined(LWS_WITH_ESP32)
123 #define LWS_INVALID_FILE NULL
125 #define LWS_INVALID_FILE NULL
129 #if defined(__GNUC__)
131 /* warn_unused_result attribute only supported by GCC 3.4 or later */
132 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
133 #define LWS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
135 #define LWS_WARN_UNUSED_RESULT
138 #define LWS_VISIBLE __attribute__((visibility("default")))
139 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
140 #define LWS_FORMAT(string_index) __attribute__ ((format(printf, string_index, string_index+1)))
143 #define LWS_WARN_UNUSED_RESULT
144 #define LWS_WARN_DEPRECATED
145 #define LWS_FORMAT(string_index)
148 #if defined(__ANDROID__)
150 #define getdtablesize() sysconf(_SC_OPEN_MAX)
157 #endif /* LWS_USE_LIBEV */
160 #ifdef LWS_HAVE_UV_VERSION_H
161 #include <uv-version.h>
163 #endif /* LWS_USE_LIBUV */
164 #ifdef LWS_USE_LIBEVENT
165 #include <event2/event.h>
166 #endif /* LWS_USE_LIBEVENT */
169 #define LWS_EXTERN extern
175 #if !defined(OPTEE_TA)
176 #include <sys/time.h>
181 #ifdef LWS_OPENSSL_SUPPORT
184 #ifdef USE_OLD_CYASSL
185 #include <cyassl/openssl/ssl.h>
186 #include <cyassl/error-ssl.h>
188 #include <wolfssl/openssl/ssl.h>
189 #include <wolfssl/error-ssl.h>
190 #endif /* not USE_OLD_CYASSL */
192 #include <openssl/ssl.h>
193 #if !defined(LWS_WITH_ESP32)
194 #include <openssl/err.h>
196 #endif /* not USE_WOLFSSL */
200 #define CONTEXT_PORT_NO_LISTEN -1
201 #define CONTEXT_PORT_NO_LISTEN_SERVER -2
203 /** \defgroup log Logging
207 * Lws provides flexible and filterable logging facilities, which can be
208 * used inside lws and in user code.
210 * Log categories may be individually filtered bitwise, and directed to built-in
211 * sinks for syslog-compatible logging, or a user-defined function.
215 enum lws_log_levels {
225 LLL_LATENCY = 1 << 9,
228 LLL_COUNT = 11 /* set to count of valid flags */
231 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...) LWS_FORMAT(2);
232 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
234 * lwsl_timestamp: generate logging timestamp string
236 * \param level: logging level
237 * \param p: char * buffer to take timestamp
238 * \param len: length of p
240 * returns length written in p
242 LWS_VISIBLE LWS_EXTERN int
243 lwsl_timestamp(int level, char *p, int len);
245 /* these guys are unconditionally included */
247 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
248 #define lwsl_user(...) _lws_log(LLL_USER, __VA_ARGS__)
250 #if !defined(LWS_WITH_NO_LOGS)
251 /* notice and warn are usually included by being compiled in */
252 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
253 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
256 * weaker logging can be deselected by telling CMake to build in RELEASE mode
257 * that gets rid of the overhead of checking while keeping _warn and _err
261 #if defined(LWS_WITH_ESP8266)
266 #if defined(LWS_WITH_NO_LOGS)
267 /* notice, warn and log are always compiled in */
268 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
269 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
271 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
272 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
273 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
274 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
275 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
276 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
277 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
279 * lwsl_hexdump() - helper to hexdump a buffer (DEBUG builds only)
281 * \param buf: buffer start to dump
282 * \param len: length of buffer to dump
284 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
287 #if defined(LWS_WITH_NO_LOGS)
288 #define lwsl_warn(...) do {} while(0)
289 #define lwsl_notice(...) do {} while(0)
291 #define lwsl_info(...) do {} while(0)
292 #define lwsl_debug(...) do {} while(0)
293 #define lwsl_parser(...) do {} while(0)
294 #define lwsl_header(...) do {} while(0)
295 #define lwsl_ext(...) do {} while(0)
296 #define lwsl_client(...) do {} while(0)
297 #define lwsl_latency(...) do {} while(0)
298 #define lwsl_hexdump(a, b)
302 static LWS_INLINE int lws_is_be(void) {
303 const int probe = ~0xff;
305 return *(const char *)&probe;
309 * lws_set_log_level() - Set the logging bitfield
310 * \param level: OR together the LLL_ debug contexts you want output from
311 * \param log_emit_function: NULL to leave it as it is, or a user-supplied
312 * function to perform log string emission instead of
313 * the default stderr one.
315 * log level defaults to "err", "warn" and "notice" contexts enabled and
316 * emission on stderr.
318 LWS_VISIBLE LWS_EXTERN void
319 lws_set_log_level(int level,
320 void (*log_emit_function)(int level, const char *line));
323 * lwsl_emit_syslog() - helper log emit function writes to system log
325 * \param level: one of LLL_ log level indexes
326 * \param line: log string
328 * You use this by passing the function pointer to lws_set_log_level(), to set
329 * it as the log emit function, it is not called directly.
331 LWS_VISIBLE LWS_EXTERN void
332 lwsl_emit_syslog(int level, const char *line);
335 * lwsl_visible() - returns true if the log level should be printed
337 * \param level: one of LLL_ log level indexes
339 * This is useful if you have to do work to generate the log content, you
340 * can skip the work if the log level used to print it is not actually
341 * enabled at runtime.
343 LWS_VISIBLE LWS_EXTERN int
344 lwsl_visible(int level);
351 #ifndef lws_container_of
352 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
358 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
361 /* api change list for user code to test against */
363 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
365 /* the struct lws_protocols has the id field present */
366 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
368 /* you can call lws_get_peer_write_allowance */
369 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
371 /* extra parameter introduced in 917f43ab821 */
372 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
374 /* File operations stuff exists */
375 #define LWS_FEATURE_FOPS
379 typedef SOCKET lws_sockfd_type;
380 typedef HANDLE lws_filefd_type;
381 #define lws_sockfd_valid(sfd) (!!sfd)
383 lws_sockfd_type fd; /**< file descriptor */
384 SHORT events; /**< which events to respond to */
385 SHORT revents; /**< which events happened */
387 #define LWS_POLLHUP (FD_CLOSE)
388 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
389 #define LWS_POLLOUT (FD_WRITE)
393 #if defined(LWS_WITH_ESP8266)
395 #include <user_interface.h>
398 typedef struct espconn * lws_sockfd_type;
399 typedef void * lws_filefd_type;
400 #define lws_sockfd_valid(sfd) (!!sfd)
402 lws_sockfd_type fd; /**< fd related to */
403 short events; /**< which POLL... events to respond to */
404 short revents; /**< which POLL... events occurred */
406 #define POLLIN 0x0001
407 #define POLLPRI 0x0002
408 #define POLLOUT 0x0004
409 #define POLLERR 0x0008
410 #define POLLHUP 0x0010
411 #define POLLNVAL 0x0020
415 lws_sockfd_type esp8266_create_tcp_listen_socket(struct lws_vhost *vh);
416 void esp8266_tcp_stream_accept(lws_sockfd_type fd, struct lws *wsi);
422 int ets_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
423 #define snprintf ets_snprintf
425 typedef os_timer_t uv_timer_t;
426 typedef void uv_cb_t(uv_timer_t *);
428 void os_timer_disarm(void *);
429 void os_timer_setfn(os_timer_t *, os_timer_func_t *, void *);
431 void ets_timer_arm_new(os_timer_t *, int, int, int);
433 //void os_timer_arm(os_timer_t *, int, int);
435 #define UV_VERSION_MAJOR 1
437 #define lws_uv_getloop(a, b) (NULL)
439 static inline void uv_timer_init(void *l, uv_timer_t *t)
442 memset(t, 0, sizeof(*t));
446 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
448 os_timer_setfn(t, (os_timer_func_t *)cb, t);
450 os_timer_arm(t, first, !!rep);
453 static inline void uv_timer_stop(uv_timer_t *t)
459 #if defined(LWS_WITH_ESP32)
461 typedef int lws_sockfd_type;
462 typedef int lws_filefd_type;
463 #define lws_sockfd_valid(sfd) (sfd >= 0)
465 lws_sockfd_type fd; /**< fd related to */
466 short events; /**< which POLL... events to respond to */
467 short revents; /**< which POLL... events occurred */
469 #define POLLIN 0x0001
470 #define POLLPRI 0x0002
471 #define POLLOUT 0x0004
472 #define POLLERR 0x0008
473 #define POLLHUP 0x0010
474 #define POLLNVAL 0x0020
476 #include <freertos/FreeRTOS.h>
477 #include <freertos/event_groups.h>
479 #include "esp_wifi.h"
480 #include "esp_system.h"
481 #include "esp_event.h"
482 #include "esp_event_loop.h"
484 #include "driver/gpio.h"
485 #include "esp_spi_flash.h"
486 #include "freertos/timers.h"
488 #if !defined(CONFIG_FREERTOS_HZ)
489 #define CONFIG_FREERTOS_HZ 100
492 typedef TimerHandle_t uv_timer_t;
493 typedef void uv_cb_t(uv_timer_t *);
494 typedef void * uv_handle_t;
496 struct timer_mapping {
501 #define UV_VERSION_MAJOR 1
503 #define lws_uv_getloop(a, b) (NULL)
505 static inline void uv_timer_init(void *l, uv_timer_t *t)
511 extern void esp32_uvtimer_cb(TimerHandle_t t);
513 static inline void uv_timer_start(uv_timer_t *t, uv_cb_t *cb, int first, int rep)
515 struct timer_mapping *tm = malloc(sizeof(*tm));
523 *t = xTimerCreate("x", pdMS_TO_TICKS(first), !!rep, tm,
524 (TimerCallbackFunction_t)esp32_uvtimer_cb);
528 static inline void uv_timer_stop(uv_timer_t *t)
533 static inline void uv_close(uv_handle_t *h, void *v)
535 free(pvTimerGetTimerID((uv_timer_t)h));
536 xTimerDelete(*(uv_timer_t *)h, 0);
539 /* ESP32 helper declarations */
542 #include <esp_partition.h>
544 #define LWS_PLUGIN_STATIC
545 #define LWS_MAGIC_REBOOT_TYPE_ADS 0x50001ffc
546 #define LWS_MAGIC_REBOOT_TYPE_REQ_FACTORY 0xb00bcafe
547 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY 0xfaceb00b
548 #define LWS_MAGIC_REBOOT_TYPE_FORCED_FACTORY_BUTTON 0xf0cedfac
551 /* user code provides these */
554 lws_esp32_identify_physical_device(void);
556 /* lws-plat-esp32 provides these */
558 extern void (*lws_cb_scan_done)(void *);
559 extern void *lws_cb_scan_done_arg;
574 struct lws_esp32_image {
581 extern struct lws_esp32 lws_esp32;
584 lws_esp32_event_passthru(void *ctx, system_event_t *event);
586 lws_esp32_wlan_config(void);
588 lws_esp32_wlan_start_ap(void);
590 lws_esp32_wlan_start_station(void);
591 struct lws_context_creation_info;
593 lws_esp32_set_creation_defaults(struct lws_context_creation_info *info);
594 extern struct lws_context *
595 lws_esp32_init(struct lws_context_creation_info *);
597 lws_esp32_wlan_nvs_get(int retry);
599 lws_esp32_restart_guided(uint32_t type);
600 extern const esp_partition_t *
601 lws_esp_ota_get_boot_partition(void);
603 lws_esp32_get_image_info(const esp_partition_t *part, struct lws_esp32_image *i, char *json, int json_len);
604 extern uint32_t lws_esp32_get_reboot_type(void);
605 extern uint16_t lws_esp32_sine_interp(int n);
607 /* required in external code by esp32 plat (may just return if no leds) */
608 extern void lws_esp32_leds_timer_cb(TimerHandle_t th);
610 typedef int lws_sockfd_type;
611 typedef int lws_filefd_type;
612 #define lws_sockfd_valid(sfd) (sfd >= 0)
616 #define lws_pollfd pollfd
617 #define LWS_POLLHUP (POLLHUP|POLLERR)
618 #define LWS_POLLIN (POLLIN)
619 #define LWS_POLLOUT (POLLOUT)
622 /** struct lws_pollargs - argument structure for all external poll related calls
623 * passed in via 'in' */
624 struct lws_pollargs {
625 lws_sockfd_type fd; /**< applicable socket descriptor */
626 int events; /**< the new event mask */
627 int prev_events; /**< the previous event mask */
631 struct lws_token_limits;
633 /*! \defgroup wsclose Websocket Close
635 * ##Websocket close frame control
637 * When we close a ws connection, we can send a reason code and a short
638 * UTF-8 description back with the close packet.
643 * NOTE: These public enums are part of the abi. If you want to add one,
644 * add it at where specified so existing users are unaffected.
646 /** enum lws_close_status - RFC6455 close status codes */
647 enum lws_close_status {
648 LWS_CLOSE_STATUS_NOSTATUS = 0,
649 LWS_CLOSE_STATUS_NORMAL = 1000,
650 /**< 1000 indicates a normal closure, meaning that the purpose for
651 which the connection was established has been fulfilled. */
652 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
653 /**< 1001 indicates that an endpoint is "going away", such as a server
654 going down or a browser having navigated away from a page. */
655 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
656 /**< 1002 indicates that an endpoint is terminating the connection due
657 to a protocol error. */
658 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
659 /**< 1003 indicates that an endpoint is terminating the connection
660 because it has received a type of data it cannot accept (e.g., an
661 endpoint that understands only text data MAY send this if it
662 receives a binary message). */
663 LWS_CLOSE_STATUS_RESERVED = 1004,
664 /**< Reserved. The specific meaning might be defined in the future. */
665 LWS_CLOSE_STATUS_NO_STATUS = 1005,
666 /**< 1005 is a reserved value and MUST NOT be set as a status code in a
667 Close control frame by an endpoint. It is designated for use in
668 applications expecting a status code to indicate that no status
669 code was actually present. */
670 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
671 /**< 1006 is a reserved value and MUST NOT be set as a status code in a
672 Close control frame by an endpoint. It is designated for use in
673 applications expecting a status code to indicate that the
674 connection was closed abnormally, e.g., without sending or
675 receiving a Close control frame. */
676 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
677 /**< 1007 indicates that an endpoint is terminating the connection
678 because it has received data within a message that was not
679 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
680 data within a text message). */
681 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
682 /**< 1008 indicates that an endpoint is terminating the connection
683 because it has received a message that violates its policy. This
684 is a generic status code that can be returned when there is no
685 other more suitable status code (e.g., 1003 or 1009) or if there
686 is a need to hide specific details about the policy. */
687 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
688 /**< 1009 indicates that an endpoint is terminating the connection
689 because it has received a message that is too big for it to
691 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
692 /**< 1010 indicates that an endpoint (client) is terminating the
693 connection because it has expected the server to negotiate one or
694 more extension, but the server didn't return them in the response
695 message of the WebSocket handshake. The list of extensions that
696 are needed SHOULD appear in the /reason/ part of the Close frame.
697 Note that this status code is not used by the server, because it
698 can fail the WebSocket handshake instead */
699 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
700 /**< 1011 indicates that a server is terminating the connection because
701 it encountered an unexpected condition that prevented it from
702 fulfilling the request. */
703 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
704 /**< 1015 is a reserved value and MUST NOT be set as a status code in a
705 Close control frame by an endpoint. It is designated for use in
706 applications expecting a status code to indicate that the
707 connection was closed due to a failure to perform a TLS handshake
708 (e.g., the server certificate can't be verified). */
710 /****** add new things just above ---^ ******/
712 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
716 * lws_close_reason - Set reason and aux data to send with Close packet
717 * If you are going to return nonzero from the callback
718 * requesting the connection to close, you can optionally
719 * call this to set the reason the peer will be told if
722 * \param wsi: The websocket connection to set the close reason on
723 * \param status: A valid close status from websocket standard
724 * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data
725 * \param len: Length of data in \param buf to send
727 LWS_VISIBLE LWS_EXTERN void
728 lws_close_reason(struct lws *wsi, enum lws_close_status status,
729 unsigned char *buf, size_t len);
735 /* needed even with extensions disabled for create context */
736 struct lws_extension;
738 /*! \defgroup usercb User Callback
740 * ##User protocol callback
742 * The protocol callback is the primary way lws interacts with
743 * user code. For one of a list of a few dozen reasons the callback gets
744 * called at some event to be handled.
746 * All of the events can be ignored, returning 0 is taken as "OK" and returning
747 * nonzero in most cases indicates that the connection should be closed.
753 * NOTE: These public enums are part of the abi. If you want to add one,
754 * add it at where specified so existing users are unaffected.
756 /** enum lws_callback_reasons - reason you're getting a protocol callback */
757 enum lws_callback_reasons {
758 LWS_CALLBACK_ESTABLISHED = 0,
759 /**< (VH) after the server completes a handshake with an incoming
760 * client. If you built the library with ssl support, in is a
761 * pointer to the ssl struct associated with the connection or NULL.*/
762 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
763 /**< the request client connection has been unable to complete a
764 * handshake with the remote server. If in is non-NULL, you can
765 * find an error string of length len where it points to
767 * Diagnostic strings that may be returned include
769 * "getaddrinfo (ipv6) failed"
770 * "unknown address family"
771 * "getaddrinfo (ipv4) failed"
772 * "set socket opts failed"
773 * "insert wsi failed"
774 * "lws_ssl_client_connect1 failed"
775 * "lws_ssl_client_connect2 failed"
779 * "HS: Redirect code but no Location"
780 * "HS: URI did not parse"
781 * "HS: Redirect failed"
782 * "HS: Server did not return 200"
784 * "HS: disallowed by client filter"
785 * "HS: disallowed at ESTABLISHED"
786 * "HS: ACCEPT missing"
787 * "HS: ws upgrade response not 101"
788 * "HS: UPGRADE missing"
789 * "HS: Upgrade to something other than websocket"
790 * "HS: CONNECTION missing"
791 * "HS: UPGRADE malformed"
792 * "HS: PROTOCOL malformed"
793 * "HS: Cannot match protocol"
794 * "HS: EXT: list too big"
795 * "HS: EXT: failed setting defaults"
796 * "HS: EXT: failed parsing defaults"
797 * "HS: EXT: failed parsing options"
798 * "HS: EXT: Rejects server options"
799 * "HS: EXT: unknown ext"
800 * "HS: Accept hash wrong"
801 * "HS: Rejected by filter cb"
803 * "HS: SO_SNDBUF failed"
804 * "HS: Rejected at CLIENT_ESTABLISHED"
806 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
807 /**< this is the last chance for the client user code to examine the
808 * http headers and decide to reject the connection. If the
809 * content in the headers is interesting to the
810 * client (url, etc) it needs to copy it out at
811 * this point since it will be destroyed before
812 * the CLIENT_ESTABLISHED call */
813 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
814 /**< after your client connection completed
815 * a handshake with the remote server */
816 LWS_CALLBACK_CLOSED = 4,
817 /**< when the websocket session ends */
818 LWS_CALLBACK_CLOSED_HTTP = 5,
819 /**< when a HTTP (non-websocket) session ends */
820 LWS_CALLBACK_RECEIVE = 6,
821 /**< data has appeared for this server endpoint from a
822 * remote client, it can be found at *in and is
824 LWS_CALLBACK_RECEIVE_PONG = 7,
825 /**< servers receive PONG packets with this callback reason */
826 LWS_CALLBACK_CLIENT_RECEIVE = 8,
827 /**< data has appeared from the server for the client connection, it
828 * can be found at *in and is len bytes long */
829 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
830 /**< clients receive PONG packets with this callback reason */
831 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
832 /**< If you call lws_callback_on_writable() on a connection, you will
833 * get one of these callbacks coming when the connection socket
834 * is able to accept another write packet without blocking.
835 * If it already was able to take another packet without blocking,
836 * you'll get this callback at the next call to the service loop
837 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
838 * and servers get LWS_CALLBACK_SERVER_WRITEABLE. */
839 LWS_CALLBACK_SERVER_WRITEABLE = 11,
840 /**< See LWS_CALLBACK_CLIENT_WRITEABLE */
841 LWS_CALLBACK_HTTP = 12,
842 /**< an http request has come from a client that is not
843 * asking to upgrade the connection to a websocket
844 * one. This is a chance to serve http content,
845 * for example, to send a script to the client
846 * which will then open the websockets connection.
847 * in points to the URI path requested and
848 * lws_serve_http_file() makes it very
849 * simple to send back a file to the client.
850 * Normally after sending the file you are done
851 * with the http connection, since the rest of the
852 * activity will come by websockets from the script
853 * that was delivered by http, so you will want to
854 * return 1; to close and free up the connection. */
855 LWS_CALLBACK_HTTP_BODY = 13,
856 /**< the next len bytes data from the http
857 * request body HTTP connection is now available in in. */
858 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
859 /**< the expected amount of http request body has been delivered */
860 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
861 /**< a file requested to be sent down http link has completed. */
862 LWS_CALLBACK_HTTP_WRITEABLE = 16,
863 /**< you can write more down the http protocol link now. */
864 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
865 /**< called when a client connects to
866 * the server at network level; the connection is accepted but then
867 * passed to this callback to decide whether to hang up immediately
868 * or not, based on the client IP. in contains the connection
869 * socket's descriptor. Since the client connection information is
870 * not available yet, wsi still pointing to the main server socket.
871 * Return non-zero to terminate the connection before sending or
872 * receiving anything. Because this happens immediately after the
873 * network connection from the client, there's no websocket protocol
874 * selected yet so this callback is issued only to protocol 0. */
875 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
876 /**< called when the request has
877 * been received and parsed from the client, but the response is
878 * not sent yet. Return non-zero to disallow the connection.
879 * user is a pointer to the connection user space allocation,
880 * in is the URI, eg, "/"
881 * In your handler you can use the public APIs
882 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
883 * headers using the header enums lws_token_indexes from
884 * libwebsockets.h to check for and read the supported header
885 * presence and content before deciding to allow the http
886 * connection to proceed or to kill the connection. */
887 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
888 /**< A new client just had
889 * been connected, accepted, and instantiated into the pool. This
890 * callback allows setting any relevant property to it. Because this
891 * happens immediately after the instantiation of a new client,
892 * there's no websocket protocol selected yet so this callback is
893 * issued only to protocol 0. Only wsi is defined, pointing to the
894 * new client, and the return value is ignored. */
895 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
896 /**< called when the handshake has
897 * been received and parsed from the client, but the response is
898 * not sent yet. Return non-zero to disallow the connection.
899 * user is a pointer to the connection user space allocation,
900 * in is the requested protocol name
901 * In your handler you can use the public APIs
902 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
903 * headers using the header enums lws_token_indexes from
904 * libwebsockets.h to check for and read the supported header
905 * presence and content before deciding to allow the handshake
906 * to proceed or to kill the connection. */
907 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
908 /**< if configured for
909 * including OpenSSL support, this callback allows your user code
910 * to perform extra SSL_CTX_load_verify_locations() or similar
911 * calls to direct OpenSSL where to find certificates the client
912 * can use to confirm the remote server identity. user is the
913 * OpenSSL SSL_CTX* */
914 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
915 /**< if configured for
916 * including OpenSSL support, this callback allows your user code
917 * to load extra certifcates into the server which allow it to
918 * verify the validity of certificates returned by clients. user
919 * is the server's OpenSSL SSL_CTX* */
920 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
921 /**< if the libwebsockets vhost was created with the option
922 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
923 * callback is generated during OpenSSL verification of the cert
924 * sent from the client. It is sent to protocol[0] callback as
925 * no protocol has been negotiated on the connection yet.
926 * Notice that the libwebsockets context and wsi are both NULL
927 * during this callback. See
928 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
929 * to understand more detail about the OpenSSL callback that
930 * generates this libwebsockets callback and the meanings of the
931 * arguments passed. In this callback, user is the x509_ctx,
932 * in is the ssl pointer and len is preverify_ok
933 * Notice that this callback maintains libwebsocket return
934 * conventions, return 0 to mean the cert is OK or 1 to fail it.
935 * This also means that if you don't handle this callback then
936 * the default callback action of returning 0 allows the client
938 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
939 /**< this callback happens
940 * when a client handshake is being compiled. user is NULL,
941 * in is a char **, it's pointing to a char * which holds the
942 * next location in the header buffer where you can add
943 * headers, and len is the remaining space in the header buffer,
944 * which is typically some hundreds of bytes. So, to add a canned
945 * cookie, your handler code might look similar to:
947 * char **p = (char **)in;
952 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
956 * Notice if you add anything, you just have to take care about
957 * the CRLF on the line you added. Obviously this callback is
958 * optional, if you don't handle it everything is fine.
960 * Notice the callback is coming to protocols[0] all the time,
961 * because there is no specific protocol negotiated yet. */
962 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
963 /**< When the server handshake code
964 * sees that it does support a requested extension, before
965 * accepting the extension by additing to the list sent back to
966 * the client it gives this callback just to check that it's okay
967 * to use that extension. It calls back to the requested protocol
968 * and with in being the extension name, len is 0 and user is
969 * valid. Note though at this time the ESTABLISHED callback hasn't
970 * happened yet so if you initialize user content there, user
971 * content during this callback might not be useful for anything.
972 * Notice this callback comes to protocols[0]. */
973 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
975 * connection is being prepared to start a handshake to a server,
976 * each supported extension is checked with protocols[0] callback
977 * with this reason, giving the user code a chance to suppress the
978 * claim to support that extension by returning non-zero. If
979 * unhandled, by default 0 will be returned and the extension
980 * support included in the header to the server. Notice this
981 * callback comes to protocols[0]. */
982 LWS_CALLBACK_PROTOCOL_INIT = 27,
983 /**< One-time call per protocol, per-vhost using it, so it can
984 * do initial setup / allocations etc */
985 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
986 /**< One-time call per protocol, per-vhost using it, indicating
987 * this protocol won't get used at all after this callback, the
988 * vhost is getting destroyed. Take the opportunity to
989 * deallocate everything that was allocated by the protocol. */
990 LWS_CALLBACK_WSI_CREATE = 29,
991 /**< outermost (earliest) wsi create notification to protocols[0] */
992 LWS_CALLBACK_WSI_DESTROY = 30,
993 /**< outermost (latest) wsi destroy notification to protocols[0] */
994 LWS_CALLBACK_GET_THREAD_ID = 31,
995 /**< lws can accept callback when writable requests from other
996 * threads, if you implement this callback and return an opaque
997 * current thread ID integer. */
999 /* external poll() management support */
1000 LWS_CALLBACK_ADD_POLL_FD = 32,
1001 /**< lws normally deals with its poll() or other event loop
1002 * internally, but in the case you are integrating with another
1003 * server you will need to have lws sockets share a
1004 * polling array with the other server. This and the other
1005 * POLL_FD related callbacks let you put your specialized
1006 * poll array interface code in the callback for protocol 0, the
1007 * first protocol you support, usually the HTTP protocol in the
1009 * This callback happens when a socket needs to be
1010 * added to the polling loop: in points to a struct
1011 * lws_pollargs; the fd member of the struct is the file
1012 * descriptor, and events contains the active events
1014 * If you are using the internal lws polling / event loop
1015 * you can just ignore these callbacks. */
1016 LWS_CALLBACK_DEL_POLL_FD = 33,
1017 /**< This callback happens when a socket descriptor
1018 * needs to be removed from an external polling array. in is
1019 * again the struct lws_pollargs containing the fd member
1020 * to be removed. If you are using the internal polling
1021 * loop, you can just ignore it. */
1022 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
1023 /**< This callback happens when lws wants to modify the events for
1025 * in is the struct lws_pollargs with the fd to change.
1026 * The new event mask is in events member and the old mask is in
1027 * the prev_events member.
1028 * If you are using the internal polling loop, you can just ignore
1030 LWS_CALLBACK_LOCK_POLL = 35,
1031 /**< These allow the external poll changes driven
1032 * by lws to participate in an external thread locking
1033 * scheme around the changes, so the whole thing is threadsafe.
1034 * These are called around three activities in the library,
1035 * - inserting a new wsi in the wsi / fd table (len=1)
1036 * - deleting a wsi from the wsi / fd table (len=1)
1037 * - changing a wsi's POLLIN/OUT state (len=0)
1038 * Locking and unlocking external synchronization objects when
1039 * len == 1 allows external threads to be synchronized against
1040 * wsi lifecycle changes if it acquires the same lock for the
1041 * duration of wsi dereference from the other thread context. */
1042 LWS_CALLBACK_UNLOCK_POLL = 36,
1043 /**< See LWS_CALLBACK_LOCK_POLL, ignore if using lws internal poll */
1045 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
1046 /**< if configured for including OpenSSL support but no private key
1047 * file has been specified (ssl_private_key_filepath is NULL), this is
1048 * called to allow the user to set the private key directly via
1049 * libopenssl and perform further operations if required; this might be
1050 * useful in situations where the private key is not directly accessible
1051 * by the OS, for example if it is stored on a smartcard.
1052 * user is the server's OpenSSL SSL_CTX* */
1053 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
1054 /**< The peer has sent an unsolicited Close WS packet. in and
1055 * len are the optional close code (first 2 bytes, network
1056 * order) and the optional additional information which is not
1057 * defined in the standard, and may be a string or non-human- readable data.
1058 * If you return 0 lws will echo the close and then close the
1059 * connection. If you return nonzero lws will just close the
1062 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
1065 LWS_CALLBACK_CGI = 40,
1067 LWS_CALLBACK_CGI_TERMINATED = 41,
1069 LWS_CALLBACK_CGI_STDIN_DATA = 42,
1071 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
1073 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
1075 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
1077 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
1079 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
1081 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
1083 LWS_CALLBACK_HTTP_BIND_PROTOCOL = 49,
1085 LWS_CALLBACK_HTTP_DROP_PROTOCOL = 50,
1087 LWS_CALLBACK_CHECK_ACCESS_RIGHTS = 51,
1089 LWS_CALLBACK_PROCESS_HTML = 52,
1091 LWS_CALLBACK_ADD_HEADERS = 53,
1093 LWS_CALLBACK_SESSION_INFO = 54,
1096 LWS_CALLBACK_GS_EVENT = 55,
1098 LWS_CALLBACK_HTTP_PMO = 56,
1099 /**< per-mount options for this connection, called before
1100 * the normal LWS_CALLBACK_HTTP when the mount has per-mount
1103 LWS_CALLBACK_CLIENT_HTTP_WRITEABLE = 57,
1104 /**< when doing an HTTP type client connection, you can call
1105 * lws_client_http_body_pending(wsi, 1) from
1106 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER to get these callbacks
1107 * sending the HTTP headers.
1109 * From this callback, when you have sent everything, you should let
1110 * lws know by calling lws_client_http_body_pending(wsi, 0)
1112 LWS_CALLBACK_OPENSSL_PERFORM_SERVER_CERT_VERIFICATION = 58,
1113 /**< Similar to LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION
1114 * this callback is called during OpenSSL verification of the cert
1115 * sent from the server to the client. It is sent to protocol[0]
1116 * callback as no protocol has been negotiated on the connection yet.
1117 * Notice that the wsi is set because lws_client_connect_via_info was
1120 * See http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1121 * to understand more detail about the OpenSSL callback that
1122 * generates this libwebsockets callback and the meanings of the
1123 * arguments passed. In this callback, user is the x509_ctx,
1124 * in is the ssl pointer and len is preverify_ok.
1126 * THIS IS NOT RECOMMENDED BUT if a cert validation error shall be
1127 * overruled and cert shall be accepted as ok,
1128 * X509_STORE_CTX_set_error((X509_STORE_CTX*)user, X509_V_OK); must be
1129 * called and return value must be 0 to mean the cert is OK;
1130 * returning 1 will fail the cert in any case.
1132 * This also means that if you don't handle this callback then
1133 * the default callback action of returning 0 will not accept the
1134 * certificate in case of a validation error decided by the SSL lib.
1136 * This is expected and secure behaviour when validating certificates.
1138 * Note: LCCSCF_ALLOW_SELFSIGNED and
1139 * LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK still work without this
1140 * callback being implemented.
1142 LWS_CALLBACK_RAW_RX = 59,
1143 /**< RAW mode connection RX */
1144 LWS_CALLBACK_RAW_CLOSE = 60,
1145 /**< RAW mode connection is closing */
1146 LWS_CALLBACK_RAW_WRITEABLE = 61,
1147 /**< RAW mode connection may be written */
1148 LWS_CALLBACK_RAW_ADOPT = 62,
1149 /**< RAW mode connection was adopted (equivalent to 'wsi created') */
1150 LWS_CALLBACK_RAW_ADOPT_FILE = 63,
1151 /**< RAW mode file was adopted (equivalent to 'wsi created') */
1152 LWS_CALLBACK_RAW_RX_FILE = 64,
1153 /**< RAW mode file has something to read */
1154 LWS_CALLBACK_RAW_WRITEABLE_FILE = 65,
1155 /**< RAW mode file is writeable */
1156 LWS_CALLBACK_RAW_CLOSE_FILE = 66,
1157 /**< RAW mode wsi that adopted a file is closing */
1159 /****** add new things just above ---^ ******/
1161 LWS_CALLBACK_USER = 1000,
1162 /**< user code can use any including above without fear of clashes */
1168 * typedef lws_callback_function() - User server actions
1169 * \param wsi: Opaque websocket instance pointer
1170 * \param reason: The reason for the call
1171 * \param user: Pointer to per-session user data allocated by library
1172 * \param in: Pointer used for some callback reasons
1173 * \param len: Length set for some callback reasons
1175 * This callback is the way the user controls what is served. All the
1176 * protocol detail is hidden and handled by the library.
1178 * For each connection / session there is user data allocated that is
1179 * pointed to by "user". You set the size of this user data area when
1180 * the library is initialized with lws_create_server.
1183 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1184 void *user, void *in, size_t len);
1187 /*! \defgroup extensions
1189 * ##Extension releated functions
1191 * Ws defines optional extensions, lws provides the ability to implement these
1192 * in user code if so desired.
1194 * We provide one extensions permessage-deflate.
1199 * NOTE: These public enums are part of the abi. If you want to add one,
1200 * add it at where specified so existing users are unaffected.
1202 enum lws_extension_callback_reasons {
1203 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
1204 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
1205 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
1206 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
1207 LWS_EXT_CB_CONSTRUCT = 4,
1208 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
1209 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
1210 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
1211 LWS_EXT_CB_DESTROY = 8,
1212 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
1213 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
1214 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
1215 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
1216 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
1217 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
1218 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
1219 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
1220 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
1221 LWS_EXT_CB_1HZ = 18,
1222 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
1223 LWS_EXT_CB_IS_WRITEABLE = 20,
1224 LWS_EXT_CB_PAYLOAD_TX = 21,
1225 LWS_EXT_CB_PAYLOAD_RX = 22,
1226 LWS_EXT_CB_OPTION_DEFAULT = 23,
1227 LWS_EXT_CB_OPTION_SET = 24,
1228 LWS_EXT_CB_OPTION_CONFIRM = 25,
1229 LWS_EXT_CB_NAMED_OPTION_SET = 26,
1231 /****** add new things just above ---^ ******/
1234 /** enum lws_ext_options_types */
1235 enum lws_ext_options_types {
1236 EXTARG_NONE, /**< does not take an argument */
1237 EXTARG_DEC, /**< requires a decimal argument */
1238 EXTARG_OPT_DEC /**< may have an optional decimal argument */
1240 /* Add new things just above here ---^
1241 * This is part of the ABI, don't needlessly break compatibility */
1244 /** struct lws_ext_options - Option arguments to the extension. These are
1245 * used in the negotiation at ws upgrade time.
1246 * The helper function lws_ext_parse_options()
1247 * uses these to generate callbacks */
1248 struct lws_ext_options {
1249 const char *name; /**< Option name, eg, "server_no_context_takeover" */
1250 enum lws_ext_options_types type; /**< What kind of args the option can take */
1252 /* Add new things just above here ---^
1253 * This is part of the ABI, don't needlessly break compatibility */
1256 /** struct lws_ext_option_arg */
1257 struct lws_ext_option_arg {
1258 const char *option_name; /**< may be NULL, option_index used then */
1259 int option_index; /**< argument ordinal to use if option_name missing */
1260 const char *start; /**< value */
1261 int len; /**< length of value */
1265 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1266 * \param context: Websockets context
1267 * \param ext: This extension
1268 * \param wsi: Opaque websocket instance pointer
1269 * \param reason: The reason for the call
1270 * \param user: Pointer to ptr to per-session user data allocated by library
1271 * \param in: Pointer used for some callback reasons
1272 * \param len: Length set for some callback reasons
1274 * Each extension that is active on a particular connection receives
1275 * callbacks during the connection lifetime to allow the extension to
1276 * operate on websocket data and manage itself.
1278 * Libwebsockets takes care of allocating and freeing "user" memory for
1279 * each active extension on each connection. That is what is pointed to
1280 * by the user parameter.
1282 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1283 * select this extension from the list provided by the client,
1284 * just before the server will send back the handshake accepting
1285 * the connection with this extension active. This gives the
1286 * extension a chance to initialize its connection context found
1289 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1290 * but called when client is instantiating this extension. Some
1291 * extensions will work the same on client and server side and then
1292 * you can just merge handlers for both CONSTRUCTS.
1294 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1295 * being used on is about to be closed and deallocated. It's the
1296 * last chance for the extension to deallocate anything it has
1297 * allocated in the user data (pointed to by user) before the
1298 * user data is deleted. This same callback is used whether you
1299 * are in client or server instantiation context.
1301 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1302 * a connection, and a packet of data arrived at the connection,
1303 * it is passed to this callback to give the extension a chance to
1304 * change the data, eg, decompress it. user is pointing to the
1305 * extension's private connection context data, in is pointing
1306 * to an lws_tokens struct, it consists of a char * pointer called
1307 * token, and an int called token_len. At entry, these are
1308 * set to point to the received buffer and set to the content
1309 * length. If the extension will grow the content, it should use
1310 * a new buffer allocated in its private user context data and
1311 * set the pointed-to lws_tokens members to point to its buffer.
1313 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1314 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1315 * extension a chance to change websocket data just before it will
1316 * be sent out. Using the same lws_token pointer scheme in in,
1317 * the extension can change the buffer and the length to be
1318 * transmitted how it likes. Again if it wants to grow the
1319 * buffer safely, it should copy the data into its own buffer and
1320 * set the lws_tokens token pointer to it.
1322 * LWS_EXT_CB_ARGS_VALIDATE:
1325 lws_extension_callback_function(struct lws_context *context,
1326 const struct lws_extension *ext, struct lws *wsi,
1327 enum lws_extension_callback_reasons reason,
1328 void *user, void *in, size_t len);
1330 /** struct lws_extension - An extension we support */
1331 struct lws_extension {
1332 const char *name; /**< Formal extension name, eg, "permessage-deflate" */
1333 lws_extension_callback_function *callback; /**< Service callback */
1334 const char *client_offer; /**< String containing exts and options client offers */
1336 /* Add new things just above here ---^
1337 * This is part of the ABI, don't needlessly break compatibility */
1341 * lws_set_extension_option(): set extension option if possible
1343 * \param wsi: websocket connection
1344 * \param ext_name: name of ext, like "permessage-deflate"
1345 * \param opt_name: name of option, like "rx_buf_size"
1346 * \param opt_val: value to set option to
1348 LWS_VISIBLE LWS_EXTERN int
1349 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1350 const char *opt_name, const char *opt_val);
1352 #ifndef LWS_NO_EXTENSIONS
1353 /* lws_get_internal_extensions() - DEPRECATED
1355 * \Deprecated There is no longer a set internal extensions table. The table is provided
1356 * by user code along with application-specific settings. See the test
1357 * client and server for how to do.
1359 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
1360 lws_get_internal_extensions(void) { return NULL; }
1363 * lws_ext_parse_options() - deal with parsing negotiated extension options
1365 * \param ext: related extension struct
1366 * \param wsi: websocket connection
1367 * \param ext_user: per-connection extension private data
1368 * \param opts: list of supported options
1369 * \param o: option string to parse
1370 * \param len: length
1372 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1373 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
1374 void *ext_user, const struct lws_ext_options *opts,
1375 const char *o, int len);
1378 /** lws_extension_callback_pm_deflate() - extension for RFC7692
1380 * \param context: lws context
1381 * \param ext: related lws_extension struct
1382 * \param wsi: websocket connection
1383 * \param reason: incoming callback reason
1384 * \param user: per-connection extension private data
1385 * \param in: pointer parameter
1386 * \param len: length parameter
1388 * Built-in callback implementing RFC7692 permessage-deflate
1391 int lws_extension_callback_pm_deflate(
1392 struct lws_context *context, const struct lws_extension *ext,
1393 struct lws *wsi, enum lws_extension_callback_reasons reason,
1394 void *user, void *in, size_t len);
1397 * The internal exts are part of the public abi
1398 * If we add more extensions, publish the callback here ------v
1402 /*! \defgroup Protocols-and-Plugins Protocols and Plugins
1405 * ##Protocol and protocol plugin -related apis
1407 * Protocols bind ws protocol names to a custom callback specific to that
1408 * protocol implementaion.
1410 * A list of protocols can be passed in at context creation time, but it is
1411 * also legal to leave that NULL and add the protocols and their callback code
1414 * Plugins are much preferable compared to cut and pasting code into an
1415 * application each time, since they can be used standalone.
1418 /** struct lws_protocols - List of protocols and handlers client or server
1421 struct lws_protocols {
1423 /**< Protocol name that must match the one given in the client
1424 * Javascript new WebSocket(url, 'protocol') name. */
1425 lws_callback_function *callback;
1426 /**< The service callback used for this protocol. It allows the
1427 * service action for an entire protocol to be encapsulated in
1428 * the protocol-specific callback */
1429 size_t per_session_data_size;
1430 /**< Each new connection using this protocol gets
1431 * this much memory allocated on connection establishment and
1432 * freed on connection takedown. A pointer to this per-connection
1433 * allocation is passed into the callback in the 'user' parameter */
1434 size_t rx_buffer_size;
1435 /**< lws allocates this much space for rx data and informs callback
1436 * when something came. Due to rx flow control, the callback may not
1437 * be able to consume it all without having to return to the event
1438 * loop. That is supported in lws.
1440 * If .tx_packet_size is 0, this also controls how much may be sent at once
1441 * for backwards compatibility.
1444 /**< ignored by lws, but useful to contain user information bound
1445 * to the selected protocol. For example if this protocol was
1446 * called "myprotocol-v2", you might set id to 2, and the user
1447 * code that acts differently according to the version can do so by
1448 * switch (wsi->protocol->id), user code might use some bits as
1449 * capability flags based on selected protocol version, etc. */
1450 void *user; /**< ignored by lws, but user code can pass a pointer
1451 here it can later access from the protocol callback */
1452 size_t tx_packet_size;
1453 /**< 0 indicates restrict send() size to .rx_buffer_size for backwards-
1455 * If greater than zero, a single send() is restricted to this amount
1456 * and any remainder is buffered by lws and sent afterwards also in
1457 * these size chunks. Since that is expensive, it's preferable
1458 * to restrict one fragment you are trying to send to match this
1462 /* Add new things just above here ---^
1463 * This is part of the ABI, don't needlessly break compatibility */
1469 * lws_vhost_name_to_protocol() - get vhost's protocol object from its name
1471 * \param vh: vhost to search
1472 * \param name: protocol name
1474 * Returns NULL or a pointer to the vhost's protocol of the requested name
1476 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1477 lws_vhost_name_to_protocol(struct lws_vhost *vh, const char *name);
1480 * lws_get_protocol() - Returns a protocol pointer from a websocket
1482 * \param wsi: pointer to struct websocket you want to know the protocol of
1485 * Some apis can act on all live connections of a given protocol,
1486 * this is how you can get a pointer to the active protocol if needed.
1488 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1489 lws_get_protocol(struct lws *wsi);
1491 /** lws_protocol_get() - deprecated: use lws_get_protocol */
1492 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1493 lws_protocol_get(struct lws *wsi) LWS_WARN_DEPRECATED;
1496 * lws_protocol_vh_priv_zalloc() - Allocate and zero down a protocol's per-vhost
1498 * \param vhost: vhost the instance is related to
1499 * \param prot: protocol the instance is related to
1500 * \param size: bytes to allocate
1502 * Protocols often find it useful to allocate a per-vhost struct, this is a
1503 * helper to be called in the per-vhost init LWS_CALLBACK_PROTOCOL_INIT
1505 LWS_VISIBLE LWS_EXTERN void *
1506 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1510 * lws_protocol_vh_priv_get() - retreive a protocol's per-vhost storage
1512 * \param vhost: vhost the instance is related to
1513 * \param prot: protocol the instance is related to
1515 * Recover a pointer to the allocated per-vhost storage for the protocol created
1516 * by lws_protocol_vh_priv_zalloc() earlier
1518 LWS_VISIBLE LWS_EXTERN void *
1519 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1522 * lws_finalize_startup() - drop initial process privileges
1524 * \param context: lws context
1526 * This is called after the end of the vhost protocol initializations, but
1527 * you may choose to call it earlier
1529 LWS_VISIBLE LWS_EXTERN int
1530 lws_finalize_startup(struct lws_context *context);
1532 LWS_VISIBLE LWS_EXTERN int
1533 lws_protocol_init(struct lws_context *context);
1535 #ifdef LWS_WITH_PLUGINS
1537 /* PLUGINS implies LIBUV */
1539 #define LWS_PLUGIN_API_MAGIC 180
1541 /** struct lws_plugin_capability - how a plugin introduces itself to lws */
1542 struct lws_plugin_capability {
1543 unsigned int api_magic; /**< caller fills this in, plugin fills rest */
1544 const struct lws_protocols *protocols; /**< array of supported protocols provided by plugin */
1545 int count_protocols; /**< how many protocols */
1546 const struct lws_extension *extensions; /**< array of extensions provided by plugin */
1547 int count_extensions; /**< how many extensions */
1550 typedef int (*lws_plugin_init_func)(struct lws_context *,
1551 struct lws_plugin_capability *);
1552 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1554 /** struct lws_plugin */
1556 struct lws_plugin *list; /**< linked list */
1557 #if (UV_VERSION_MAJOR > 0)
1558 uv_lib_t lib; /**< shared library pointer */
1560 void *l; /**< so we can compile on ancient libuv */
1562 char name[64]; /**< name of the plugin */
1563 struct lws_plugin_capability caps; /**< plugin capabilities */
1571 /*! \defgroup generic-sessions plugin: generic-sessions
1572 * \ingroup Protocols-and-Plugins
1574 * ##Plugin Generic-sessions related
1576 * generic-sessions plugin provides a reusable, generic session and login /
1577 * register / forgot password framework including email verification.
1581 #define LWSGS_EMAIL_CONTENT_SIZE 16384
1582 /**< Maximum size of email we might send */
1584 /* SHA-1 binary and hexified versions */
1585 /** typedef struct lwsgw_hash_bin */
1586 typedef struct { unsigned char bin[20]; /**< binary representation of hash */} lwsgw_hash_bin;
1587 /** typedef struct lwsgw_hash */
1588 typedef struct { char id[41]; /**< ascii hex representation of hash */ } lwsgw_hash;
1590 /** enum lwsgs_auth_bits */
1591 enum lwsgs_auth_bits {
1592 LWSGS_AUTH_LOGGED_IN = 1, /**< user is logged in as somebody */
1593 LWSGS_AUTH_ADMIN = 2, /**< logged in as the admin user */
1594 LWSGS_AUTH_VERIFIED = 4, /**< user has verified his email */
1595 LWSGS_AUTH_FORGOT_FLOW = 8, /**< he just completed "forgot password" flow */
1598 /** struct lws_session_info - information about user session status */
1599 struct lws_session_info {
1600 char username[32]; /**< username logged in as, or empty string */
1601 char email[100]; /**< email address associated with login, or empty string */
1602 char ip[72]; /**< ip address session was started from */
1603 unsigned int mask; /**< access rights mask associated with session
1604 * see enum lwsgs_auth_bits */
1605 char session[42]; /**< session id string, usable as opaque uid when not logged in */
1608 /** enum lws_gs_event */
1610 LWSGSE_CREATED, /**< a new user was created */
1611 LWSGSE_DELETED /**< an existing user was deleted */
1614 /** struct lws_gs_event_args */
1615 struct lws_gs_event_args {
1616 enum lws_gs_event event; /**< which event happened */
1617 const char *username; /**< which username the event happened to */
1618 const char *email; /**< the email address of that user */
1624 /*! \defgroup context-and-vhost
1627 * ##Context and Vhost releated functions
1629 * LWS requires that there is one context, in which you may define multiple
1630 * vhosts. Each vhost is a virtual host, with either its own listen port
1631 * or sharing an existing one. Each vhost has its own SSL context that can
1632 * be set up individually or left disabled.
1634 * If you don't care about multiple "site" support, you can ignore it and
1635 * lws will create a single default vhost at context creation time.
1640 * NOTE: These public enums are part of the abi. If you want to add one,
1641 * add it at where specified so existing users are unaffected.
1644 /** enum lws_context_options - context and vhost options */
1645 enum lws_context_options {
1646 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
1648 /**< (VH) Don't allow the connection unless the client has a
1649 * client cert that we recognize; provides
1650 * LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1651 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
1652 /**< (CTX) Don't try to get the server's hostname */
1653 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
1655 /**< (VH) Allow non-SSL (plaintext) connections on the same
1656 * port as SSL is listening... undermines the security of SSL;
1657 * provides LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT */
1658 LWS_SERVER_OPTION_LIBEV = (1 << 4),
1659 /**< (CTX) Use libev event loop */
1660 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
1661 /**< (VH) Disable IPV6 support */
1662 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
1663 /**< (VH) Don't load OS CA certs, you will need to load your
1665 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
1666 /**< (VH) Accept connections with no valid Cert (eg, selfsigned) */
1667 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
1668 /**< (VH) Check UT-8 correctness */
1669 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
1671 /**< (VH) initialize ECDH ciphers */
1672 LWS_SERVER_OPTION_LIBUV = (1 << 10),
1673 /**< (CTX) Use libuv event loop */
1674 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
1676 /**< (VH) Use http redirect to force http to https
1677 * (deprecated: use mount redirection) */
1678 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
1679 /**< (CTX) Initialize the SSL library at all */
1680 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
1681 /**< (CTX) Only create the context when calling context
1682 * create api, implies user code will create its own vhosts */
1683 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
1684 /**< (VH) Use Unix socket */
1685 LWS_SERVER_OPTION_STS = (1 << 15),
1686 /**< (VH) Send Strict Transport Security header, making
1687 * clients subsequently go to https even if user asked for http */
1688 LWS_SERVER_OPTION_IPV6_V6ONLY_MODIFY = (1 << 16),
1689 /**< (VH) Enable LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE to take effect */
1690 LWS_SERVER_OPTION_IPV6_V6ONLY_VALUE = (1 << 17),
1691 /**< (VH) if set, only ipv6 allowed on the vhost */
1692 LWS_SERVER_OPTION_UV_NO_SIGSEGV_SIGFPE_SPIN = (1 << 18),
1693 /**< (CTX) Libuv only: Do not spin on SIGSEGV / SIGFPE. A segfault
1694 * normally makes the lib spin so you can attach a debugger to it
1695 * even if it happened without a debugger in place. You can disable
1696 * that by giving this option.
1698 LWS_SERVER_OPTION_JUST_USE_RAW_ORIGIN = (1 << 19),
1699 /**< For backwards-compatibility reasons, by default
1700 * lws prepends "http://" to the origin you give in the client
1701 * connection info struct. If you give this flag when you create
1702 * the context, only the string you give in the client connect
1703 * info for .origin (if any) will be used directly.
1705 LWS_SERVER_OPTION_FALLBACK_TO_RAW = (1 << 20),
1706 /**< (VH) if invalid http is coming in the first line, */
1707 LWS_SERVER_OPTION_LIBEVENT = (1 << 21),
1708 /**< (CTX) Use libevent event loop */
1709 LWS_SERVER_OPTION_ONLY_RAW = (1 << 22),
1710 /**< (VH) All connections to this vhost / port are RAW as soon as
1711 * the connection is accepted, no HTTP is going to be coming.
1714 /****** add new things just above ---^ ******/
1717 #define lws_check_opt(c, f) (((c) & (f)) == (f))
1719 struct lws_plat_file_ops;
1721 /** struct lws_context_creation_info - parameters to create context and /or vhost with
1723 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1724 * is not given, then for backwards compatibility one vhost is created at
1725 * context-creation time using the info from this struct.
1727 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1728 * at the same time as the context, they are expected to be created afterwards.
1730 struct lws_context_creation_info {
1732 /**< VHOST: Port to listen on. Use CONTEXT_PORT_NO_LISTEN to suppress
1733 * listening for a client. Use CONTEXT_PORT_NO_LISTEN_SERVER if you are
1734 * writing a server but you are using \ref sock-adopt instead of the
1735 * built-in listener */
1737 /**< VHOST: NULL to bind the listen socket to all interfaces, or the
1738 * interface name, eg, "eth2"
1739 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1740 * the pathname of a UNIX domain socket. you can use the UNIX domain
1741 * sockets in abstract namespace, by prepending an at symbol to the
1743 const struct lws_protocols *protocols;
1744 /**< VHOST: Array of structures listing supported protocols and a protocol-
1745 * specific callback for each one. The list is ended with an
1746 * entry that has a NULL callback pointer. */
1747 const struct lws_extension *extensions;
1748 /**< VHOST: NULL or array of lws_extension structs listing the
1749 * extensions this context supports. */
1750 const struct lws_token_limits *token_limits;
1751 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1752 * with a token length limit for each possible WSI_TOKEN_ */
1753 const char *ssl_private_key_password;
1754 /**< VHOST: NULL or the passphrase needed for the private key */
1755 const char *ssl_cert_filepath;
1756 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1757 * to listen using SSL, set to the filepath to fetch the
1758 * server cert from, otherwise NULL for unencrypted */
1759 const char *ssl_private_key_filepath;
1760 /**< VHOST: filepath to private key if wanting SSL mode;
1761 * if this is set to NULL but sll_cert_filepath is set, the
1762 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1763 * to allow setting of the private key directly via openSSL
1765 const char *ssl_ca_filepath;
1766 /**< VHOST: CA certificate filepath or NULL */
1767 const char *ssl_cipher_list;
1768 /**< VHOST: List of valid ciphers to use (eg,
1769 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1770 * or you can leave it as NULL to get "DEFAULT" */
1771 const char *http_proxy_address;
1772 /**< VHOST: If non-NULL, attempts to proxy via the given address.
1773 * If proxy auth is required, use format "username:password\@server:port" */
1774 unsigned int http_proxy_port;
1775 /**< VHOST: If http_proxy_address was non-NULL, uses this port */
1777 /**< CONTEXT: group id to change to after setting listen socket, or -1. */
1779 /**< CONTEXT: user id to change to after setting listen socket, or -1. */
1780 unsigned int options;
1781 /**< VHOST + CONTEXT: 0, or LWS_SERVER_OPTION_... bitfields */
1783 /**< CONTEXT: optional user pointer that can be recovered via the context
1784 * pointer using lws_context_user */
1786 /**< CONTEXT: 0 for no TCP keepalive, otherwise apply this keepalive
1787 * timeout to all libwebsocket sockets, client or server */
1789 /**< CONTEXT: if ka_time was nonzero, after the timeout expires how many
1790 * times to try to get a response from the peer before giving up
1791 * and killing the connection */
1793 /**< CONTEXT: if ka_time was nonzero, how long to wait before each ka_probes
1795 #ifdef LWS_OPENSSL_SUPPORT
1796 SSL_CTX *provided_client_ssl_ctx;
1797 /**< CONTEXT: If non-null, swap out libwebsockets ssl
1798 * implementation for the one provided by provided_ssl_ctx.
1799 * Libwebsockets no longer is responsible for freeing the context
1800 * if this option is selected. */
1801 #else /* maintain structure layout either way */
1802 void *provided_client_ssl_ctx; /**< dummy if ssl disabled */
1805 short max_http_header_data;
1806 /**< CONTEXT: The max amount of header payload that can be handled
1807 * in an http request (unrecognized header payload is dropped) */
1808 short max_http_header_pool;
1809 /**< CONTEXT: The max number of connections with http headers that
1810 * can be processed simultaneously (the corresponding memory is
1811 * allocated for the lifetime of the context). If the pool is
1812 * busy new incoming connections must wait for accept until one
1815 unsigned int count_threads;
1816 /**< CONTEXT: how many contexts to create in an array, 0 = 1 */
1817 unsigned int fd_limit_per_thread;
1818 /**< CONTEXT: nonzero means restrict each service thread to this
1819 * many fds, 0 means the default which is divide the process fd
1820 * limit by the number of threads. */
1821 unsigned int timeout_secs;
1822 /**< VHOST: various processes involving network roundtrips in the
1823 * library are protected from hanging forever by timeouts. If
1824 * nonzero, this member lets you set the timeout used in seconds.
1825 * Otherwise a default timeout is used. */
1826 const char *ecdh_curve;
1827 /**< VHOST: if NULL, defaults to initializing server with "prime256v1" */
1828 const char *vhost_name;
1829 /**< VHOST: name of vhost, must match external DNS name used to
1830 * access the site, like "warmcat.com" as it's used to match
1831 * Host: header and / or SNI name for SSL. */
1832 const char * const *plugin_dirs;
1833 /**< CONTEXT: NULL, or NULL-terminated array of directories to
1834 * scan for lws protocol plugins at context creation time */
1835 const struct lws_protocol_vhost_options *pvo;
1836 /**< VHOST: pointer to optional linked list of per-vhost
1837 * options made accessible to protocols */
1838 int keepalive_timeout;
1839 /**< VHOST: (default = 0 = 60s) seconds to allow remote
1840 * client to hold on to an idle HTTP/1.1 connection */
1841 const char *log_filepath;
1842 /**< VHOST: filepath to append logs to... this is opened before
1843 * any dropping of initial privileges */
1844 const struct lws_http_mount *mounts;
1845 /**< VHOST: optional linked list of mounts for this vhost */
1846 const char *server_string;
1847 /**< CONTEXT: string used in HTTP headers to identify server
1848 * software, if NULL, "libwebsockets". */
1849 unsigned int pt_serv_buf_size;
1850 /**< CONTEXT: 0 = default of 4096. This buffer is used by
1851 * various service related features including file serving, it
1852 * defines the max chunk of file that can be sent at once.
1853 * At the risk of lws having to buffer failed large sends, it
1854 * can be increased to, eg, 128KiB to improve throughput. */
1855 unsigned int max_http_header_data2;
1856 /**< CONTEXT: if max_http_header_data is 0 and this
1857 * is nonzero, this will be used in place of the default. It's
1858 * like this for compatibility with the original short version,
1859 * this is unsigned int length. */
1860 long ssl_options_set;
1861 /**< VHOST: Any bits set here will be set as SSL options */
1862 long ssl_options_clear;
1863 /**< VHOST: Any bits set here will be cleared as SSL options */
1864 unsigned short ws_ping_pong_interval;
1865 /**< CONTEXT: 0 for none, else interval in seconds between sending
1866 * PINGs on idle websocket connections. When the PING is sent,
1867 * the PONG must come within the normal timeout_secs timeout period
1868 * or the connection will be dropped.
1869 * Any RX or TX traffic on the connection restarts the interval timer,
1870 * so a connection which always sends or receives something at intervals
1871 * less than the interval given here will never send PINGs / expect
1872 * PONGs. Conversely as soon as the ws connection is established, an
1873 * idle connection will do the PING / PONG roundtrip as soon as
1874 * ws_ping_pong_interval seconds has passed without traffic
1876 const struct lws_protocol_vhost_options *headers;
1877 /**< VHOST: pointer to optional linked list of per-vhost
1878 * canned headers that are added to server responses */
1880 const struct lws_protocol_vhost_options *reject_service_keywords;
1881 /**< CONTEXT: Optional list of keywords and rejection codes + text.
1883 * The keywords are checked for existing in the user agent string.
1885 * Eg, "badrobot" "404 Not Found"
1887 void *external_baggage_free_on_destroy;
1888 /**< CONTEXT: NULL, or pointer to something externally malloc'd, that
1889 * should be freed when the context is destroyed. This allows you to
1890 * automatically sync the freeing action to the context destruction
1891 * action, so there is no need for an external free() if the context
1892 * succeeded to create.
1895 #ifdef LWS_OPENSSL_SUPPORT
1896 /**< CONTEXT: NULL or struct lws_token_limits pointer which is initialized
1897 * with a token length limit for each possible WSI_TOKEN_ */
1898 const char *client_ssl_private_key_password;
1899 /**< VHOST: NULL or the passphrase needed for the private key */
1900 const char *client_ssl_cert_filepath;
1901 /**< VHOST: If libwebsockets was compiled to use ssl, and you want
1902 * to listen using SSL, set to the filepath to fetch the
1903 * server cert from, otherwise NULL for unencrypted */
1904 const char *client_ssl_private_key_filepath;
1905 /**< VHOST: filepath to private key if wanting SSL mode;
1906 * if this is set to NULL but sll_cert_filepath is set, the
1907 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1908 * to allow setting of the private key directly via openSSL
1910 const char *client_ssl_ca_filepath;
1911 /**< VHOST: CA certificate filepath or NULL */
1912 const char *client_ssl_cipher_list;
1913 /**< VHOST: List of valid ciphers to use (eg,
1914 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1915 * or you can leave it as NULL to get "DEFAULT" */
1918 const struct lws_plat_file_ops *fops;
1919 /**< CONTEXT: NULL, or pointer to an array of fops structs, terminated
1920 * by a sentinel with NULL .open.
1922 * If NULL, lws provides just the platform file operations struct for
1923 * backwards compatibility.
1925 int simultaneous_ssl_restriction;
1926 /**< CONTEXT: 0 (no limit) or limit of simultaneous SSL sessions possible.*/
1928 /* Add new things just above here ---^
1929 * This is part of the ABI, don't needlessly break compatibility
1931 * The below is to ensure later library versions with new
1932 * members added above will see 0 (default) even if the app
1933 * was not built against the newer headers.
1936 void *_unused[8]; /**< dummy */
1940 * lws_create_context() - Create the websocket handler
1941 * \param info: pointer to struct with parameters
1943 * This function creates the listening socket (if serving) and takes care
1944 * of all initialization in one step.
1946 * If option LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, no vhost is
1947 * created; you're expected to create your own vhosts afterwards using
1948 * lws_create_vhost(). Otherwise a vhost named "default" is also created
1949 * using the information in the vhost-related members, for compatibility.
1951 * After initialization, it returns a struct lws_context * that
1952 * represents this server. After calling, user code needs to take care
1953 * of calling lws_service() with the context pointer to get the
1954 * server's sockets serviced. This must be done in the same process
1955 * context as the initialization call.
1957 * The protocol callback functions are called for a handful of events
1958 * including http requests coming in, websocket connections becoming
1959 * established, and data arriving; it's also called periodically to allow
1960 * async transmission.
1962 * HTTP requests are sent always to the FIRST protocol in protocol, since
1963 * at that time websocket protocol has not been negotiated. Other
1964 * protocols after the first one never see any HTTP callback activity.
1966 * The server created is a simple http server by default; part of the
1967 * websocket standard is upgrading this http connection to a websocket one.
1969 * This allows the same server to provide files like scripts and favicon /
1970 * images or whatever over http and dynamic data over websockets all in
1971 * one place; they're all handled in the user callback.
1973 LWS_VISIBLE LWS_EXTERN struct lws_context *
1974 lws_create_context(struct lws_context_creation_info *info);
1977 * lws_context_destroy() - Destroy the websocket context
1978 * \param context: Websocket context
1980 * This function closes any active connections and then frees the
1981 * context. After calling this, any further use of the context is
1984 LWS_VISIBLE LWS_EXTERN void
1985 lws_context_destroy(struct lws_context *context);
1987 LWS_VISIBLE LWS_EXTERN void
1988 lws_context_destroy2(struct lws_context *context);
1990 typedef int (*lws_reload_func)(void);
1993 * lws_context_deprecate() - Deprecate the websocket context
1994 * \param context: Websocket context
1996 * This function is used on an existing context before superceding it
1997 * with a new context.
1999 * It closes any listen sockets in the context, so new connections are
2002 * And it marks the context to be deleted when the number of active
2003 * connections into it falls to zero.
2005 * Otherwise if you attach the deprecated context to the replacement
2006 * context when it has been created using lws_context_attach_deprecated()
2007 * both any deprecated and the new context will service their connections.
2009 * This is aimed at allowing seamless configuration reloads.
2011 * The callback cb will be called after the listen sockets are actually
2012 * closed and may be reopened. In the callback the new context should be
2013 * configured and created. (With libuv, socket close happens async after
2014 * more loop events).
2016 LWS_VISIBLE LWS_EXTERN void
2017 lws_context_deprecate(struct lws_context *context, lws_reload_func cb);
2019 LWS_VISIBLE LWS_EXTERN int
2020 lws_context_is_deprecated(struct lws_context *context);
2023 * lws_set_proxy() - Setups proxy to lws_context.
2024 * \param vhost: pointer to struct lws_vhost you want set proxy for
2025 * \param proxy: pointer to c string containing proxy in format address:port
2027 * Returns 0 if proxy string was parsed and proxy was setup.
2028 * Returns -1 if proxy is NULL or has incorrect format.
2030 * This is only required if your OS does not provide the http_proxy
2031 * environment variable (eg, OSX)
2033 * IMPORTANT! You should call this function right after creation of the
2034 * lws_context and before call to connect. If you call this
2035 * function after connect behavior is undefined.
2036 * This function will override proxy settings made on lws_context
2037 * creation with genenv() call.
2039 LWS_VISIBLE LWS_EXTERN int
2040 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
2046 * lws_create_vhost() - Create a vhost (virtual server context)
2047 * \param context: pointer to result of lws_create_context()
2048 * \param info: pointer to struct with parameters
2050 * This function creates a virtual server (vhost) using the vhost-related
2051 * members of the info struct. You can create many vhosts inside one context
2052 * if you created the context with the option LWS_SERVER_OPTION_EXPLICIT_VHOSTS
2054 LWS_EXTERN LWS_VISIBLE struct lws_vhost *
2055 lws_create_vhost(struct lws_context *context,
2056 struct lws_context_creation_info *info);
2059 * lwsws_get_config_globals() - Parse a JSON server config file
2060 * \param info: pointer to struct with parameters
2061 * \param d: filepath of the config file
2062 * \param config_strings: storage for the config strings extracted from JSON,
2063 * the pointer is incremented as strings are stored
2064 * \param len: pointer to the remaining length left in config_strings
2065 * the value is decremented as strings are stored
2067 * This function prepares a n lws_context_creation_info struct with global
2068 * settings from a file d.
2070 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2072 LWS_VISIBLE LWS_EXTERN int
2073 lwsws_get_config_globals(struct lws_context_creation_info *info, const char *d,
2074 char **config_strings, int *len);
2077 * lwsws_get_config_vhosts() - Create vhosts from a JSON server config file
2078 * \param context: pointer to result of lws_create_context()
2079 * \param info: pointer to struct with parameters
2080 * \param d: filepath of the config file
2081 * \param config_strings: storage for the config strings extracted from JSON,
2082 * the pointer is incremented as strings are stored
2083 * \param len: pointer to the remaining length left in config_strings
2084 * the value is decremented as strings are stored
2086 * This function creates vhosts into a context according to the settings in
2087 *JSON files found in directory d.
2089 * Requires CMake option LWS_WITH_LEJP_CONF to have been enabled
2091 LWS_VISIBLE LWS_EXTERN int
2092 lwsws_get_config_vhosts(struct lws_context *context,
2093 struct lws_context_creation_info *info, const char *d,
2094 char **config_strings, int *len);
2096 /** lws_vhost_get() - \deprecated deprecated: use lws_get_vhost() */
2097 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2098 lws_vhost_get(struct lws *wsi) LWS_WARN_DEPRECATED;
2101 * lws_get_vhost() - return the vhost a wsi belongs to
2103 * \param wsi: which connection
2105 LWS_VISIBLE LWS_EXTERN struct lws_vhost *
2106 lws_get_vhost(struct lws *wsi);
2109 * lws_json_dump_vhost() - describe vhost state and stats in JSON
2111 * \param vh: the vhost
2112 * \param buf: buffer to fill with JSON
2113 * \param len: max length of buf
2115 LWS_VISIBLE LWS_EXTERN int
2116 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
2119 * lws_json_dump_context() - describe context state and stats in JSON
2121 * \param context: the context
2122 * \param buf: buffer to fill with JSON
2123 * \param len: max length of buf
2125 LWS_VISIBLE LWS_EXTERN int
2126 lws_json_dump_context(const struct lws_context *context, char *buf, int len,
2130 * lws_context_user() - get the user data associated with the context
2131 * \param context: Websocket context
2133 * This returns the optional user allocation that can be attached to
2134 * the context the sockets live in at context_create time. It's a way
2135 * to let all sockets serviced in the same context share data without
2136 * using globals statics in the user code.
2138 LWS_VISIBLE LWS_EXTERN void *
2139 lws_context_user(struct lws_context *context);
2141 /*! \defgroup vhost-mounts Vhost mounts and options
2142 * \ingroup context-and-vhost-creation
2144 * ##Vhost mounts and options
2147 /** struct lws_protocol_vhost_options - linked list of per-vhost protocol
2148 * name=value options
2150 * This provides a general way to attach a linked-list of name=value pairs,
2151 * which can also have an optional child link-list using the options member.
2153 struct lws_protocol_vhost_options {
2154 const struct lws_protocol_vhost_options *next; /**< linked list */
2155 const struct lws_protocol_vhost_options *options; /**< child linked-list of more options for this node */
2156 const char *name; /**< name of name=value pair */
2157 const char *value; /**< value of name=value pair */
2160 /** enum lws_mount_protocols
2161 * This specifies the mount protocol for a mountpoint, whether it is to be
2162 * served from a filesystem, or it is a cgi etc.
2164 enum lws_mount_protocols {
2165 LWSMPRO_HTTP = 0, /**< not supported yet */
2166 LWSMPRO_HTTPS = 1, /**< not supported yet */
2167 LWSMPRO_FILE = 2, /**< serve from filesystem directory */
2168 LWSMPRO_CGI = 3, /**< pass to CGI to handle */
2169 LWSMPRO_REDIR_HTTP = 4, /**< redirect to http:// url */
2170 LWSMPRO_REDIR_HTTPS = 5, /**< redirect to https:// url */
2171 LWSMPRO_CALLBACK = 6, /**< hand by named protocol's callback */
2174 /** struct lws_http_mount
2176 * arguments for mounting something in a vhost's url namespace
2178 struct lws_http_mount {
2179 const struct lws_http_mount *mount_next;
2180 /**< pointer to next struct lws_http_mount */
2181 const char *mountpoint;
2182 /**< mountpoint in http pathspace, eg, "/" */
2184 /**< path to be mounted, eg, "/var/www/warmcat.com" */
2186 /**< default target, eg, "index.html" */
2187 const char *protocol;
2188 /**<"protocol-name" to handle mount */
2190 const struct lws_protocol_vhost_options *cgienv;
2191 /**< optional linked-list of cgi options. These are created
2192 * as environment variables for the cgi process
2194 const struct lws_protocol_vhost_options *extra_mimetypes;
2195 /**< optional linked-list of mimetype mappings */
2196 const struct lws_protocol_vhost_options *interpret;
2197 /**< optional linked-list of files to be interpreted */
2200 /**< seconds cgi is allowed to live, if cgi://mount type */
2202 /**< max-age for reuse of client cache of files, seconds */
2203 unsigned int auth_mask;
2204 /**< bits set here must be set for authorized client session */
2206 unsigned int cache_reusable:1; /**< set if client cache may reuse this */
2207 unsigned int cache_revalidate:1; /**< set if client cache should revalidate on use */
2208 unsigned int cache_intermediaries:1; /**< set if intermediaries are allowed to cache */
2210 unsigned char origin_protocol; /**< one of enum lws_mount_protocols */
2211 unsigned char mountpoint_len; /**< length of mountpoint string */
2213 const char *basic_auth_login_file;
2214 /**<NULL, or filepath to use to check basic auth logins against */
2216 /* Add new things just above here ---^
2217 * This is part of the ABI, don't needlessly break compatibility
2219 * The below is to ensure later library versions with new
2220 * members added above will see 0 (default) even if the app
2221 * was not built against the newer headers.
2224 void *_unused[2]; /**< dummy */
2229 /*! \defgroup client
2232 * ##Client releated functions
2236 /** enum lws_client_connect_ssl_connection_flags - flags that may be used
2237 * with struct lws_client_connect_info ssl_connection member to control if
2238 * and how SSL checks apply to the client connection being created
2241 enum lws_client_connect_ssl_connection_flags {
2242 LCCSCF_USE_SSL = (1 << 0),
2243 LCCSCF_ALLOW_SELFSIGNED = (1 << 1),
2244 LCCSCF_SKIP_SERVER_CERT_HOSTNAME_CHECK = (1 << 2),
2245 LCCSCF_ALLOW_EXPIRED = (1 << 3)
2248 /** struct lws_client_connect_info - parameters to connect with when using
2249 * lws_client_connect_via_info() */
2251 struct lws_client_connect_info {
2252 struct lws_context *context;
2253 /**< lws context to create connection in */
2254 const char *address;
2255 /**< remote address to connect to */
2257 /**< remote port to connect to */
2259 /**< nonzero for ssl */
2263 /**< content of host header */
2265 /**< content of origin header */
2266 const char *protocol;
2267 /**< list of ws protocols we could accept */
2268 int ietf_version_or_minus_one;
2269 /**< deprecated: currently leave at 0 or -1 */
2271 /**< if non-NULL, use this as wsi user_data instead of malloc it */
2272 const void *client_exts;
2273 /**< UNUSED... provide in info.extensions at context creation time */
2275 /**< if non-NULL, do this http method instead of ws[s] upgrade.
2276 * use "GET" to be a simple http client connection */
2277 struct lws *parent_wsi;
2278 /**< if another wsi is responsible for this connection, give it here.
2279 * this is used to make sure if the parent closes so do any
2280 * child connections first. */
2281 const char *uri_replace_from;
2282 /**< if non-NULL, when this string is found in URIs in
2283 * text/html content-encoding, it's replaced with uri_replace_to */
2284 const char *uri_replace_to;
2285 /**< see uri_replace_from */
2286 struct lws_vhost *vhost;
2287 /**< vhost to bind to (used to determine related SSL_CTX) */
2289 /**< if not NULL, store the new wsi here early in the connection
2290 * process. Although we return the new wsi, the call to create the
2291 * client connection does progress the connection somewhat and may
2292 * meet an error that will result in the connection being scrubbed and
2293 * NULL returned. While the wsi exists though, he may process a
2294 * callback like CLIENT_CONNECTION_ERROR with his wsi: this gives the
2295 * user callback a way to identify which wsi it is that faced the error
2296 * even before the new wsi is returned and even if ultimately no wsi
2300 /* Add new things just above here ---^
2301 * This is part of the ABI, don't needlessly break compatibility
2303 * The below is to ensure later library versions with new
2304 * members added above will see 0 (default) even if the app
2305 * was not built against the newer headers.
2308 void *_unused[4]; /**< dummy */
2312 * lws_client_connect_via_info() - Connect to another websocket server
2313 * \param ccinfo: pointer to lws_client_connect_info struct
2315 * This function creates a connection to a remote server using the
2316 * information provided in ccinfo.
2318 LWS_VISIBLE LWS_EXTERN struct lws *
2319 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
2322 * lws_client_connect() - Connect to another websocket server
2323 * \deprecated DEPRECATED use lws_client_connect_via_info
2324 * \param clients: Websocket context
2325 * \param address: Remote server address, eg, "myserver.com"
2326 * \param port: Port to connect to on the remote server, eg, 80
2327 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2329 * \param path: Websocket path on server
2330 * \param host: Hostname on server
2331 * \param origin: Socket origin name
2332 * \param protocol: Comma-separated list of protocols being asked for from
2333 * the server, or just one. The server will pick the one it
2334 * likes best. If you don't want to specify a protocol, which is
2335 * legal, use NULL here.
2336 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2337 * protocol supported, or the specific protocol ordinal
2339 * This function creates a connection to a remote server
2341 /* deprecated, use lws_client_connect_via_info() */
2342 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2343 lws_client_connect(struct lws_context *clients, const char *address,
2344 int port, int ssl_connection, const char *path,
2345 const char *host, const char *origin, const char *protocol,
2346 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
2347 /* deprecated, use lws_client_connect_via_info() */
2349 * lws_client_connect_extended() - Connect to another websocket server
2350 * \deprecated DEPRECATED use lws_client_connect_via_info
2351 * \param clients: Websocket context
2352 * \param address: Remote server address, eg, "myserver.com"
2353 * \param port: Port to connect to on the remote server, eg, 80
2354 * \param ssl_connection: 0 = ws://, 1 = wss:// encrypted, 2 = wss:// allow self
2356 * \param path: Websocket path on server
2357 * \param host: Hostname on server
2358 * \param origin: Socket origin name
2359 * \param protocol: Comma-separated list of protocols being asked for from
2360 * the server, or just one. The server will pick the one it
2362 * \param ietf_version_or_minus_one: -1 to ask to connect using the default, latest
2363 * protocol supported, or the specific protocol ordinal
2364 * \param userdata: Pre-allocated user data
2366 * This function creates a connection to a remote server
2368 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2369 lws_client_connect_extended(struct lws_context *clients, const char *address,
2370 int port, int ssl_connection, const char *path,
2371 const char *host, const char *origin,
2372 const char *protocol, int ietf_version_or_minus_one,
2373 void *userdata) LWS_WARN_DEPRECATED;
2376 * lws_init_vhost_client_ssl() - also enable client SSL on an existing vhost
2378 * \param info: client ssl related info
2379 * \param vhost: which vhost to initialize client ssl operations on
2381 * You only need to call this if you plan on using SSL client connections on
2382 * the vhost. For non-SSL client connections, it's not necessary to call this.
2384 * The following members of info are used during the call
2386 * - options must have LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT set,
2387 * otherwise the call does nothing
2388 * - provided_client_ssl_ctx must be NULL to get a generated client
2389 * ssl context, otherwise you can pass a prepared one in by setting it
2390 * - ssl_cipher_list may be NULL or set to the client valid cipher list
2391 * - ssl_ca_filepath may be NULL or client cert filepath
2392 * - ssl_cert_filepath may be NULL or client cert filepath
2393 * - ssl_private_key_filepath may be NULL or client cert private key
2395 * You must create your vhost explicitly if you want to use this, so you have
2396 * a pointer to the vhost. Create the context first with the option flag
2397 * LWS_SERVER_OPTION_EXPLICIT_VHOSTS and then call lws_create_vhost() with
2398 * the same info struct.
2400 LWS_VISIBLE LWS_EXTERN int
2401 lws_init_vhost_client_ssl(const struct lws_context_creation_info *info,
2402 struct lws_vhost *vhost);
2404 * lws_http_client_read() - consume waiting received http client data
2406 * \param wsi: client connection
2407 * \param buf: pointer to buffer pointer - fill with pointer to your buffer
2408 * \param len: pointer to chunk length - fill with max length of buffer
2410 * This is called when the user code is notified client http data has arrived.
2411 * The user code may choose to delay calling it to consume the data, for example
2412 * waiting until an onward connection is writeable.
2414 * For non-chunked connections, up to len bytes of buf are filled with the
2415 * received content. len is set to the actual amount filled before return.
2417 * For chunked connections, the linear buffer content contains the chunking
2418 * headers and it cannot be passed in one lump. Instead, this function will
2419 * call back LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ with in pointing to the
2420 * chunk start and len set to the chunk length. There will be as many calls
2421 * as there are chunks or partial chunks in the buffer.
2423 LWS_VISIBLE LWS_EXTERN int
2424 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2427 * lws_http_client_http_response() - get last HTTP response code
2429 * \param wsi: client connection
2431 * Returns the last server response code, eg, 200 for client http connections.
2433 LWS_VISIBLE LWS_EXTERN unsigned int
2434 lws_http_client_http_response(struct lws *wsi);
2436 LWS_VISIBLE LWS_EXTERN void
2437 lws_client_http_body_pending(struct lws *wsi, int something_left_to_send);
2440 * lws_client_http_body_pending() - control if client connection neeeds to send body
2442 * \param wsi: client connection
2443 * \param something_left_to_send: nonzero if need to send more body, 0 (default)
2444 * if nothing more to send
2446 * If you will send payload data with your HTTP client connection, eg, for POST,
2447 * when you set the related http headers in
2448 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER callback you should also call
2449 * this API with something_left_to_send nonzero, and call
2450 * lws_callback_on_writable(wsi);
2452 * After sending the headers, lws will call your callback with
2453 * LWS_CALLBACK_CLIENT_HTTP_WRITEABLE reason when writable. You can send the
2454 * next part of the http body payload, calling lws_callback_on_writable(wsi);
2455 * if there is more to come, or lws_client_http_body_pending(wsi, 0); to
2456 * let lws know the last part is sent and the connection can move on.
2461 /** \defgroup service Built-in service loop entry
2463 * ##Built-in service loop entry
2465 * If you're not using libev / libuv, these apis are needed to enter the poll()
2466 * wait in lws and service any connections with pending events.
2471 * lws_service() - Service any pending websocket activity
2472 * \param context: Websocket context
2473 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2474 * service otherwise block and service immediately, returning
2475 * after the timeout if nothing needed service.
2477 * This function deals with any pending websocket traffic, for three
2478 * kinds of event. It handles these events on both server and client
2479 * types of connection the same.
2481 * 1) Accept new connections to our context's server
2483 * 2) Call the receive callback for incoming frame data received by
2484 * server or client connections.
2486 * You need to call this service function periodically to all the above
2487 * functions to happen; if your application is single-threaded you can
2488 * just call it in your main event loop.
2490 * Alternatively you can fork a new process that asynchronously handles
2491 * calling this service in a loop. In that case you are happy if this
2492 * call blocks your thread until it needs to take care of something and
2493 * would call it with a large nonzero timeout. Your loop then takes no
2494 * CPU while there is nothing happening.
2496 * If you are calling it in a single-threaded app, you don't want it to
2497 * wait around blocking other things in your loop from happening, so you
2498 * would call it with a timeout_ms of 0, so it returns immediately if
2499 * nothing is pending, or as soon as it services whatever was pending.
2501 LWS_VISIBLE LWS_EXTERN int
2502 lws_service(struct lws_context *context, int timeout_ms);
2505 * lws_service() - Service any pending websocket activity
2507 * \param context: Websocket context
2508 * \param timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2509 * service otherwise block and service immediately, returning
2510 * after the timeout if nothing needed service.
2512 * Same as lws_service(), but for a specific thread service index. Only needed
2513 * if you are spawning multiple service threads.
2515 LWS_VISIBLE LWS_EXTERN int
2516 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2519 * lws_cancel_service_pt() - Cancel servicing of pending socket activity
2521 * \param wsi: Cancel service on the thread this wsi is serviced by
2523 * This function lets a call to lws_service() waiting for a timeout
2524 * immediately return.
2526 * It works by creating a phony event and then swallowing it silently.
2528 * The reason it may be needed is when waiting in poll(), changes to
2529 * the event masks are ignored by the OS until poll() is reentered. This
2530 * lets you halt the poll() wait and make the reentry happen immediately
2531 * instead of having the wait out the rest of the poll timeout.
2533 LWS_VISIBLE LWS_EXTERN void
2534 lws_cancel_service_pt(struct lws *wsi);
2537 * lws_cancel_service() - Cancel wait for new pending socket activity
2538 * \param context: Websocket context
2540 * This function let a call to lws_service() waiting for a timeout
2541 * immediately return.
2543 * What it basically does is provide a fake event that will be swallowed,
2544 * so the wait in poll() is ended. That's useful because poll() doesn't
2545 * attend to changes in POLLIN/OUT/ERR until it re-enters the wait.
2547 LWS_VISIBLE LWS_EXTERN void
2548 lws_cancel_service(struct lws_context *context);
2551 * lws_service_fd() - Service polled socket with something waiting
2552 * \param context: Websocket context
2553 * \param pollfd: The pollfd entry describing the socket fd and which events
2554 * happened, or NULL to tell lws to do only timeout servicing.
2556 * This function takes a pollfd that has POLLIN or POLLOUT activity and
2557 * services it according to the state of the associated
2560 * The one call deals with all "service" that might happen on a socket
2561 * including listen accepts, http files as well as websocket protocol.
2563 * If a pollfd says it has something, you can just pass it to
2564 * lws_service_fd() whether it is a socket handled by lws or not.
2565 * If it sees it is a lws socket, the traffic will be handled and
2566 * pollfd->revents will be zeroed now.
2568 * If the socket is foreign to lws, it leaves revents alone. So you can
2569 * see if you should service yourself by checking the pollfd revents
2570 * after letting lws try to service it.
2572 * You should also call this with pollfd = NULL to just allow the
2573 * once-per-second global timeout checks; if less than a second since the last
2574 * check it returns immediately then.
2576 LWS_VISIBLE LWS_EXTERN int
2577 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
2580 * lws_service_fd_tsi() - Service polled socket in specific service thread
2581 * \param context: Websocket context
2582 * \param pollfd: The pollfd entry describing the socket fd and which events
2584 * \param tsi: thread service index
2586 * Same as lws_service_fd() but used with multiple service threads
2588 LWS_VISIBLE LWS_EXTERN int
2589 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
2593 * lws_service_adjust_timeout() - Check for any connection needing forced service
2594 * \param context: Websocket context
2595 * \param timeout_ms: The original poll timeout value. You can just set this
2596 * to 1 if you don't really have a poll timeout.
2597 * \param tsi: thread service index
2599 * Under some conditions connections may need service even though there is no
2600 * pending network action on them, this is "forced service". For default
2601 * poll() and libuv / libev, the library takes care of calling this and
2602 * dealing with it for you. But for external poll() integration, you need
2603 * access to the apis.
2605 * If anybody needs "forced service", returned timeout is zero. In that case,
2606 * you can call lws_service_tsi() with a timeout of -1 to only service
2607 * guys who need forced service.
2609 LWS_VISIBLE LWS_EXTERN int
2610 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
2612 /* Backwards compatibility */
2613 #define lws_plat_service_tsi lws_service_tsi
2617 /*! \defgroup http HTTP
2619 Modules related to handling HTTP
2623 /*! \defgroup httpft HTTP File transfer
2626 APIs for sending local files in response to HTTP requests
2631 * lws_get_mimetype() - Determine mimetype to use from filename
2633 * \param file: filename
2634 * \param m: NULL, or mount context
2636 * This uses a canned list of known filetypes first, if no match and m is
2637 * non-NULL, then tries a list of per-mount file suffix to mimtype mappings.
2639 * Returns either NULL or a pointer to the mimetype matching the file.
2641 LWS_VISIBLE LWS_EXTERN const char *
2642 lws_get_mimetype(const char *file, const struct lws_http_mount *m);
2645 * lws_serve_http_file() - Send a file back to the client using http
2646 * \param wsi: Websocket instance (available from user callback)
2647 * \param file: The file to issue over http
2648 * \param content_type: The http content type, eg, text/html
2649 * \param other_headers: NULL or pointer to header string
2650 * \param other_headers_len: length of the other headers if non-NULL
2652 * This function is intended to be called from the callback in response
2653 * to http requests from the client. It allows the callback to issue
2654 * local files down the http link in a single step.
2656 * Returning <0 indicates error and the wsi should be closed. Returning
2657 * >0 indicates the file was completely sent and
2658 * lws_http_transaction_completed() called on the wsi (and close if != 0)
2659 * ==0 indicates the file transfer is started and needs more service later,
2660 * the wsi should be left alone.
2662 LWS_VISIBLE LWS_EXTERN int
2663 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
2664 const char *other_headers, int other_headers_len);
2666 LWS_VISIBLE LWS_EXTERN int
2667 lws_serve_http_file_fragment(struct lws *wsi);
2670 /*! \defgroup html-chunked-substitution HTML Chunked Substitution
2673 * ##HTML chunked Substitution
2675 * APIs for receiving chunks of text, replacing a set of variable names via
2676 * a callback, and then prepending and appending HTML chunked encoding
2682 HTTP_STATUS_OK = 200,
2683 HTTP_STATUS_NO_CONTENT = 204,
2684 HTTP_STATUS_PARTIAL_CONTENT = 206,
2686 HTTP_STATUS_MOVED_PERMANENTLY = 301,
2687 HTTP_STATUS_FOUND = 302,
2688 HTTP_STATUS_SEE_OTHER = 303,
2689 HTTP_STATUS_NOT_MODIFIED = 304,
2691 HTTP_STATUS_BAD_REQUEST = 400,
2692 HTTP_STATUS_UNAUTHORIZED,
2693 HTTP_STATUS_PAYMENT_REQUIRED,
2694 HTTP_STATUS_FORBIDDEN,
2695 HTTP_STATUS_NOT_FOUND,
2696 HTTP_STATUS_METHOD_NOT_ALLOWED,
2697 HTTP_STATUS_NOT_ACCEPTABLE,
2698 HTTP_STATUS_PROXY_AUTH_REQUIRED,
2699 HTTP_STATUS_REQUEST_TIMEOUT,
2700 HTTP_STATUS_CONFLICT,
2702 HTTP_STATUS_LENGTH_REQUIRED,
2703 HTTP_STATUS_PRECONDITION_FAILED,
2704 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
2705 HTTP_STATUS_REQ_URI_TOO_LONG,
2706 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
2707 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
2708 HTTP_STATUS_EXPECTATION_FAILED,
2710 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
2711 HTTP_STATUS_NOT_IMPLEMENTED,
2712 HTTP_STATUS_BAD_GATEWAY,
2713 HTTP_STATUS_SERVICE_UNAVAILABLE,
2714 HTTP_STATUS_GATEWAY_TIMEOUT,
2715 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
2718 struct lws_process_html_args {
2719 char *p; /**< pointer to the buffer containing the data */
2720 int len; /**< length of the original data at p */
2721 int max_len; /**< maximum length we can grow the data to */
2722 int final; /**< set if this is the last chunk of the file */
2725 typedef const char *(*lws_process_html_state_cb)(void *data, int index);
2727 struct lws_process_html_state {
2728 char *start; /**< pointer to start of match */
2729 char swallow[16]; /**< matched character buffer */
2730 int pos; /**< position in match */
2731 void *data; /**< opaque pointer */
2732 const char * const *vars; /**< list of variable names */
2733 int count_vars; /**< count of variable names */
2735 lws_process_html_state_cb replace; /**< called on match to perform substitution */
2738 /*! lws_chunked_html_process() - generic chunked substitution
2739 * \param args: buffer to process using chunked encoding
2740 * \param s: current processing state
2742 LWS_VISIBLE LWS_EXTERN int
2743 lws_chunked_html_process(struct lws_process_html_args *args,
2744 struct lws_process_html_state *s);
2747 /** \defgroup HTTP-headers-read HTTP headers: read
2750 * ##HTTP header releated functions
2752 * In lws the client http headers are temporarily stored in a pool, only for the
2753 * duration of the http part of the handshake. It's because in most cases,
2754 * the header content is ignored for the whole rest of the connection lifetime
2755 * and would then just be taking up space needlessly.
2757 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
2758 * the http headers are still allocated, you can use these apis then to
2759 * look at and copy out interesting header content (cookies, etc)
2761 * Notice that the header total length reported does not include a terminating
2762 * '\0', however you must allocate for it when using the _copy apis. So the
2763 * length reported for a header containing "123" is 3, but you must provide
2764 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2765 * will fail with a nonzero return code.
2767 * In the special case of URL arguments, like ?x=1&y=2, the arguments are
2768 * stored in a token named for the method, eg, WSI_TOKEN_GET_URI if it
2769 * was a GET or WSI_TOKEN_POST_URI if POST. You can check the total
2770 * length to confirm the method.
2772 * For URL arguments, each argument is stored urldecoded in a "fragment", so
2773 * you can use the fragment-aware api lws_hdr_copy_fragment() to access each
2774 * argument in turn: the fragments contain urldecoded strings like x=1 or y=2.
2776 * As a convenience, lws has an api that will find the fragment with a
2777 * given name= part, lws_get_urlarg_by_name().
2781 /** struct lws_tokens
2782 * you need these to look at headers that have been parsed if using the
2783 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
2784 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
2785 * points to .token_len chars containing that header content.
2788 char *token; /**< pointer to start of the token */
2789 int token_len; /**< length of the token's value */
2792 /* enum lws_token_indexes
2793 * these have to be kept in sync with lextable.h / minilex.c
2795 * NOTE: These public enums are part of the abi. If you want to add one,
2796 * add it at where specified so existing users are unaffected.
2798 enum lws_token_indexes {
2799 WSI_TOKEN_GET_URI = 0,
2800 WSI_TOKEN_POST_URI = 1,
2801 WSI_TOKEN_OPTIONS_URI = 2,
2803 WSI_TOKEN_CONNECTION = 4,
2804 WSI_TOKEN_UPGRADE = 5,
2805 WSI_TOKEN_ORIGIN = 6,
2806 WSI_TOKEN_DRAFT = 7,
2807 WSI_TOKEN_CHALLENGE = 8,
2808 WSI_TOKEN_EXTENSIONS = 9,
2809 WSI_TOKEN_KEY1 = 10,
2810 WSI_TOKEN_KEY2 = 11,
2811 WSI_TOKEN_PROTOCOL = 12,
2812 WSI_TOKEN_ACCEPT = 13,
2813 WSI_TOKEN_NONCE = 14,
2814 WSI_TOKEN_HTTP = 15,
2815 WSI_TOKEN_HTTP2_SETTINGS = 16,
2816 WSI_TOKEN_HTTP_ACCEPT = 17,
2817 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
2818 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
2819 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
2820 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
2821 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
2822 WSI_TOKEN_HTTP_PRAGMA = 23,
2823 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
2824 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
2825 WSI_TOKEN_HTTP_COOKIE = 26,
2826 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
2827 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
2828 WSI_TOKEN_HTTP_DATE = 29,
2829 WSI_TOKEN_HTTP_RANGE = 30,
2830 WSI_TOKEN_HTTP_REFERER = 31,
2832 WSI_TOKEN_VERSION = 33,
2833 WSI_TOKEN_SWORIGIN = 34,
2835 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
2836 WSI_TOKEN_HTTP_COLON_METHOD = 36,
2837 WSI_TOKEN_HTTP_COLON_PATH = 37,
2838 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
2839 WSI_TOKEN_HTTP_COLON_STATUS = 39,
2841 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
2842 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
2843 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
2844 WSI_TOKEN_HTTP_AGE = 43,
2845 WSI_TOKEN_HTTP_ALLOW = 44,
2846 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
2847 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
2848 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
2849 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
2850 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
2851 WSI_TOKEN_HTTP_ETAG = 50,
2852 WSI_TOKEN_HTTP_EXPECT = 51,
2853 WSI_TOKEN_HTTP_EXPIRES = 52,
2854 WSI_TOKEN_HTTP_FROM = 53,
2855 WSI_TOKEN_HTTP_IF_MATCH = 54,
2856 WSI_TOKEN_HTTP_IF_RANGE = 55,
2857 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
2858 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
2859 WSI_TOKEN_HTTP_LINK = 58,
2860 WSI_TOKEN_HTTP_LOCATION = 59,
2861 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
2862 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
2863 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
2864 WSI_TOKEN_HTTP_REFRESH = 63,
2865 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
2866 WSI_TOKEN_HTTP_SERVER = 65,
2867 WSI_TOKEN_HTTP_SET_COOKIE = 66,
2868 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
2869 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
2870 WSI_TOKEN_HTTP_USER_AGENT = 69,
2871 WSI_TOKEN_HTTP_VARY = 70,
2872 WSI_TOKEN_HTTP_VIA = 71,
2873 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
2875 WSI_TOKEN_PATCH_URI = 73,
2876 WSI_TOKEN_PUT_URI = 74,
2877 WSI_TOKEN_DELETE_URI = 75,
2879 WSI_TOKEN_HTTP_URI_ARGS = 76,
2880 WSI_TOKEN_PROXY = 77,
2881 WSI_TOKEN_HTTP_X_REAL_IP = 78,
2882 WSI_TOKEN_HTTP1_0 = 79,
2883 WSI_TOKEN_X_FORWARDED_FOR = 80,
2884 WSI_TOKEN_CONNECT = 81,
2885 /****** add new things just above ---^ ******/
2887 /* use token storage to stash these internally, not for
2890 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
2891 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
2892 _WSI_TOKEN_CLIENT_URI,
2893 _WSI_TOKEN_CLIENT_HOST,
2894 _WSI_TOKEN_CLIENT_ORIGIN,
2895 _WSI_TOKEN_CLIENT_METHOD,
2897 /* always last real token index*/
2900 /* parser state additions, no storage associated */
2901 WSI_TOKEN_NAME_PART,
2903 WSI_TOKEN_SKIPPING_SAW_CR,
2904 WSI_PARSING_COMPLETE,
2905 WSI_INIT_TOKEN_MUXURL,
2908 struct lws_token_limits {
2909 unsigned short token_limit[WSI_TOKEN_COUNT]; /**< max chars for this token */
2913 * lws_token_to_string() - returns a textual representation of a hdr token index
2915 * \param: token index
2917 LWS_VISIBLE LWS_EXTERN const unsigned char *
2918 lws_token_to_string(enum lws_token_indexes token);
2922 * lws_hdr_total_length: report length of all fragments of a header totalled up
2923 * The returned length does not include the space for a
2926 * \param wsi: websocket connection
2927 * \param h: which header index we are interested in
2929 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2930 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
2933 * lws_hdr_fragment_length: report length of a single fragment of a header
2934 * The returned length does not include the space for a
2937 * \param wsi: websocket connection
2938 * \param h: which header index we are interested in
2939 * \param frag_idx: which fragment of h we want to get the length of
2941 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2942 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
2945 * lws_hdr_copy() - copy a single fragment of the given header to a buffer
2946 * The buffer length len must include space for an additional
2947 * terminating '\0', or it will fail returning -1.
2949 * \param wsi: websocket connection
2950 * \param dest: destination buffer
2951 * \param len: length of destination buffer
2952 * \param h: which header index we are interested in
2954 * copies the whole, aggregated header, even if it was delivered in
2955 * several actual headers piece by piece
2957 LWS_VISIBLE LWS_EXTERN int
2958 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
2961 * lws_hdr_copy_fragment() - copy a single fragment of the given header to a buffer
2962 * The buffer length len must include space for an additional
2963 * terminating '\0', or it will fail returning -1.
2964 * If the requested fragment index is not present, it fails
2967 * \param wsi: websocket connection
2968 * \param dest: destination buffer
2969 * \param len: length of destination buffer
2970 * \param h: which header index we are interested in
2971 * \param frag_idx: which fragment of h we want to copy
2973 * Normally this is only useful
2974 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
2975 * fragment 0 will contain "x=1" and fragment 1 "y=2"
2977 LWS_VISIBLE LWS_EXTERN int
2978 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
2979 enum lws_token_indexes h, int frag_idx);
2982 * lws_get_urlarg_by_name() - return pointer to arg value if present
2983 * \param wsi: the connection to check
2984 * \param name: the arg name, like "token="
2985 * \param buf: the buffer to receive the urlarg (including the name= part)
2986 * \param len: the length of the buffer to receive the urlarg
2988 * Returns NULL if not found or a pointer inside buf to just after the
2991 LWS_VISIBLE LWS_EXTERN const char *
2992 lws_get_urlarg_by_name(struct lws *wsi, const char *name, char *buf, int len);
2995 /*! \defgroup HTTP-headers-create HTTP headers: create
2997 * ## HTTP headers: Create
2999 * These apis allow you to create HTTP response headers in a way compatible with
3000 * both HTTP/1.x and HTTP/2.
3002 * They each append to a buffer taking care about the buffer end, which is
3003 * passed in as a pointer. When data is written to the buffer, the current
3004 * position p is updated accordingly.
3006 * All of these apis are LWS_WARN_UNUSED_RESULT as they can run out of space
3007 * and fail with nonzero return.
3011 #define LWSAHH_CODE_MASK ((1 << 16) - 1)
3012 #define LWSAHH_FLAG_NO_SERVER_NAME (1 << 30)
3015 * lws_add_http_header_status() - add the HTTP response status code
3017 * \param wsi: the connection to check
3018 * \param code: an HTTP code like 200, 404 etc (see enum http_status)
3019 * \param p: pointer to current position in buffer pointer
3020 * \param end: pointer to end of buffer
3022 * Adds the initial response code, so should be called first.
3024 * Code may additionally take OR'd flags:
3026 * LWSAHH_FLAG_NO_SERVER_NAME: don't apply server name header this time
3028 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3029 lws_add_http_header_status(struct lws *wsi,
3030 unsigned int code, unsigned char **p,
3031 unsigned char *end);
3033 * lws_add_http_header_by_name() - append named header and value
3035 * \param wsi: the connection to check
3036 * \param name: the hdr name, like "my-header"
3037 * \param value: the value after the = for this header
3038 * \param length: the length of the value
3039 * \param p: pointer to current position in buffer pointer
3040 * \param end: pointer to end of buffer
3042 * Appends name: value to the headers
3044 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3045 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
3046 const unsigned char *value, int length,
3047 unsigned char **p, unsigned char *end);
3049 * lws_add_http_header_by_token() - append given header and value
3051 * \param wsi: the connection to check
3052 * \param token: the token index for the hdr
3053 * \param value: the value after the = for this header
3054 * \param length: the length of the value
3055 * \param p: pointer to current position in buffer pointer
3056 * \param end: pointer to end of buffer
3058 * Appends name=value to the headers, but is able to take advantage of better
3059 * HTTP/2 coding mechanisms where possible.
3061 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3062 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
3063 const unsigned char *value, int length,
3064 unsigned char **p, unsigned char *end);
3066 * lws_add_http_header_content_length() - append content-length helper
3068 * \param wsi: the connection to check
3069 * \param content_length: the content length to use
3070 * \param p: pointer to current position in buffer pointer
3071 * \param end: pointer to end of buffer
3073 * Appends content-length: content_length to the headers
3075 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3076 lws_add_http_header_content_length(struct lws *wsi,
3077 unsigned long content_length,
3078 unsigned char **p, unsigned char *end);
3080 * lws_finalize_http_header() - terminate header block
3082 * \param wsi: the connection to check
3083 * \param p: pointer to current position in buffer pointer
3084 * \param end: pointer to end of buffer
3086 * Indicates no more headers will be added
3088 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3089 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
3090 unsigned char *end);
3093 /** \defgroup form-parsing Form Parsing
3095 * ##POSTed form parsing functions
3097 * These lws_spa (stateful post arguments) apis let you parse and urldecode
3098 * POSTed form arguments, both using simple urlencoded and multipart transfer
3101 * It's capable of handling file uploads as well a named input parsing,
3102 * and the apis are the same for both form upload styles.
3104 * You feed it a list of parameter names and it creates pointers to the
3105 * urldecoded arguments: file upload parameters pass the file data in chunks to
3106 * a user-supplied callback as they come.
3108 * Since it's stateful, it handles the incoming data needing more than one
3109 * POST_BODY callback and has no limit on uploaded file size.
3113 /** enum lws_spa_fileupload_states */
3114 enum lws_spa_fileupload_states {
3116 /**< a chunk of file content has arrived */
3117 LWS_UFS_FINAL_CONTENT,
3118 /**< the last chunk (possibly zero length) of file content has arrived */
3120 /**< a new file is starting to arrive */
3124 * lws_spa_fileupload_cb() - callback to receive file upload data
3126 * \param data: opt_data pointer set in lws_spa_create
3127 * \param name: name of the form field being uploaded
3128 * \param filename: original filename from client
3129 * \param buf: start of data to receive
3130 * \param len: length of data to receive
3131 * \param state: information about how this call relates to file
3133 * Notice name and filename shouldn't be trusted, as they are passed from
3134 * HTTP provided by the client.
3136 typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
3137 const char *filename, char *buf, int len,
3138 enum lws_spa_fileupload_states state);
3140 /** struct lws_spa - opaque urldecode parser capable of handling multipart
3141 * and file uploads */
3145 * lws_spa_create() - create urldecode parser
3147 * \param wsi: lws connection (used to find Content Type)
3148 * \param param_names: array of form parameter names, like "username"
3149 * \param count_params: count of param_names
3150 * \param max_storage: total amount of form parameter values we can store
3151 * \param opt_cb: NULL, or callback to receive file upload data.
3152 * \param opt_data: NULL, or user pointer provided to opt_cb.
3154 * Creates a urldecode parser and initializes it.
3156 * opt_cb can be NULL if you just want normal name=value parsing, however
3157 * if one or more entries in your form are bulk data (file transfer), you
3158 * can provide this callback and filter on the name callback parameter to
3159 * treat that urldecoded data separately. The callback should return -1
3160 * in case of fatal error, and 0 if OK.
3162 LWS_VISIBLE LWS_EXTERN struct lws_spa *
3163 lws_spa_create(struct lws *wsi, const char * const *param_names,
3164 int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
3168 * lws_spa_process() - parses a chunk of input data
3170 * \param spa: the parser object previously created
3171 * \param in: incoming, urlencoded data
3172 * \param len: count of bytes valid at \param in
3174 LWS_VISIBLE LWS_EXTERN int
3175 lws_spa_process(struct lws_spa *spa, const char *in, int len);
3178 * lws_spa_finalize() - indicate incoming data completed
3180 * \param spa: the parser object previously created
3182 LWS_VISIBLE LWS_EXTERN int
3183 lws_spa_finalize(struct lws_spa *spa);
3186 * lws_spa_get_length() - return length of parameter value
3188 * \param spa: the parser object previously created
3189 * \param n: parameter ordinal to return length of value for
3191 LWS_VISIBLE LWS_EXTERN int
3192 lws_spa_get_length(struct lws_spa *spa, int n);
3195 * lws_spa_get_string() - return pointer to parameter value
3196 * \param spa: the parser object previously created
3197 * \param n: parameter ordinal to return pointer to value for
3199 LWS_VISIBLE LWS_EXTERN const char *
3200 lws_spa_get_string(struct lws_spa *spa, int n);
3203 * lws_spa_destroy() - destroy parser object
3205 * \param spa: the parser object previously created
3207 LWS_VISIBLE LWS_EXTERN int
3208 lws_spa_destroy(struct lws_spa *spa);
3211 /*! \defgroup urlendec Urlencode and Urldecode
3214 * ##HTML chunked Substitution
3216 * APIs for receiving chunks of text, replacing a set of variable names via
3217 * a callback, and then prepending and appending HTML chunked encoding
3223 * lws_urlencode() - like strncpy but with urlencoding
3225 * \param escaped: output buffer
3226 * \param string: input buffer ('/0' terminated)
3227 * \param len: output buffer max length
3229 * Because urlencoding expands the output string, it's not
3230 * possible to do it in-place, ie, with escaped == string
3232 LWS_VISIBLE LWS_EXTERN const char *
3233 lws_urlencode(char *escaped, const char *string, int len);
3238 * This simple urldecode only operates until the first '\0' and requires the
3239 * data to exist all at once
3242 * lws_urldecode() - like strncpy but with urldecoding
3244 * \param string: output buffer
3245 * \param escaped: input buffer ('\0' terminated)
3246 * \param len: output buffer max length
3248 * This is only useful for '\0' terminated strings
3250 * Since urldecoding only shrinks the output string, it is possible to
3251 * do it in-place, ie, string == escaped
3253 LWS_VISIBLE LWS_EXTERN int
3254 lws_urldecode(char *string, const char *escaped, int len);
3257 * lws_return_http_status() - Return simple http status
3258 * \param wsi: Websocket instance (available from user callback)
3259 * \param code: Status index, eg, 404
3260 * \param html_body: User-readable HTML description < 1KB, or NULL
3262 * Helper to report HTTP errors back to the client cleanly and
3265 LWS_VISIBLE LWS_EXTERN int
3266 lws_return_http_status(struct lws *wsi, unsigned int code,
3267 const char *html_body);
3270 * lws_http_redirect() - write http redirect into buffer
3272 * \param wsi: websocket connection
3273 * \param code: HTTP response code (eg, 301)
3274 * \param loc: where to redirect to
3275 * \param len: length of loc
3276 * \param p: pointer current position in buffer (updated as we write)
3277 * \param end: pointer to end of buffer
3279 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3280 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
3281 unsigned char **p, unsigned char *end);
3284 * lws_http_transaction_completed() - wait for new http transaction or close
3285 * \param wsi: websocket connection
3287 * Returns 1 if the HTTP connection must close now
3288 * Returns 0 and resets connection to wait for new HTTP header /
3289 * transaction if possible
3291 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
3292 lws_http_transaction_completed(struct lws *wsi);
3295 /*! \defgroup pur Sanitize / purify SQL and JSON helpers
3297 * ##Sanitize / purify SQL and JSON helpers
3299 * APIs for escaping untrusted JSON and SQL safely before use
3304 * lws_sql_purify() - like strncpy but with escaping for sql quotes
3306 * \param escaped: output buffer
3307 * \param string: input buffer ('/0' terminated)
3308 * \param len: output buffer max length
3310 * Because escaping expands the output string, it's not
3311 * possible to do it in-place, ie, with escaped == string
3313 LWS_VISIBLE LWS_EXTERN const char *
3314 lws_sql_purify(char *escaped, const char *string, int len);
3317 * lws_json_purify() - like strncpy but with escaping for json chars
3319 * \param escaped: output buffer
3320 * \param string: input buffer ('/0' terminated)
3321 * \param len: output buffer max length
3323 * Because escaping expands the output string, it's not
3324 * possible to do it in-place, ie, with escaped == string
3326 LWS_VISIBLE LWS_EXTERN const char *
3327 lws_json_purify(char *escaped, const char *string, int len);
3330 /*! \defgroup ev libev helpers
3334 * APIs specific to libev event loop itegration
3338 #ifdef LWS_USE_LIBEV
3339 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
3341 LWS_VISIBLE LWS_EXTERN int
3342 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
3343 lws_ev_signal_cb_t *cb);
3345 LWS_VISIBLE LWS_EXTERN int
3346 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
3348 LWS_VISIBLE LWS_EXTERN void
3349 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
3350 #endif /* LWS_USE_LIBEV */
3354 /*! \defgroup uv libuv helpers
3358 * APIs specific to libuv event loop itegration
3361 #ifdef LWS_USE_LIBUV
3362 LWS_VISIBLE LWS_EXTERN int
3363 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
3366 LWS_VISIBLE LWS_EXTERN void
3367 lws_libuv_run(const struct lws_context *context, int tsi);
3369 LWS_VISIBLE LWS_EXTERN void
3370 lws_libuv_stop(struct lws_context *context);
3372 LWS_VISIBLE LWS_EXTERN void
3373 lws_libuv_stop_without_kill(const struct lws_context *context, int tsi);
3375 LWS_VISIBLE LWS_EXTERN int
3376 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
3378 LWS_VISIBLE LWS_EXTERN uv_loop_t *
3379 lws_uv_getloop(struct lws_context *context, int tsi);
3381 LWS_VISIBLE LWS_EXTERN void
3382 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
3383 #endif /* LWS_USE_LIBUV */
3386 /*! \defgroup event libevent helpers
3388 * ##libevent helpers
3390 * APIs specific to libevent event loop itegration
3394 #ifdef LWS_USE_LIBEVENT
3395 typedef void (lws_event_signal_cb_t) (evutil_socket_t sock_fd, short revents,
3398 LWS_VISIBLE LWS_EXTERN int
3399 lws_event_sigint_cfg(struct lws_context *context, int use_event_sigint,
3400 lws_event_signal_cb_t cb);
3402 LWS_VISIBLE LWS_EXTERN int
3403 lws_event_initloop(struct lws_context *context, struct event_base *loop,
3406 LWS_VISIBLE LWS_EXTERN void
3407 lws_event_sigint_cb(evutil_socket_t sock_fd, short revents,
3409 #endif /* LWS_USE_LIBEVENT */
3413 /*! \defgroup timeout Connection timeouts
3415 APIs related to setting connection timeouts
3420 * NOTE: These public enums are part of the abi. If you want to add one,
3421 * add it at where specified so existing users are unaffected.
3423 enum pending_timeout {
3424 NO_PENDING_TIMEOUT = 0,
3425 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
3426 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
3427 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
3428 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
3429 PENDING_TIMEOUT_AWAITING_PING = 5,
3430 PENDING_TIMEOUT_CLOSE_ACK = 6,
3431 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
3432 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
3433 PENDING_TIMEOUT_SSL_ACCEPT = 9,
3434 PENDING_TIMEOUT_HTTP_CONTENT = 10,
3435 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
3436 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
3437 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
3438 PENDING_TIMEOUT_CGI = 14,
3439 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
3440 PENDING_TIMEOUT_WS_PONG_CHECK_SEND_PING = 16,
3441 PENDING_TIMEOUT_WS_PONG_CHECK_GET_PONG = 17,
3442 PENDING_TIMEOUT_CLIENT_ISSUE_PAYLOAD = 18,
3444 /****** add new things just above ---^ ******/
3448 * lws_set_timeout() - marks the wsi as subject to a timeout
3450 * You will not need this unless you are doing something special
3452 * \param wsi: Websocket connection instance
3453 * \param reason: timeout reason
3454 * \param secs: how many seconds
3456 LWS_VISIBLE LWS_EXTERN void
3457 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
3460 /*! \defgroup sending-data Sending data
3462 APIs related to writing data on a connection
3465 #if !defined(LWS_SIZEOFPTR)
3466 #define LWS_SIZEOFPTR (sizeof (void *))
3468 #if !defined(u_int64_t)
3469 #define u_int64_t unsigned long long
3472 #if defined(__x86_64__)
3473 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
3475 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
3477 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
3478 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
3479 #define LWS_PRE _LWS_PAD(4 + 10)
3480 /* used prior to 1.7 and retained for backward compatibility */
3481 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
3482 #define LWS_SEND_BUFFER_POST_PADDING 0
3485 * NOTE: These public enums are part of the abi. If you want to add one,
3486 * add it at where specified so existing users are unaffected.
3488 enum lws_write_protocol {
3490 /**< Send a ws TEXT message,the pointer must have LWS_PRE valid
3491 * memory behind it. The receiver expects only valid utf-8 in the
3493 LWS_WRITE_BINARY = 1,
3494 /**< Send a ws BINARY message, the pointer must have LWS_PRE valid
3495 * memory behind it. Any sequence of bytes is valid */
3496 LWS_WRITE_CONTINUATION = 2,
3497 /**< Continue a previous ws message, the pointer must have LWS_PRE valid
3498 * memory behind it */
3500 /**< Send HTTP content */
3502 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
3506 /* Same as write_http but we know this write ends the transaction */
3507 LWS_WRITE_HTTP_FINAL = 7,
3511 LWS_WRITE_HTTP_HEADERS = 8,
3512 /**< Send http headers (http2 encodes this payload and LWS_WRITE_HTTP
3513 * payload differently, http 1.x links also handle this correctly. so
3514 * to be compatible with both in the future,header response part should
3515 * be sent using this regardless of http version expected)
3518 /****** add new things just above ---^ ******/
3522 LWS_WRITE_NO_FIN = 0x40,
3523 /**< This part of the message is not the end of the message */
3525 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
3526 /**< client packet payload goes out on wire unmunged
3527 * only useful for security tests since normal servers cannot
3528 * decode the content if used */
3533 * lws_write() - Apply protocol then write data to client
3534 * \param wsi: Websocket instance (available from user callback)
3535 * \param buf: The data to send. For data being sent on a websocket
3536 * connection (ie, not default http), this buffer MUST have
3537 * LWS_PRE bytes valid BEFORE the pointer.
3538 * This is so the protocol header data can be added in-situ.
3539 * \param len: Count of the data bytes in the payload starting from buf
3540 * \param protocol: Use LWS_WRITE_HTTP to reply to an http connection, and one
3541 * of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
3542 * data on a websockets connection. Remember to allow the extra
3543 * bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
3546 * This function provides the way to issue data back to the client
3547 * for both http and websocket protocols.
3551 * When sending with websocket protocol
3555 * LWS_WRITE_CONTINUATION,
3559 * the send buffer has to have LWS_PRE bytes valid BEFORE
3560 * the buffer pointer you pass to lws_write().
3562 * This allows us to add protocol info before and after the data, and send as
3563 * one packet on the network without payload copying, for maximum efficiency.
3565 * So for example you need this kind of code to use lws_write with a
3568 * char buf[LWS_PRE + 128];
3570 * // fill your part of the buffer... for example here it's all zeros
3571 * memset(&buf[LWS_PRE], 0, 128);
3573 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
3575 * When sending HTTP, with
3578 * LWS_WRITE_HTTP_HEADERS
3579 * LWS_WRITE_HTTP_FINAL
3581 * there is no protocol data prepended, and don't need to take care about the
3582 * LWS_PRE bytes valid before the buffer pointer.
3584 * LWS_PRE is at least the frame nonce + 2 header + 8 length
3585 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
3586 * The example apps no longer use it.
3588 * Pad LWS_PRE to the CPU word size, so that word references
3589 * to the address immediately after the padding won't cause an unaligned access
3590 * error. Sometimes for performance reasons the recommended padding is even
3591 * larger than sizeof(void *).
3593 * In the case of sending using websocket protocol, be sure to allocate
3594 * valid storage before and after buf as explained above. This scheme
3595 * allows maximum efficiency of sending data and protocol in a single
3596 * packet while not burdening the user code with any protocol knowledge.
3598 * Return may be -1 for a fatal error needing connection close, or the
3599 * number of bytes sent.
3604 * The OS may not accept everything you asked to write on the connection.
3606 * Posix defines POLLOUT indication from poll() to show that the connection
3607 * will accept more write data, but it doesn't specifiy how much. It may just
3608 * accept one byte of whatever you wanted to send.
3610 * LWS will buffer the remainder automatically, and send it out autonomously.
3612 * During that time, WRITABLE callbacks will be suppressed.
3614 * This is to handle corner cases where unexpectedly the OS refuses what we
3615 * usually expect it to accept. You should try to send in chunks that are
3616 * almost always accepted in order to avoid the inefficiency of the buffering.
3618 LWS_VISIBLE LWS_EXTERN int
3619 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
3620 enum lws_write_protocol protocol);
3622 /* helper for case where buffer may be const */
3623 #define lws_write_http(wsi, buf, len) \
3624 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
3627 /** \defgroup callback-when-writeable Callback when writeable
3629 * ##Callback When Writeable
3631 * lws can only write data on a connection when it is able to accept more
3632 * data without blocking.
3634 * So a basic requirement is we should only use the lws_write() apis when the
3635 * connection we want to write on says that he can accept more data.
3637 * When lws cannot complete your send at the time, it will buffer the data
3638 * and send it in the background, suppressing any further WRITEABLE callbacks
3639 * on that connection until it completes. So it is important to write new
3640 * things in a new writeable callback.
3642 * These apis reflect the various ways we can indicate we would like to be
3643 * called back when one or more connections is writeable.
3648 * lws_callback_on_writable() - Request a callback when this socket
3649 * becomes able to be written to without
3652 * \param wsi: Websocket connection instance to get callback for
3654 * - Which: only this wsi
3655 * - When: when the individual connection becomes writeable
3656 * - What: LWS_CALLBACK_*_WRITEABLE
3658 LWS_VISIBLE LWS_EXTERN int
3659 lws_callback_on_writable(struct lws *wsi);
3662 * lws_callback_on_writable_all_protocol() - Request a callback for all
3663 * connections on same vhost using the given protocol when it
3664 * becomes possible to write to each socket without
3667 * \param context: lws_context
3668 * \param protocol: Protocol whose connections will get callbacks
3670 * - Which: connections using this protocol on ANY VHOST
3671 * - When: when the individual connection becomes writeable
3672 * - What: LWS_CALLBACK_*_WRITEABLE
3674 LWS_VISIBLE LWS_EXTERN int
3675 lws_callback_on_writable_all_protocol(const struct lws_context *context,
3676 const struct lws_protocols *protocol);
3679 * lws_callback_on_writable_all_protocol_vhost() - Request a callback for
3680 * all connections using the given protocol when it
3681 * becomes possible to write to each socket without
3684 * \param vhost: Only consider connections on this lws_vhost
3685 * \param protocol: Protocol whose connections will get callbacks
3687 * - Which: connections using this protocol on GIVEN VHOST ONLY
3688 * - When: when the individual connection becomes writeable
3689 * - What: LWS_CALLBACK_*_WRITEABLE
3691 LWS_VISIBLE LWS_EXTERN int
3692 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
3693 const struct lws_protocols *protocol);
3696 * lws_callback_all_protocol() - Callback all connections using
3697 * the given protocol with the given reason
3699 * \param context: lws_context
3700 * \param protocol: Protocol whose connections will get callbacks
3701 * \param reason: Callback reason index
3703 * - Which: connections using this protocol on ALL VHOSTS
3704 * - When: before returning
3707 * This isn't normally what you want... normally any update of connection-
3708 * specific information can wait until a network-related callback like rx,
3709 * writable, or close.
3711 LWS_VISIBLE LWS_EXTERN int
3712 lws_callback_all_protocol(struct lws_context *context,
3713 const struct lws_protocols *protocol, int reason);
3716 * lws_callback_all_protocol_vhost() - Callback all connections using
3717 * the given protocol with the given reason
3719 * \param vh: Vhost whose connections will get callbacks
3720 * \param protocol: Which protocol to match
3721 * \param reason: Callback reason index
3723 * - Which: connections using this protocol on GIVEN VHOST ONLY
3727 LWS_VISIBLE LWS_EXTERN int
3728 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
3729 const struct lws_protocols *protocol, int reason);
3732 * lws_callback_vhost_protocols() - Callback all protocols enabled on a vhost
3733 * with the given reason
3735 * \param wsi: wsi whose vhost will get callbacks
3736 * \param reason: Callback reason index
3737 * \param in: in argument to callback
3738 * \param len: len argument to callback
3740 * - Which: connections using this protocol on same VHOST as wsi ONLY
3744 LWS_VISIBLE LWS_EXTERN int
3745 lws_callback_vhost_protocols(struct lws *wsi, int reason, void *in, int len);
3747 LWS_VISIBLE LWS_EXTERN int
3748 lws_callback_http_dummy(struct lws *wsi, enum lws_callback_reasons reason,
3749 void *user, void *in, size_t len);
3752 * lws_get_socket_fd() - returns the socket file descriptor
3754 * You will not need this unless you are doing something special
3756 * \param wsi: Websocket connection instance
3758 LWS_VISIBLE LWS_EXTERN int
3759 lws_get_socket_fd(struct lws *wsi);
3762 * lws_get_peer_write_allowance() - get the amount of data writeable to peer
3765 * \param wsi: Websocket connection instance
3767 * if the protocol does not have any guidance, returns -1. Currently only
3768 * http2 connections get send window information from this API. But your code
3769 * should use it so it can work properly with any protocol.
3771 * If nonzero return is the amount of payload data the peer or intermediary has
3772 * reported it has buffer space for. That has NO relationship with the amount
3773 * of buffer space your OS can accept on this connection for a write action.
3775 * This number represents the maximum you could send to the peer or intermediary
3776 * on this connection right now without the protocol complaining.
3778 * lws manages accounting for send window updates and payload writes
3779 * automatically, so this number reflects the situation at the peer or
3780 * intermediary dynamically.
3782 LWS_VISIBLE LWS_EXTERN size_t
3783 lws_get_peer_write_allowance(struct lws *wsi);
3787 * lws_rx_flow_control() - Enable and disable socket servicing for
3790 * If the output side of a server process becomes choked, this allows flow
3791 * control for the input side.
3793 * \param wsi: Websocket connection instance to get callback for
3794 * \param enable: 0 = disable read servicing for this connection, 1 = enable
3796 LWS_VISIBLE LWS_EXTERN int
3797 lws_rx_flow_control(struct lws *wsi, int enable);
3800 * lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
3802 * When the user server code realizes it can accept more input, it can
3803 * call this to have the RX flow restriction removed from all connections using
3804 * the given protocol.
3805 * \param context: lws_context
3806 * \param protocol: all connections using this protocol will be allowed to receive
3808 LWS_VISIBLE LWS_EXTERN void
3809 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
3810 const struct lws_protocols *protocol);
3813 * lws_remaining_packet_payload() - Bytes to come before "overall"
3814 * rx packet is complete
3815 * \param wsi: Websocket instance (available from user callback)
3817 * This function is intended to be called from the callback if the
3818 * user code is interested in "complete packets" from the client.
3819 * libwebsockets just passes through payload as it comes and issues a buffer
3820 * additionally when it hits a built-in limit. The LWS_CALLBACK_RECEIVE
3821 * callback handler can use this API to find out if the buffer it has just
3822 * been given is the last piece of a "complete packet" from the client --
3823 * when that is the case lws_remaining_packet_payload() will return
3826 * Many protocols won't care becuse their packets are always small.
3828 LWS_VISIBLE LWS_EXTERN size_t
3829 lws_remaining_packet_payload(struct lws *wsi);
3832 /** \defgroup sock-adopt Socket adoption helpers
3833 * ##Socket adoption helpers
3835 * When integrating with an external app with its own event loop, these can
3836 * be used to accept connections from someone else's listening socket.
3838 * When using lws own event loop, these are not needed.
3843 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
3844 * for the default vhost of context.
3845 * \param context: lws context
3846 * \param accept_fd: fd of already-accepted socket to adopt
3848 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3849 * returns NULL, having cleaned up any new wsi pieces.
3851 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3852 * to ws or just serve http.
3854 LWS_VISIBLE LWS_EXTERN struct lws *
3855 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
3857 * lws_adopt_socket_vhost() - adopt foreign socket as if listen socket accepted it
3859 * \param vhost: lws vhost
3860 * \param accept_fd: fd of already-accepted socket to adopt
3862 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3863 * returns NULL, having cleaned up any new wsi pieces.
3865 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3866 * to ws or just serve http.
3868 LWS_VISIBLE LWS_EXTERN struct lws *
3869 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
3872 LWS_ADOPT_RAW_FILE_DESC = 0, /* convenience constant */
3873 LWS_ADOPT_HTTP = 1, /* flag: absent implies RAW */
3874 LWS_ADOPT_SOCKET = 2, /* flag: absent implies file descr */
3875 LWS_ADOPT_ALLOW_SSL = 4 /* flag: if set requires LWS_ADOPT_SOCKET */
3876 } lws_adoption_type;
3879 lws_sockfd_type sockfd;
3880 lws_filefd_type filefd;
3881 } lws_sock_file_fd_type;
3884 * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor
3885 * if socket descriptor, should already have been accepted from listen socket
3887 * \param vhost: lws vhost
3888 * \param type: OR-ed combinations of lws_adoption_type flags
3889 * \param fd: union with either .sockfd or .filefd set
3890 * \param vh_prot_name: NULL or vh protocol name to bind raw connection to
3891 * \param parent: NULL or struct lws to attach new_wsi to as a child
3893 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3894 * returns NULL, having cleaned up any new wsi pieces.
3896 * If LWS_ADOPT_SOCKET is set, LWS adopts the socket in http serving mode, it's
3897 * ready to accept an upgrade to ws or just serve http.
3899 * parent may be NULL, if given it should be an existing wsi that will become the
3900 * parent of the new wsi created by this call.
3902 LWS_VISIBLE struct lws *
3903 lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type,
3904 lws_sock_file_fd_type fd, const char *vh_prot_name,
3905 struct lws *parent);
3908 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
3909 * for the default vhost of context.
3910 * \param context: lws context
3911 * \param accept_fd: fd of already-accepted socket to adopt
3912 * \param readbuf: NULL or pointer to data that must be drained before reading from
3914 * \param len: The length of the data held at \param readbuf
3916 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3917 * returns NULL, having cleaned up any new wsi pieces.
3919 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3920 * to ws or just serve http.
3922 * If your external code did not already read from the socket, you can use
3923 * lws_adopt_socket() instead.
3925 * This api is guaranteed to use the data at \param readbuf first, before reading from
3928 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
3930 LWS_VISIBLE LWS_EXTERN struct lws *
3931 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
3932 const char *readbuf, size_t len);
3934 * lws_adopt_socket_vhost_readbuf() - adopt foreign socket and first rx as if listen socket
3935 * accepted it for vhost.
3936 * \param vhost: lws vhost
3937 * \param accept_fd: fd of already-accepted socket to adopt
3938 * \param readbuf: NULL or pointer to data that must be drained before reading from
3940 * \param len: The length of the data held at \param readbuf
3942 * Either returns new wsi bound to accept_fd, or closes accept_fd and
3943 * returns NULL, having cleaned up any new wsi pieces.
3945 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
3946 * to ws or just serve http.
3948 * If your external code did not already read from the socket, you can use
3949 * lws_adopt_socket() instead.
3951 * This api is guaranteed to use the data at \param readbuf first, before reading from
3954 * readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
3956 LWS_VISIBLE LWS_EXTERN struct lws *
3957 lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, lws_sockfd_type accept_fd,
3958 const char *readbuf, size_t len);
3961 /** \defgroup net Network related helper APIs
3962 * ##Network related helper APIs
3964 * These wrap miscellaneous useful network-related functions
3969 * lws_canonical_hostname() - returns this host's hostname
3971 * This is typically used by client code to fill in the host parameter
3972 * when making a client connection. You can only call it after the context
3975 * \param context: Websocket context
3977 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
3978 lws_canonical_hostname(struct lws_context *context);
3981 * lws_get_peer_addresses() - Get client address information
3982 * \param wsi: Local struct lws associated with
3983 * \param fd: Connection socket descriptor
3984 * \param name: Buffer to take client address name
3985 * \param name_len: Length of client address name buffer
3986 * \param rip: Buffer to take client address IP dotted quad
3987 * \param rip_len: Length of client address IP buffer
3989 * This function fills in name and rip with the name and IP of
3990 * the client connected with socket descriptor fd. Names may be
3991 * truncated if there is not enough room. If either cannot be
3992 * determined, they will be returned as valid zero-length strings.
3994 LWS_VISIBLE LWS_EXTERN void
3995 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
3996 int name_len, char *rip, int rip_len);
3999 * lws_get_peer_simple() - Get client address information without RDNS
4001 * \param wsi: Local struct lws associated with
4002 * \param name: Buffer to take client address name
4003 * \param namelen: Length of client address name buffer
4005 * This provides a 123.123.123.123 type IP address in name from the
4006 * peer that has connected to wsi
4008 LWS_VISIBLE LWS_EXTERN const char *
4009 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
4010 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
4012 * lws_interface_to_sa() - Convert interface name or IP to sockaddr struct
4014 * \param ipv6: Allow IPV6 addresses
4015 * \param ifname: Interface name or IP
4016 * \param addr: struct sockaddr_in * to be written
4017 * \param addrlen: Length of addr
4019 * This converts a textual network interface name to a sockaddr usable by
4020 * other network functions
4022 LWS_VISIBLE LWS_EXTERN int
4023 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
4028 /** \defgroup misc Miscellaneous APIs
4029 * ##Miscellaneous APIs
4031 * Various APIs outside of other categories
4036 * lws_snprintf(): snprintf that truncates the returned length too
4038 * \param str: destination buffer
4039 * \param size: bytes left in destination buffer
4040 * \param format: format string
4041 * \param ...: args for format
4043 * This lets you correctly truncate buffers by concatenating lengths, if you
4044 * reach the limit the reported length doesn't exceed the limit.
4046 LWS_VISIBLE LWS_EXTERN int
4047 lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
4050 * lws_get_random(): fill a buffer with platform random data
4052 * \param context: the lws context
4053 * \param buf: buffer to fill
4054 * \param len: how much to fill
4056 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4057 * it's interested to see if the frame it's dealing with was sent in binary
4060 LWS_VISIBLE LWS_EXTERN int
4061 lws_get_random(struct lws_context *context, void *buf, int len);
4063 * lws_daemonize(): make current process run in the background
4065 * \param _lock_path: the filepath to write the lock file
4067 * Spawn lws as a background process, taking care of various things
4069 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4070 lws_daemonize(const char *_lock_path);
4072 * lws_get_library_version(): return string describing the version of lws
4074 * On unix, also includes the git describe
4076 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
4077 lws_get_library_version(void);
4080 * lws_wsi_user() - get the user data associated with the connection
4081 * \param wsi: lws connection
4083 * Not normally needed since it's passed into the callback
4085 LWS_VISIBLE LWS_EXTERN void *
4086 lws_wsi_user(struct lws *wsi);
4089 * lws_wsi_set_user() - set the user data associated with the client connection
4090 * \param wsi: lws connection
4091 * \param user: user data
4093 * By default lws allocates this and it's not legal to externally set it
4094 * yourself. However client connections may have it set externally when the
4095 * connection is created... if so, this api can be used to modify it at
4096 * runtime additionally.
4098 LWS_VISIBLE LWS_EXTERN void
4099 lws_set_wsi_user(struct lws *wsi, void *user);
4102 * lws_parse_uri: cut up prot:/ads:port/path into pieces
4103 * Notice it does so by dropping '\0' into input string
4104 * and the leading / on the path is consequently lost
4106 * \param p: incoming uri string.. will get written to
4107 * \param prot: result pointer for protocol part (https://)
4108 * \param ads: result pointer for address part
4109 * \param port: result pointer for port part
4110 * \param path: result pointer for path part
4112 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4113 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
4117 * lws_now_secs(): return seconds since 1970-1-1
4119 LWS_VISIBLE LWS_EXTERN unsigned long
4123 * lws_get_context - Allow geting lws_context from a Websocket connection
4126 * With this function, users can access context in the callback function.
4127 * Otherwise users may have to declare context as a global variable.
4129 * \param wsi: Websocket connection instance
4131 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
4132 lws_get_context(const struct lws *wsi);
4135 * lws_get_count_threads(): how many service threads the context uses
4137 * \param context: the lws context
4139 * By default this is always 1, if you asked for more than lws can handle it
4140 * will clip the number of threads. So you can use this to find out how many
4141 * threads are actually in use.
4143 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4144 lws_get_count_threads(struct lws_context *context);
4147 * lws_get_parent() - get parent wsi or NULL
4148 * \param wsi: lws connection
4150 * Specialized wsi like cgi stdin/out/err are associated to a parent wsi,
4151 * this allows you to get their parent.
4153 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4154 lws_get_parent(const struct lws *wsi);
4157 * lws_get_child() - get child wsi or NULL
4158 * \param wsi: lws connection
4160 * Allows you to find a related wsi from the parent wsi.
4162 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
4163 lws_get_child(const struct lws *wsi);
4167 * \deprecated DEPRECATED Note: this is not normally needed as a user api.
4168 * It's provided in case it is
4169 * useful when integrating with other app poll loop service code.
4171 LWS_VISIBLE LWS_EXTERN int
4172 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
4175 * lws_set_allocator() - custom allocator support
4179 * Allows you to replace the allocator (and deallocator) used by lws
4181 LWS_VISIBLE LWS_EXTERN void
4182 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));
4185 /** \defgroup wsstatus Websocket status APIs
4186 * ##Websocket connection status APIs
4188 * These provide information about ws connection or message status
4192 * lws_send_pipe_choked() - tests if socket is writable or not
4193 * \param wsi: lws connection
4195 * Allows you to check if you can write more on the socket
4197 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4198 lws_send_pipe_choked(struct lws *wsi);
4201 * lws_is_final_fragment() - tests if last part of ws message
4202 * \param wsi: lws connection
4204 LWS_VISIBLE LWS_EXTERN int
4205 lws_is_final_fragment(struct lws *wsi);
4208 * lws_get_reserved_bits() - access reserved bits of ws frame
4209 * \param wsi: lws connection
4211 LWS_VISIBLE LWS_EXTERN unsigned char
4212 lws_get_reserved_bits(struct lws *wsi);
4215 * lws_partial_buffered() - find out if lws buffered the last write
4216 * \param wsi: websocket connection to check
4218 * Returns 1 if you cannot use lws_write because the last
4219 * write on this connection is still buffered, and can't be cleared without
4220 * returning to the service loop and waiting for the connection to be
4223 * If you will try to do >1 lws_write call inside a single
4224 * WRITEABLE callback, you must check this after every write and bail if
4225 * set, ask for a new writeable callback and continue writing from there.
4227 * This is never set at the start of a writeable callback, but any write
4230 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4231 lws_partial_buffered(struct lws *wsi);
4234 * lws_frame_is_binary(): true if the current frame was sent in binary mode
4236 * \param wsi: the connection we are inquiring about
4238 * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
4239 * it's interested to see if the frame it's dealing with was sent in binary
4242 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
4243 lws_frame_is_binary(struct lws *wsi);
4246 * lws_is_ssl() - Find out if connection is using SSL
4247 * \param wsi: websocket connection to check
4249 * Returns 0 if the connection is not using SSL, 1 if using SSL and
4250 * using verified cert, and 2 if using SSL but the cert was not
4251 * checked (appears for client wsi told to skip check on connection)
4253 LWS_VISIBLE LWS_EXTERN int
4254 lws_is_ssl(struct lws *wsi);
4256 * lws_is_cgi() - find out if this wsi is running a cgi process
4257 * \param wsi: lws connection
4259 LWS_VISIBLE LWS_EXTERN int
4260 lws_is_cgi(struct lws *wsi);
4262 #ifdef LWS_OPENSSL_SUPPORT
4264 * lws_get_ssl() - Return wsi's SSL context structure
4265 * \param wsi: websocket connection
4267 * Returns pointer to the SSL library's context structure
4269 LWS_VISIBLE LWS_EXTERN SSL*
4270 lws_get_ssl(struct lws *wsi);
4275 /** \defgroup sha SHA and B64 helpers
4276 * ##SHA and B64 helpers
4278 * These provide SHA-1 and B64 helper apis
4281 #ifdef LWS_SHA1_USE_OPENSSL_NAME
4282 #define lws_SHA1 SHA1
4285 * lws_SHA1(): make a SHA-1 digest of a buffer
4287 * \param d: incoming buffer
4288 * \param n: length of incoming buffer
4289 * \param md: buffer for message digest (must be >= 20 bytes)
4291 * Reduces any size buffer into a 20-byte SHA-1 hash.
4293 LWS_VISIBLE LWS_EXTERN unsigned char *
4294 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
4297 * lws_b64_encode_string(): encode a string into base 64
4299 * \param in: incoming buffer
4300 * \param in_len: length of incoming buffer
4301 * \param out: result buffer
4302 * \param out_size: length of result buffer
4304 * Encodes a string using b64
4306 LWS_VISIBLE LWS_EXTERN int
4307 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
4309 * lws_b64_decode_string(): decode a string from base 64
4311 * \param in: incoming buffer
4312 * \param out: result buffer
4313 * \param out_size: length of result buffer
4315 * Decodes a string using b64
4317 LWS_VISIBLE LWS_EXTERN int
4318 lws_b64_decode_string(const char *in, char *out, int out_size);
4322 /*! \defgroup cgi cgi handling
4326 * These functions allow low-level control over stdin/out/err of the cgi.
4328 * However for most cases, binding the cgi to http in and out, the default
4329 * lws implementation already does the right thing.
4332 enum lws_enum_stdinouterr {
4338 enum lws_cgi_hdr_state {
4348 struct lws_cgi_args {
4349 struct lws **stdwsi; /**< get fd with lws_get_socket_fd() */
4350 enum lws_enum_stdinouterr ch; /**< channel index */
4351 unsigned char *data; /**< for messages with payload */
4352 enum lws_cgi_hdr_state hdr_state; /**< track where we are in cgi headers */
4353 int len; /**< length */
4358 * lws_cgi: spawn network-connected cgi process
4360 * \param wsi: connection to own the process
4361 * \param exec_array: array of "exec-name" "arg1" ... "argn" NULL
4362 * \param script_uri_path_len: how many chars on the left of the uri are the path to the cgi
4363 * \param timeout_secs: seconds script should be allowed to run
4364 * \param mp_cgienv: pvo list with per-vhost cgi options to put in env
4366 LWS_VISIBLE LWS_EXTERN int
4367 lws_cgi(struct lws *wsi, const char * const *exec_array,
4368 int script_uri_path_len, int timeout_secs,
4369 const struct lws_protocol_vhost_options *mp_cgienv);
4372 * lws_cgi_write_split_stdout_headers: write cgi output accounting for header part
4374 * \param wsi: connection to own the process
4376 LWS_VISIBLE LWS_EXTERN int
4377 lws_cgi_write_split_stdout_headers(struct lws *wsi);
4380 * lws_cgi_kill: terminate cgi process associated with wsi
4382 * \param wsi: connection to own the process
4384 LWS_VISIBLE LWS_EXTERN int
4385 lws_cgi_kill(struct lws *wsi);
4390 /*! \defgroup fops file operation wrapping
4392 * ##File operation wrapping
4394 * Use these helper functions if you want to access a file from the perspective
4395 * of a specific wsi, which is usually the case. If you just want contextless
4396 * file access, use the fops callbacks directly with NULL wsi instead of these
4399 * If so, then it calls the platform handler or user overrides where present
4400 * (as defined in info->fops)
4402 * The advantage from all this is user code can be portable for file operations
4403 * without having to deal with differences between platforms.
4407 /** struct lws_plat_file_ops - Platform-specific file operations
4409 * These provide platform-agnostic ways to deal with filesystem access in the
4410 * library and in the user code.
4413 #if defined(LWS_WITH_ESP32)
4414 /* sdk preprocessor defs? compiler issue? gets confused with member names */
4415 #define LWS_FOP_OPEN _open
4416 #define LWS_FOP_CLOSE _close
4417 #define LWS_FOP_SEEK_CUR _seek_cur
4418 #define LWS_FOP_READ _read
4419 #define LWS_FOP_WRITE _write
4421 #define LWS_FOP_OPEN open
4422 #define LWS_FOP_CLOSE close
4423 #define LWS_FOP_SEEK_CUR seek_cur
4424 #define LWS_FOP_READ read
4425 #define LWS_FOP_WRITE write
4428 #define LWS_FOP_FLAGS_MASK ((1 << 23) - 1)
4429 #define LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP (1 << 24)
4430 #define LWS_FOP_FLAG_COMPR_IS_GZIP (1 << 25)
4431 #define LWS_FOP_FLAG_MOD_TIME_VALID (1 << 26)
4432 #define LWS_FOP_FLAG_VIRTUAL (1 << 27)
4434 struct lws_plat_file_ops;
4436 #if (defined(WIN32) || defined(_WIN32)) && !defined(__MINGW32__)
4438 #if !defined(ssize_t)
4439 typedef SSIZE_T ssize_t;
4443 #if defined(LWS_HAVE_STDINT_H)
4446 #if defined(WIN32) || defined(_WIN32)
4448 typedef unsigned __int32 uint32_t;
4449 typedef unsigned __int16 uint16_t;
4450 typedef unsigned __int8 uint8_t;
4452 typedef unsigned int uint32_t;
4453 typedef unsigned short uint16_t;
4454 typedef unsigned char uint8_t;
4458 typedef size_t lws_filepos_t;
4459 typedef ssize_t lws_fileofs_t;
4460 typedef uint32_t lws_fop_flags_t;
4464 /**< real file descriptor related to the file... */
4465 const struct lws_plat_file_ops *fops;
4466 /**< fops that apply to this fop_fd */
4467 void *filesystem_priv;
4468 /**< ignored by lws; owned by the fops handlers */
4470 /**< generic "position in file" */
4472 /**< generic "length of file" */
4473 lws_fop_flags_t flags;
4474 /**< copy of the returned flags */
4476 /**< optional "modification time of file", only valid if .open()
4477 * set the LWS_FOP_FLAG_MOD_TIME_VALID flag */
4479 typedef struct lws_fop_fd *lws_fop_fd_t;
4481 struct lws_fops_index {
4482 const char *sig; /* NULL or vfs signature, eg, ".zip/" */
4483 uint8_t len; /* length of above string */
4486 struct lws_plat_file_ops {
4487 lws_fop_fd_t (*LWS_FOP_OPEN)(const struct lws_plat_file_ops *fops,
4488 const char *filename, const char *vpath,
4489 lws_fop_flags_t *flags);
4490 /**< Open file (always binary access if plat supports it)
4491 * vpath may be NULL, or if the fops understands it, the point at which
4492 * the filename's virtual part starts.
4493 * *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR.
4494 * If the file may be gzip-compressed,
4495 * LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is
4496 * gzip-compressed, then the open handler should OR
4497 * LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning.
4499 int (*LWS_FOP_CLOSE)(lws_fop_fd_t *fop_fd);
4500 /**< close file AND set the pointer to NULL */
4501 lws_fileofs_t (*LWS_FOP_SEEK_CUR)(lws_fop_fd_t fop_fd,
4502 lws_fileofs_t offset_from_cur_pos);
4503 /**< seek from current position */
4504 int (*LWS_FOP_READ)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4505 uint8_t *buf, lws_filepos_t len);
4506 /**< Read from file, on exit *amount is set to amount actually read */
4507 int (*LWS_FOP_WRITE)(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4508 uint8_t *buf, lws_filepos_t len);
4509 /**< Write to file, on exit *amount is set to amount actually written */
4511 struct lws_fops_index fi[3];
4512 /**< vfs path signatures implying use of this fops */
4514 const struct lws_plat_file_ops *next;
4515 /**< NULL or next fops in list */
4517 /* Add new things just above here ---^
4518 * This is part of the ABI, don't needlessly break compatibility */
4522 * lws_get_fops() - get current file ops
4524 * \param context: context
4526 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
4527 lws_get_fops(struct lws_context *context);
4528 LWS_VISIBLE LWS_EXTERN void
4529 lws_set_fops(struct lws_context *context, const struct lws_plat_file_ops *fops);
4531 * lws_vfs_tell() - get current file position
4533 * \param fop_fd: fop_fd we are asking about
4535 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4536 lws_vfs_tell(lws_fop_fd_t fop_fd);
4538 * lws_vfs_get_length() - get current file total length in bytes
4540 * \param fop_fd: fop_fd we are asking about
4542 LWS_VISIBLE LWS_EXTERN lws_filepos_t LWS_WARN_UNUSED_RESULT
4543 lws_vfs_get_length(lws_fop_fd_t fop_fd);
4545 * lws_vfs_get_mod_time() - get time file last modified
4547 * \param fop_fd: fop_fd we are asking about
4549 LWS_VISIBLE LWS_EXTERN uint32_t LWS_WARN_UNUSED_RESULT
4550 lws_vfs_get_mod_time(lws_fop_fd_t fop_fd);
4552 * lws_vfs_file_seek_set() - seek relative to start of file
4554 * \param fop_fd: fop_fd we are seeking in
4555 * \param offset: offset from start of file
4557 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4558 lws_vfs_file_seek_set(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4560 * lws_vfs_file_seek_end() - seek relative to end of file
4562 * \param fop_fd: fop_fd we are seeking in
4563 * \param offset: offset from start of file
4565 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4566 lws_vfs_file_seek_end(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4568 extern struct lws_plat_file_ops fops_zip;
4571 * lws_plat_file_open() - open vfs filepath
4573 * \param fops: file ops struct that applies to this descriptor
4574 * \param vfs_path: filename to open
4575 * \param flags: pointer to open flags
4577 * The vfs_path is scanned for known fops signatures, and the open directed
4578 * to any matching fops open.
4580 * User code should use this api to perform vfs opens.
4582 * returns semi-opaque handle
4584 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t LWS_WARN_UNUSED_RESULT
4585 lws_vfs_file_open(const struct lws_plat_file_ops *fops, const char *vfs_path,
4586 lws_fop_flags_t *flags);
4589 * lws_plat_file_close() - close file
4591 * \param fop_fd: file handle to close
4593 static LWS_INLINE int
4594 lws_vfs_file_close(lws_fop_fd_t *fop_fd)
4596 return (*fop_fd)->fops->LWS_FOP_CLOSE(fop_fd);
4600 * lws_plat_file_seek_cur() - close file
4603 * \param fop_fd: file handle
4604 * \param offset: position to seek to
4606 static LWS_INLINE lws_fileofs_t
4607 lws_vfs_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset)
4609 return fop_fd->fops->LWS_FOP_SEEK_CUR(fop_fd, offset);
4612 * lws_plat_file_read() - read from file
4614 * \param fop_fd: file handle
4615 * \param amount: how much to read (rewritten by call)
4616 * \param buf: buffer to write to
4617 * \param len: max length
4619 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4620 lws_vfs_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4621 uint8_t *buf, lws_filepos_t len)
4623 return fop_fd->fops->LWS_FOP_READ(fop_fd, amount, buf, len);
4626 * lws_plat_file_write() - write from file
4628 * \param fop_fd: file handle
4629 * \param amount: how much to write (rewritten by call)
4630 * \param buf: buffer to read from
4631 * \param len: max length
4633 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
4634 lws_vfs_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4635 uint8_t *buf, lws_filepos_t len)
4637 return fop_fd->fops->LWS_FOP_WRITE(fop_fd, amount, buf, len);
4640 /* these are the platform file operations implementations... they can
4641 * be called directly and used in fops arrays
4644 LWS_VISIBLE LWS_EXTERN lws_fop_fd_t
4645 _lws_plat_file_open(const struct lws_plat_file_ops *fops, const char *filename,
4646 const char *vpath, lws_fop_flags_t *flags);
4647 LWS_VISIBLE LWS_EXTERN int
4648 _lws_plat_file_close(lws_fop_fd_t *fop_fd);
4649 LWS_VISIBLE LWS_EXTERN lws_fileofs_t
4650 _lws_plat_file_seek_cur(lws_fop_fd_t fop_fd, lws_fileofs_t offset);
4651 LWS_VISIBLE LWS_EXTERN int
4652 _lws_plat_file_read(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4653 uint8_t *buf, lws_filepos_t len);
4654 LWS_VISIBLE LWS_EXTERN int
4655 _lws_plat_file_write(lws_fop_fd_t fop_fd, lws_filepos_t *amount,
4656 uint8_t *buf, lws_filepos_t len);
4658 LWS_VISIBLE LWS_EXTERN int
4659 lws_alloc_vfs_file(struct lws_context *context, const char *filename, uint8_t **buf,
4660 lws_filepos_t *amount);
4665 * ##SMTP related functions
4667 * These apis let you communicate with a local SMTP server to send email from
4668 * lws. It handles all the SMTP sequencing and protocol actions.
4670 * Your system should have postfix, sendmail or another MTA listening on port
4671 * 25 and able to send email using the "mail" commandline app. Usually distro
4672 * MTAs are configured for this by default.
4674 * It runs via its own libuv events if initialized (which requires giving it
4675 * a libuv loop to attach to).
4677 * It operates using three callbacks, on_next() queries if there is a new email
4678 * to send, on_get_body() asks for the body of the email, and on_sent() is
4679 * called after the email is successfully sent.
4683 * - create an lws_email struct
4685 * - initialize data, loop, the email_* strings, max_content_size and
4688 * - call lws_email_init()
4690 * When you have at least one email to send, call lws_email_check() to
4691 * schedule starting to send it.
4694 #ifdef LWS_WITH_SMTP
4696 /** enum lwsgs_smtp_states - where we are in SMTP protocol sequence */
4697 enum lwsgs_smtp_states {
4698 LGSSMTP_IDLE, /**< awaiting new email */
4699 LGSSMTP_CONNECTING, /**< opening tcp connection to MTA */
4700 LGSSMTP_CONNECTED, /**< tcp connection to MTA is connected */
4701 LGSSMTP_SENT_HELO, /**< sent the HELO */
4702 LGSSMTP_SENT_FROM, /**< sent FROM */
4703 LGSSMTP_SENT_TO, /**< sent TO */
4704 LGSSMTP_SENT_DATA, /**< sent DATA request */
4705 LGSSMTP_SENT_BODY, /**< sent the email body */
4706 LGSSMTP_SENT_QUIT, /**< sent the session quit */
4709 /** struct lws_email - abstract context for performing SMTP operations */
4712 /**< opaque pointer set by user code and available to the callbacks */
4714 /**< the libuv loop we will work on */
4716 char email_smtp_ip[32]; /**< Fill before init, eg, "127.0.0.1" */
4717 char email_helo[32]; /**< Fill before init, eg, "myserver.com" */
4718 char email_from[100]; /**< Fill before init or on_next */
4719 char email_to[100]; /**< Fill before init or on_next */
4721 unsigned int max_content_size;
4722 /**< largest possible email body size */
4724 /* Fill all the callbacks before init */
4726 int (*on_next)(struct lws_email *email);
4727 /**< (Fill in before calling lws_email_init)
4728 * called when idle, 0 = another email to send, nonzero is idle.
4729 * If you return 0, all of the email_* char arrays must be set
4730 * to something useful. */
4731 int (*on_sent)(struct lws_email *email);
4732 /**< (Fill in before calling lws_email_init)
4733 * called when transfer of the email to the SMTP server was
4734 * successful, your callback would remove the current email
4736 int (*on_get_body)(struct lws_email *email, char *buf, int len);
4737 /**< (Fill in before calling lws_email_init)
4738 * called when the body part of the queued email is about to be
4739 * sent to the SMTP server. */
4742 /* private things */
4743 uv_timer_t timeout_email; /**< private */
4744 enum lwsgs_smtp_states estate; /**< private */
4745 uv_connect_t email_connect_req; /**< private */
4746 uv_tcp_t email_client; /**< private */
4747 time_t email_connect_started; /**< private */
4748 char email_buf[256]; /**< private */
4749 char *content; /**< private */
4753 * lws_email_init() - Initialize a struct lws_email
4755 * \param email: struct lws_email to init
4756 * \param loop: libuv loop to use
4757 * \param max_content: max email content size
4759 * Prepares a struct lws_email for use ending SMTP
4761 LWS_VISIBLE LWS_EXTERN int
4762 lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
4765 * lws_email_check() - Request check for new email
4767 * \param email: struct lws_email context to check
4769 * Schedules a check for new emails in 1s... call this when you have queued an
4772 LWS_VISIBLE LWS_EXTERN void
4773 lws_email_check(struct lws_email *email);
4775 * lws_email_destroy() - stop using the struct lws_email
4777 * \param email: the struct lws_email context
4779 * Stop sending email using email and free allocations
4781 LWS_VISIBLE LWS_EXTERN void
4782 lws_email_destroy(struct lws_email *email);
4788 * Stats are all uint64_t numbers that start at 0.
4789 * Index names here have the convention
4793 * _MS_ millisecond count
4797 LWSSTATS_C_CONNECTIONS, /**< count incoming connections */
4798 LWSSTATS_C_API_CLOSE, /**< count calls to close api */
4799 LWSSTATS_C_API_READ, /**< count calls to read from socket api */
4800 LWSSTATS_C_API_LWS_WRITE, /**< count calls to lws_write API */
4801 LWSSTATS_C_API_WRITE, /**< count calls to write API */
4802 LWSSTATS_C_WRITE_PARTIALS, /**< count of partial writes */
4803 LWSSTATS_C_WRITEABLE_CB_REQ, /**< count of writable callback requests */
4804 LWSSTATS_C_WRITEABLE_CB_EFF_REQ, /**< count of effective writable callback requests */
4805 LWSSTATS_C_WRITEABLE_CB, /**< count of writable callbacks */
4806 LWSSTATS_C_SSL_CONNECTIONS_FAILED, /**< count of failed SSL connections */
4807 LWSSTATS_C_SSL_CONNECTIONS_ACCEPTED, /**< count of accepted SSL connections */
4808 LWSSTATS_C_TIMEOUTS, /**< count of timed-out connections */
4809 LWSSTATS_C_SERVICE_ENTRY, /**< count of entries to lws service loop */
4810 LWSSTATS_B_READ, /**< aggregate bytes read */
4811 LWSSTATS_B_WRITE, /**< aggregate bytes written */
4812 LWSSTATS_B_PARTIALS_ACCEPTED_PARTS, /**< aggreate of size of accepted write data from new partials */
4813 LWSSTATS_MS_SSL_CONNECTIONS_ACCEPTED_DELAY, /**< aggregate delay in accepting connection */
4814 LWSSTATS_MS_WRITABLE_DELAY, /**< aggregate delay between asking for writable and getting cb */
4815 LWSSTATS_MS_WORST_WRITABLE_DELAY, /**< single worst delay between asking for writable and getting cb */
4817 /* Add new things just above here ---^
4818 * This is part of the ABI, don't needlessly break compatibility */
4822 #if defined(LWS_WITH_STATS)
4824 LWS_VISIBLE LWS_EXTERN uint64_t
4825 lws_stats_get(struct lws_context *context, int index);
4826 LWS_VISIBLE LWS_EXTERN void
4827 lws_stats_log_dump(struct lws_context *context);
4829 static inline uint64_t
4830 lws_stats_get(struct lws_context *context, int index) { return 0; }
4832 lws_stats_log_dump(struct lws_context *context) { }