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,
22 #ifndef LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
23 #define LIBWEBSOCKET_H_3060898B846849FF9F88F5DB59B5950C
29 #include "mbed-drivers/mbed.h"
30 #include "sal-iface-eth/EthernetInterface.h"
31 #include "sockets/TCPListener.h"
32 #include "sal-stack-lwip/lwipv4_init.h"
36 using namespace mbed::Sockets::v0;
48 awaiting_on_writeable(0)
53 void set_wsi(struct lws *_wsi) { wsi = _wsi; }
54 int actual_onRX(Socket *s);
56 void onError(Socket *s, socket_error_t err);
57 void onDisconnect(TCPStream *s);
58 void onSent(Socket *s, uint16_t len);
59 void serialized_writeable(struct lws *wsi);
67 char awaiting_on_writeable;
70 class lws_conn_listener : lws_conn {
73 srv(SOCKET_STACK_LWIP_IPV4)
75 srv.setOnError(TCPStream::ErrorHandler_t(this,
76 &lws_conn_listener::onError));
79 void start(const uint16_t port);
83 void onError(Socket *s, socket_error_t err);
84 void onIncoming(TCPListener *s, void *impl);
85 void onDisconnect(TCPStream *s);
105 #include "lws_config.h"
107 #if defined(WIN32) || defined(_WIN32)
108 #ifndef WIN32_LEAN_AND_MEAN
109 #define WIN32_LEAN_AND_MEAN
112 #include <winsock2.h>
113 #include <ws2tcpip.h>
120 #define _O_RDONLY 0x0000
121 #define O_RDONLY _O_RDONLY
125 #define strcasecmp _stricmp
127 #define strcasecmp stricmp
129 #define getdtablesize() 30000
131 #define LWS_INLINE __inline
133 #define LWS_WARN_UNUSED_RESULT
134 #define LWS_WARN_DEPRECATED
138 #define LWS_EXTERN extern __declspec(dllexport)
140 #define LWS_EXTERN extern __declspec(dllimport)
146 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
147 #define LWS_O_RDONLY _O_RDONLY
149 #if !defined(_MSC_VER) || _MSC_VER < 1900 /* Visual Studio 2015 already defines this in <stdio.h> */
150 #define snprintf _snprintf
153 #else /* NOT WIN32 */
156 #if defined(__NetBSD__) || defined(__FreeBSD__)
157 #include <netinet/in.h>
160 #define LWS_INLINE inline
161 #define LWS_O_RDONLY O_RDONLY
163 #ifndef MBED_OPERATORS
166 #define LWS_INVALID_FILE -1
168 #define getdtablesize() (20)
169 #define LWS_INVALID_FILE NULL
172 #if defined(__GNUC__)
173 #define LWS_VISIBLE __attribute__((visibility("default")))
174 #define LWS_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
175 #define LWS_WARN_DEPRECATED __attribute__ ((deprecated))
178 #define LWS_WARN_UNUSED_RESULT
179 #define LWS_WARN_DEPRECATED
182 #if defined(__ANDROID__)
184 #define getdtablesize() sysconf(_SC_OPEN_MAX)
191 #endif /* LWS_USE_LIBEV */
194 #endif /* LWS_USE_LIBUV */
197 #define LWS_EXTERN extern
203 #include <sys/time.h>
207 #ifdef LWS_OPENSSL_SUPPORT
210 #ifdef USE_OLD_CYASSL
211 #include <cyassl/openssl/ssl.h>
212 #include <cyassl/error-ssl.h>
214 #include <wolfssl/openssl/ssl.h>
215 #include <wolfssl/error-ssl.h>
216 #endif /* not USE_OLD_CYASSL */
218 #if defined(LWS_USE_POLARSSL)
219 #include <polarssl/ssl.h>
220 struct lws_polarssl_context {
222 x509_crt certificate;
225 typedef struct lws_polarssl_context SSL_CTX;
226 typedef ssl_context SSL;
228 #if defined(LWS_USE_MBEDTLS)
229 #include <mbedtls/ssl.h>
231 #include <openssl/ssl.h>
232 #include <openssl/err.h>
233 #endif /* not USE_MBEDTLS */
234 #endif /* not USE_POLARSSL */
235 #endif /* not USE_WOLFSSL */
239 #define CONTEXT_PORT_NO_LISTEN -1
241 enum lws_log_levels {
251 LLL_LATENCY = 1 << 9,
253 LLL_COUNT = 10 /* set to count of valid flags */
256 LWS_VISIBLE LWS_EXTERN void _lws_log(int filter, const char *format, ...);
257 LWS_VISIBLE LWS_EXTERN void _lws_logv(int filter, const char *format, va_list vl);
258 LWS_VISIBLE LWS_EXTERN int
259 lwsl_timestamp(int level, char *p, int len);
261 /* notice, warn and log are always compiled in */
262 #define lwsl_notice(...) _lws_log(LLL_NOTICE, __VA_ARGS__)
263 #define lwsl_warn(...) _lws_log(LLL_WARN, __VA_ARGS__)
264 #define lwsl_err(...) _lws_log(LLL_ERR, __VA_ARGS__)
266 * weaker logging can be deselected at configure time using --disable-debug
267 * that gets rid of the overhead of checking while keeping _warn and _err
272 #define lwsl_info(...) _lws_log(LLL_INFO, __VA_ARGS__)
273 #define lwsl_debug(...) _lws_log(LLL_DEBUG, __VA_ARGS__)
274 #define lwsl_parser(...) _lws_log(LLL_PARSER, __VA_ARGS__)
275 #define lwsl_header(...) _lws_log(LLL_HEADER, __VA_ARGS__)
276 #define lwsl_ext(...) _lws_log(LLL_EXT, __VA_ARGS__)
277 #define lwsl_client(...) _lws_log(LLL_CLIENT, __VA_ARGS__)
278 #define lwsl_latency(...) _lws_log(LLL_LATENCY, __VA_ARGS__)
279 LWS_VISIBLE LWS_EXTERN void lwsl_hexdump(void *buf, size_t len);
283 #define lwsl_info(...) {}
284 #define lwsl_debug(...) {}
285 #define lwsl_parser(...) {}
286 #define lwsl_header(...) {}
287 #define lwsl_ext(...) {}
288 #define lwsl_client(...) {}
289 #define lwsl_latency(...) {}
290 #define lwsl_hexdump(a, b)
296 #ifndef lws_container_of
297 #define lws_container_of(P,T,M) ((T *)((char *)(P) - offsetof(T, M)))
302 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
304 /* api change list for user code to test against */
306 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_ARG
308 /* the struct lws_protocols has the id field present */
309 #define LWS_FEATURE_PROTOCOLS_HAS_ID_FIELD
311 /* you can call lws_get_peer_write_allowance */
312 #define LWS_FEATURE_PROTOCOLS_HAS_PEER_WRITE_ALLOWANCE
314 /* extra parameter introduced in 917f43ab821 */
315 #define LWS_FEATURE_SERVE_HTTP_FILE_HAS_OTHER_HEADERS_LEN
317 /* File operations stuff exists */
318 #define LWS_FEATURE_FOPS
321 * NOTE: These public enums are part of the abi. If you want to add one,
322 * add it at where specified so existing users are unaffected.
324 enum lws_context_options {
325 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT = (1 << 1) |
327 LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME = (1 << 2),
328 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT = (1 << 3) |
330 LWS_SERVER_OPTION_LIBEV = (1 << 4),
331 LWS_SERVER_OPTION_DISABLE_IPV6 = (1 << 5),
332 LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS = (1 << 6),
333 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED = (1 << 7),
334 LWS_SERVER_OPTION_VALIDATE_UTF8 = (1 << 8),
335 LWS_SERVER_OPTION_SSL_ECDH = (1 << 9) |
337 LWS_SERVER_OPTION_LIBUV = (1 << 10),
338 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS = (1 << 11) |
341 LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT = (1 << 12),
342 LWS_SERVER_OPTION_EXPLICIT_VHOSTS = (1 << 13),
343 LWS_SERVER_OPTION_UNIX_SOCK = (1 << 14),
344 LWS_SERVER_OPTION_STS = (1 << 15),
346 /****** add new things just above ---^ ******/
349 #define lws_check_opt(c, f) (((c) & (f)) == (f))
352 * NOTE: These public enums are part of the abi. If you want to add one,
353 * add it at where specified so existing users are unaffected.
355 enum lws_callback_reasons {
356 LWS_CALLBACK_ESTABLISHED = 0,
357 LWS_CALLBACK_CLIENT_CONNECTION_ERROR = 1,
358 LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH = 2,
359 LWS_CALLBACK_CLIENT_ESTABLISHED = 3,
360 LWS_CALLBACK_CLOSED = 4,
361 LWS_CALLBACK_CLOSED_HTTP = 5,
362 LWS_CALLBACK_RECEIVE = 6,
363 LWS_CALLBACK_RECEIVE_PONG = 7,
364 LWS_CALLBACK_CLIENT_RECEIVE = 8,
365 LWS_CALLBACK_CLIENT_RECEIVE_PONG = 9,
366 LWS_CALLBACK_CLIENT_WRITEABLE = 10,
367 LWS_CALLBACK_SERVER_WRITEABLE = 11,
368 LWS_CALLBACK_HTTP = 12,
369 LWS_CALLBACK_HTTP_BODY = 13,
370 LWS_CALLBACK_HTTP_BODY_COMPLETION = 14,
371 LWS_CALLBACK_HTTP_FILE_COMPLETION = 15,
372 LWS_CALLBACK_HTTP_WRITEABLE = 16,
373 LWS_CALLBACK_FILTER_NETWORK_CONNECTION = 17,
374 LWS_CALLBACK_FILTER_HTTP_CONNECTION = 18,
375 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED = 19,
376 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION = 20,
377 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS = 21,
378 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS = 22,
379 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION = 23,
380 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER = 24,
381 LWS_CALLBACK_CONFIRM_EXTENSION_OKAY = 25,
382 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED = 26,
383 LWS_CALLBACK_PROTOCOL_INIT = 27,
384 LWS_CALLBACK_PROTOCOL_DESTROY = 28,
385 LWS_CALLBACK_WSI_CREATE /* always protocol[0] */ = 29,
386 LWS_CALLBACK_WSI_DESTROY /* always protocol[0] */ = 30,
387 LWS_CALLBACK_GET_THREAD_ID = 31,
389 /* external poll() management support */
390 LWS_CALLBACK_ADD_POLL_FD = 32,
391 LWS_CALLBACK_DEL_POLL_FD = 33,
392 LWS_CALLBACK_CHANGE_MODE_POLL_FD = 34,
393 LWS_CALLBACK_LOCK_POLL = 35,
394 LWS_CALLBACK_UNLOCK_POLL = 36,
396 LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY = 37,
397 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE = 38,
399 LWS_CALLBACK_WS_EXT_DEFAULTS = 39,
401 LWS_CALLBACK_CGI = 40,
402 LWS_CALLBACK_CGI_TERMINATED = 41,
403 LWS_CALLBACK_CGI_STDIN_DATA = 42,
404 LWS_CALLBACK_CGI_STDIN_COMPLETED = 43,
405 LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP = 44,
406 LWS_CALLBACK_CLOSED_CLIENT_HTTP = 45,
407 LWS_CALLBACK_RECEIVE_CLIENT_HTTP = 46,
408 LWS_CALLBACK_COMPLETED_CLIENT_HTTP = 47,
409 LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ = 48,
411 /****** add new things just above ---^ ******/
413 LWS_CALLBACK_USER = 1000, /* user code can use any including / above */
418 typedef SOCKET lws_sockfd_type;
419 typedef HANDLE lws_filefd_type;
420 #define lws_sockfd_valid(sfd) (!!sfd)
428 #if defined(MBED_OPERATORS)
429 /* it's a class lws_conn * */
430 typedef void * lws_sockfd_type;
431 typedef void * lws_filefd_type;
432 #define lws_sockfd_valid(sfd) (!!sfd)
438 #define POLLIN 0x0001
439 #define POLLPRI 0x0002
440 #define POLLOUT 0x0004
441 #define POLLERR 0x0008
442 #define POLLHUP 0x0010
443 #define POLLNVAL 0x0020
447 void * mbed3_create_tcp_stream_socket(void);
448 void mbed3_delete_tcp_stream_socket(void *sockfd);
449 void mbed3_tcp_stream_bind(void *sock, int port, struct lws *);
450 void mbed3_tcp_stream_accept(void *sock, struct lws *);
452 typedef int lws_sockfd_type;
453 typedef int lws_filefd_type;
454 #define lws_sockfd_valid(sfd) (sfd >= 0)
457 #define lws_pollfd pollfd
460 /* argument structure for all external poll related calls
463 struct lws_pollargs {
464 lws_sockfd_type fd; /* applicable socket descriptor */
465 int events; /* the new event mask */
466 int prev_events; /* the previous event mask */
470 * struct lws_plat_file_ops - Platform-specific file operations
472 * These provide platform-agnostic ways to deal with filesystem access in the
473 * library and in the user code.
475 * @open: Open file (always binary access if plat supports it)
476 * filelen is filled on exit to be the length of the file
477 * flags should be set to O_RDONLY or O_RDWR
479 * @seek_cur: Seek from current position
480 * @read: Read fron file *amount is set on exit to amount read
481 * @write: Write to file *amount is set on exit as amount written
483 struct lws_plat_file_ops {
484 lws_filefd_type (*open)(struct lws *wsi, const char *filename,
485 unsigned long *filelen, int flags);
486 int (*close)(struct lws *wsi, lws_filefd_type fd);
487 unsigned long (*seek_cur)(struct lws *wsi, lws_filefd_type fd,
488 long offset_from_cur_pos);
489 int (*read)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
490 unsigned char *buf, unsigned long len);
491 int (*write)(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
492 unsigned char *buf, unsigned long len);
494 /* Add new things just above here ---^
495 * This is part of the ABI, don't needlessly break compatibility */
499 * NOTE: These public enums are part of the abi. If you want to add one,
500 * add it at where specified so existing users are unaffected.
502 enum lws_extension_callback_reasons {
503 LWS_EXT_CB_SERVER_CONTEXT_CONSTRUCT = 0,
504 LWS_EXT_CB_CLIENT_CONTEXT_CONSTRUCT = 1,
505 LWS_EXT_CB_SERVER_CONTEXT_DESTRUCT = 2,
506 LWS_EXT_CB_CLIENT_CONTEXT_DESTRUCT = 3,
507 LWS_EXT_CB_CONSTRUCT = 4,
508 LWS_EXT_CB_CLIENT_CONSTRUCT = 5,
509 LWS_EXT_CB_CHECK_OK_TO_REALLY_CLOSE = 6,
510 LWS_EXT_CB_CHECK_OK_TO_PROPOSE_EXTENSION = 7,
511 LWS_EXT_CB_DESTROY = 8,
512 LWS_EXT_CB_DESTROY_ANY_WSI_CLOSING = 9,
513 LWS_EXT_CB_ANY_WSI_ESTABLISHED = 10,
514 LWS_EXT_CB_PACKET_RX_PREPARSE = 11,
515 LWS_EXT_CB_PACKET_TX_PRESEND = 12,
516 LWS_EXT_CB_PACKET_TX_DO_SEND = 13,
517 LWS_EXT_CB_HANDSHAKE_REPLY_TX = 14,
518 LWS_EXT_CB_FLUSH_PENDING_TX = 15,
519 LWS_EXT_CB_EXTENDED_PAYLOAD_RX = 16,
520 LWS_EXT_CB_CAN_PROXY_CLIENT_CONNECTION = 17,
522 LWS_EXT_CB_REQUEST_ON_WRITEABLE = 19,
523 LWS_EXT_CB_IS_WRITEABLE = 20,
524 LWS_EXT_CB_PAYLOAD_TX = 21,
525 LWS_EXT_CB_PAYLOAD_RX = 22,
526 LWS_EXT_CB_OPTION_DEFAULT = 23,
527 LWS_EXT_CB_OPTION_SET = 24,
528 LWS_EXT_CB_OPTION_CONFIRM = 25,
529 LWS_EXT_CB_NAMED_OPTION_SET = 26,
531 /****** add new things just above ---^ ******/
535 * NOTE: These public enums are part of the abi. If you want to add one,
536 * add it at where specified so existing users are unaffected.
538 enum lws_write_protocol {
540 LWS_WRITE_BINARY = 1,
541 LWS_WRITE_CONTINUATION = 2,
544 /* special 04+ opcodes */
546 /* LWS_WRITE_CLOSE is handled by lws_close_reason() */
550 /* Same as write_http but we know this write ends the transaction */
551 LWS_WRITE_HTTP_FINAL = 7,
555 LWS_WRITE_HTTP_HEADERS = 8,
557 /****** add new things just above ---^ ******/
561 LWS_WRITE_NO_FIN = 0x40,
563 * client packet payload goes out on wire unmunged
564 * only useful for security tests since normal servers cannot
565 * decode the content if used
567 LWS_WRITE_CLIENT_IGNORE_XOR_MASK = 0x80
571 * you need these to look at headers that have been parsed if using the
572 * LWS_CALLBACK_FILTER_CONNECTION callback. If a header from the enum
573 * list below is absent, .token = NULL and token_len = 0. Otherwise .token
574 * points to .token_len chars containing that header content.
583 * these have to be kept in sync with lextable.h / minilex.c
585 * NOTE: These public enums are part of the abi. If you want to add one,
586 * add it at where specified so existing users are unaffected.
588 enum lws_token_indexes {
589 WSI_TOKEN_GET_URI = 0,
590 WSI_TOKEN_POST_URI = 1,
591 WSI_TOKEN_OPTIONS_URI = 2,
593 WSI_TOKEN_CONNECTION = 4,
594 WSI_TOKEN_UPGRADE = 5,
595 WSI_TOKEN_ORIGIN = 6,
597 WSI_TOKEN_CHALLENGE = 8,
598 WSI_TOKEN_EXTENSIONS = 9,
601 WSI_TOKEN_PROTOCOL = 12,
602 WSI_TOKEN_ACCEPT = 13,
603 WSI_TOKEN_NONCE = 14,
605 WSI_TOKEN_HTTP2_SETTINGS = 16,
606 WSI_TOKEN_HTTP_ACCEPT = 17,
607 WSI_TOKEN_HTTP_AC_REQUEST_HEADERS = 18,
608 WSI_TOKEN_HTTP_IF_MODIFIED_SINCE = 19,
609 WSI_TOKEN_HTTP_IF_NONE_MATCH = 20,
610 WSI_TOKEN_HTTP_ACCEPT_ENCODING = 21,
611 WSI_TOKEN_HTTP_ACCEPT_LANGUAGE = 22,
612 WSI_TOKEN_HTTP_PRAGMA = 23,
613 WSI_TOKEN_HTTP_CACHE_CONTROL = 24,
614 WSI_TOKEN_HTTP_AUTHORIZATION = 25,
615 WSI_TOKEN_HTTP_COOKIE = 26,
616 WSI_TOKEN_HTTP_CONTENT_LENGTH = 27,
617 WSI_TOKEN_HTTP_CONTENT_TYPE = 28,
618 WSI_TOKEN_HTTP_DATE = 29,
619 WSI_TOKEN_HTTP_RANGE = 30,
620 WSI_TOKEN_HTTP_REFERER = 31,
622 WSI_TOKEN_VERSION = 33,
623 WSI_TOKEN_SWORIGIN = 34,
625 WSI_TOKEN_HTTP_COLON_AUTHORITY = 35,
626 WSI_TOKEN_HTTP_COLON_METHOD = 36,
627 WSI_TOKEN_HTTP_COLON_PATH = 37,
628 WSI_TOKEN_HTTP_COLON_SCHEME = 38,
629 WSI_TOKEN_HTTP_COLON_STATUS = 39,
631 WSI_TOKEN_HTTP_ACCEPT_CHARSET = 40,
632 WSI_TOKEN_HTTP_ACCEPT_RANGES = 41,
633 WSI_TOKEN_HTTP_ACCESS_CONTROL_ALLOW_ORIGIN = 42,
634 WSI_TOKEN_HTTP_AGE = 43,
635 WSI_TOKEN_HTTP_ALLOW = 44,
636 WSI_TOKEN_HTTP_CONTENT_DISPOSITION = 45,
637 WSI_TOKEN_HTTP_CONTENT_ENCODING = 46,
638 WSI_TOKEN_HTTP_CONTENT_LANGUAGE = 47,
639 WSI_TOKEN_HTTP_CONTENT_LOCATION = 48,
640 WSI_TOKEN_HTTP_CONTENT_RANGE = 49,
641 WSI_TOKEN_HTTP_ETAG = 50,
642 WSI_TOKEN_HTTP_EXPECT = 51,
643 WSI_TOKEN_HTTP_EXPIRES = 52,
644 WSI_TOKEN_HTTP_FROM = 53,
645 WSI_TOKEN_HTTP_IF_MATCH = 54,
646 WSI_TOKEN_HTTP_IF_RANGE = 55,
647 WSI_TOKEN_HTTP_IF_UNMODIFIED_SINCE = 56,
648 WSI_TOKEN_HTTP_LAST_MODIFIED = 57,
649 WSI_TOKEN_HTTP_LINK = 58,
650 WSI_TOKEN_HTTP_LOCATION = 59,
651 WSI_TOKEN_HTTP_MAX_FORWARDS = 60,
652 WSI_TOKEN_HTTP_PROXY_AUTHENTICATE = 61,
653 WSI_TOKEN_HTTP_PROXY_AUTHORIZATION = 62,
654 WSI_TOKEN_HTTP_REFRESH = 63,
655 WSI_TOKEN_HTTP_RETRY_AFTER = 64,
656 WSI_TOKEN_HTTP_SERVER = 65,
657 WSI_TOKEN_HTTP_SET_COOKIE = 66,
658 WSI_TOKEN_HTTP_STRICT_TRANSPORT_SECURITY = 67,
659 WSI_TOKEN_HTTP_TRANSFER_ENCODING = 68,
660 WSI_TOKEN_HTTP_USER_AGENT = 69,
661 WSI_TOKEN_HTTP_VARY = 70,
662 WSI_TOKEN_HTTP_VIA = 71,
663 WSI_TOKEN_HTTP_WWW_AUTHENTICATE = 72,
665 WSI_TOKEN_PATCH_URI = 73,
666 WSI_TOKEN_PUT_URI = 74,
667 WSI_TOKEN_DELETE_URI = 75,
669 WSI_TOKEN_HTTP_URI_ARGS = 76,
670 WSI_TOKEN_PROXY = 77,
671 WSI_TOKEN_HTTP_X_REAL_IP = 78,
672 WSI_TOKEN_HTTP1_0 = 79,
674 /****** add new things just above ---^ ******/
676 /* use token storage to stash these internally, not for
679 _WSI_TOKEN_CLIENT_SENT_PROTOCOLS,
680 _WSI_TOKEN_CLIENT_PEER_ADDRESS,
681 _WSI_TOKEN_CLIENT_URI,
682 _WSI_TOKEN_CLIENT_HOST,
683 _WSI_TOKEN_CLIENT_ORIGIN,
684 _WSI_TOKEN_CLIENT_METHOD,
686 /* always last real token index*/
689 /* parser state additions, no storage associated */
692 WSI_TOKEN_SKIPPING_SAW_CR,
693 WSI_PARSING_COMPLETE,
694 WSI_INIT_TOKEN_MUXURL,
697 struct lws_token_limits {
698 unsigned short token_limit[WSI_TOKEN_COUNT];
705 1000 indicates a normal closure, meaning that the purpose for
706 which the connection was established has been fulfilled.
710 1001 indicates that an endpoint is "going away", such as a server
711 going down or a browser having navigated away from a page.
715 1002 indicates that an endpoint is terminating the connection due
720 1003 indicates that an endpoint is terminating the connection
721 because it has received a type of data it cannot accept (e.g., an
722 endpoint that understands only text data MAY send this if it
723 receives a binary message).
727 Reserved. The specific meaning might be defined in the future.
731 1005 is a reserved value and MUST NOT be set as a status code in a
732 Close control frame by an endpoint. It is designated for use in
733 applications expecting a status code to indicate that no status
734 code was actually present.
738 1006 is a reserved value and MUST NOT be set as a status code in a
739 Close control frame by an endpoint. It is designated for use in
740 applications expecting a status code to indicate that the
741 connection was closed abnormally, e.g., without sending or
742 receiving a Close control frame.
746 1007 indicates that an endpoint is terminating the connection
747 because it has received data within a message that was not
748 consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
749 data within a text message).
753 1008 indicates that an endpoint is terminating the connection
754 because it has received a message that violates its policy. This
755 is a generic status code that can be returned when there is no
756 other more suitable status code (e.g., 1003 or 1009) or if there
757 is a need to hide specific details about the policy.
761 1009 indicates that an endpoint is terminating the connection
762 because it has received a message that is too big for it to
767 1010 indicates that an endpoint (client) is terminating the
768 connection because it has expected the server to negotiate one or
769 more extension, but the server didn't return them in the response
770 message of the WebSocket handshake. The list of extensions that
771 are needed SHOULD appear in the /reason/ part of the Close frame.
772 Note that this status code is not used by the server, because it
773 can fail the WebSocket handshake instead.
777 1011 indicates that a server is terminating the connection because
778 it encountered an unexpected condition that prevented it from
779 fulfilling the request.
783 1015 is a reserved value and MUST NOT be set as a status code in a
784 Close control frame by an endpoint. It is designated for use in
785 applications expecting a status code to indicate that the
786 connection was closed due to a failure to perform a TLS handshake
787 (e.g., the server certificate can't be verified).
791 * NOTE: These public enums are part of the abi. If you want to add one,
792 * add it at where specified so existing users are unaffected.
794 enum lws_close_status {
795 LWS_CLOSE_STATUS_NOSTATUS = 0,
796 LWS_CLOSE_STATUS_NORMAL = 1000,
797 LWS_CLOSE_STATUS_GOINGAWAY = 1001,
798 LWS_CLOSE_STATUS_PROTOCOL_ERR = 1002,
799 LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE = 1003,
800 LWS_CLOSE_STATUS_RESERVED = 1004,
801 LWS_CLOSE_STATUS_NO_STATUS = 1005,
802 LWS_CLOSE_STATUS_ABNORMAL_CLOSE = 1006,
803 LWS_CLOSE_STATUS_INVALID_PAYLOAD = 1007,
804 LWS_CLOSE_STATUS_POLICY_VIOLATION = 1008,
805 LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE = 1009,
806 LWS_CLOSE_STATUS_EXTENSION_REQUIRED = 1010,
807 LWS_CLOSE_STATUS_UNEXPECTED_CONDITION = 1011,
808 LWS_CLOSE_STATUS_TLS_FAILURE = 1015,
810 /****** add new things just above ---^ ******/
812 LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY = 9999,
816 HTTP_STATUS_OK = 200,
817 HTTP_STATUS_NO_CONTENT = 204,
819 HTTP_STATUS_MOVED_PERMANENTLY = 301,
820 HTTP_STATUS_FOUND = 302,
821 HTTP_STATUS_SEE_OTHER = 303,
823 HTTP_STATUS_BAD_REQUEST = 400,
824 HTTP_STATUS_UNAUTHORIZED,
825 HTTP_STATUS_PAYMENT_REQUIRED,
826 HTTP_STATUS_FORBIDDEN,
827 HTTP_STATUS_NOT_FOUND,
828 HTTP_STATUS_METHOD_NOT_ALLOWED,
829 HTTP_STATUS_NOT_ACCEPTABLE,
830 HTTP_STATUS_PROXY_AUTH_REQUIRED,
831 HTTP_STATUS_REQUEST_TIMEOUT,
832 HTTP_STATUS_CONFLICT,
834 HTTP_STATUS_LENGTH_REQUIRED,
835 HTTP_STATUS_PRECONDITION_FAILED,
836 HTTP_STATUS_REQ_ENTITY_TOO_LARGE,
837 HTTP_STATUS_REQ_URI_TOO_LONG,
838 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE,
839 HTTP_STATUS_REQ_RANGE_NOT_SATISFIABLE,
840 HTTP_STATUS_EXPECTATION_FAILED,
842 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
843 HTTP_STATUS_NOT_IMPLEMENTED,
844 HTTP_STATUS_BAD_GATEWAY,
845 HTTP_STATUS_SERVICE_UNAVAILABLE,
846 HTTP_STATUS_GATEWAY_TIMEOUT,
847 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED,
852 /* needed even with extensions disabled for create context */
853 struct lws_extension;
856 * typedef lws_callback_function() - User server actions
857 * @wsi: Opaque websocket instance pointer
858 * @reason: The reason for the call
859 * @user: Pointer to per-session user data allocated by library
860 * @in: Pointer used for some callback reasons
861 * @len: Length set for some callback reasons
863 * This callback is the way the user controls what is served. All the
864 * protocol detail is hidden and handled by the library.
866 * For each connection / session there is user data allocated that is
867 * pointed to by "user". You set the size of this user data area when
868 * the library is initialized with lws_create_server.
870 * You get an opportunity to initialize user data when called back with
871 * LWS_CALLBACK_ESTABLISHED reason.
873 * LWS_CALLBACK_ESTABLISHED: after the server completes a handshake with
874 * an incoming client. If you built the library
875 * with ssl support, @in is a pointer to the
876 * ssl struct associated with the connection or
879 * LWS_CALLBACK_CLIENT_CONNECTION_ERROR: the request client connection has
880 * been unable to complete a handshake with the remote server. If
881 * in is non-NULL, you can find an error string of length len where
884 * LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH: this is the last chance for the
885 * client user code to examine the http headers
886 * and decide to reject the connection. If the
887 * content in the headers is interesting to the
888 * client (url, etc) it needs to copy it out at
889 * this point since it will be destroyed before
890 * the CLIENT_ESTABLISHED call
892 * LWS_CALLBACK_CLIENT_ESTABLISHED: after your client connection completed
893 * a handshake with the remote server
895 * LWS_CALLBACK_CLOSED: when the websocket session ends
897 * LWS_CALLBACK_CLOSED_HTTP: when a HTTP (non-websocket) session ends
899 * LWS_CALLBACK_RECEIVE: data has appeared for this server endpoint from a
900 * remote client, it can be found at *in and is
903 * LWS_CALLBACK_CLIENT_RECEIVE_PONG: if you elected to see PONG packets,
904 * they appear with this callback reason. PONG
905 * packets only exist in 04+ protocol
907 * LWS_CALLBACK_CLIENT_RECEIVE: data has appeared from the server for the
908 * client connection, it can be found at *in and
911 * LWS_CALLBACK_HTTP: an http request has come from a client that is not
912 * asking to upgrade the connection to a websocket
913 * one. This is a chance to serve http content,
914 * for example, to send a script to the client
915 * which will then open the websockets connection.
916 * @in points to the URI path requested and
917 * lws_serve_http_file() makes it very
918 * simple to send back a file to the client.
919 * Normally after sending the file you are done
920 * with the http connection, since the rest of the
921 * activity will come by websockets from the script
922 * that was delivered by http, so you will want to
923 * return 1; to close and free up the connection.
924 * That's important because it uses a slot in the
925 * total number of client connections allowed set
928 * LWS_CALLBACK_HTTP_BODY: the next @len bytes data from the http
929 * request body HTTP connection is now available in @in.
931 * LWS_CALLBACK_HTTP_BODY_COMPLETION: the expected amount of http request
932 * body has been delivered
934 * LWS_CALLBACK_HTTP_WRITEABLE: you can write more down the http protocol
937 * LWS_CALLBACK_HTTP_FILE_COMPLETION: a file requested to be send down
938 * http link has completed.
940 * LWS_CALLBACK_CLIENT_WRITEABLE:
941 * LWS_CALLBACK_SERVER_WRITEABLE: If you call
942 * lws_callback_on_writable() on a connection, you will
943 * get one of these callbacks coming when the connection socket
944 * is able to accept another write packet without blocking.
945 * If it already was able to take another packet without blocking,
946 * you'll get this callback at the next call to the service loop
947 * function. Notice that CLIENTs get LWS_CALLBACK_CLIENT_WRITEABLE
948 * and servers get LWS_CALLBACK_SERVER_WRITEABLE.
950 * LWS_CALLBACK_FILTER_NETWORK_CONNECTION: called when a client connects to
951 * the server at network level; the connection is accepted but then
952 * passed to this callback to decide whether to hang up immediately
953 * or not, based on the client IP. @in contains the connection
954 * socket's descriptor. Since the client connection information is
955 * not available yet, @wsi still pointing to the main server socket.
956 * Return non-zero to terminate the connection before sending or
957 * receiving anything. Because this happens immediately after the
958 * network connection from the client, there's no websocket protocol
959 * selected yet so this callback is issued only to protocol 0.
961 * LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED: A new client just had
962 * been connected, accepted, and instantiated into the pool. This
963 * callback allows setting any relevant property to it. Because this
964 * happens immediately after the instantiation of a new client,
965 * there's no websocket protocol selected yet so this callback is
966 * issued only to protocol 0. Only @wsi is defined, pointing to the
967 * new client, and the return value is ignored.
969 * LWS_CALLBACK_FILTER_HTTP_CONNECTION: called when the request has
970 * been received and parsed from the client, but the response is
971 * not sent yet. Return non-zero to disallow the connection.
972 * @user is a pointer to the connection user space allocation,
973 * @in is the URI, eg, "/"
974 * In your handler you can use the public APIs
975 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
976 * headers using the header enums lws_token_indexes from
977 * libwebsockets.h to check for and read the supported header
978 * presence and content before deciding to allow the http
979 * connection to proceed or to kill the connection.
981 * LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION: called when the handshake has
982 * been received and parsed from the client, but the response is
983 * not sent yet. Return non-zero to disallow the connection.
984 * @user is a pointer to the connection user space allocation,
985 * @in is the requested protocol name
986 * In your handler you can use the public APIs
987 * lws_hdr_total_length() / lws_hdr_copy() to access all of the
988 * headers using the header enums lws_token_indexes from
989 * libwebsockets.h to check for and read the supported header
990 * presence and content before deciding to allow the handshake
991 * to proceed or to kill the connection.
993 * LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS: if configured for
994 * including OpenSSL support, this callback allows your user code
995 * to perform extra SSL_CTX_load_verify_locations() or similar
996 * calls to direct OpenSSL where to find certificates the client
997 * can use to confirm the remote server identity. @user is the
1000 * LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS: if configured for
1001 * including OpenSSL support, this callback allows your user code
1002 * to load extra certifcates into the server which allow it to
1003 * verify the validity of certificates returned by clients. @user
1004 * is the server's OpenSSL SSL_CTX*
1006 * LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY: if configured for
1007 * including OpenSSL support but no private key file has been
1008 * specified (ssl_private_key_filepath is NULL), this is called to
1009 * allow the user to set the private key directly via libopenssl
1010 * and perform further operations if required; this might be useful
1011 * in situations where the private key is not directly accessible
1012 * by the OS, for example if it is stored on a smartcard
1013 * @user is the server's OpenSSL SSL_CTX*
1015 * LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION: if the
1016 * libwebsockets context was created with the option
1017 * LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT, then this
1018 * callback is generated during OpenSSL verification of the cert
1019 * sent from the client. It is sent to protocol[0] callback as
1020 * no protocol has been negotiated on the connection yet.
1021 * Notice that the libwebsockets context and wsi are both NULL
1022 * during this callback. See
1023 * http://www.openssl.org/docs/ssl/SSL_CTX_set_verify.html
1024 * to understand more detail about the OpenSSL callback that
1025 * generates this libwebsockets callback and the meanings of the
1026 * arguments passed. In this callback, @user is the x509_ctx,
1027 * @in is the ssl pointer and @len is preverify_ok
1028 * Notice that this callback maintains libwebsocket return
1029 * conventions, return 0 to mean the cert is OK or 1 to fail it.
1030 * This also means that if you don't handle this callback then
1031 * the default callback action of returning 0 allows the client
1034 * LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER: this callback happens
1035 * when a client handshake is being compiled. @user is NULL,
1036 * @in is a char **, it's pointing to a char * which holds the
1037 * next location in the header buffer where you can add
1038 * headers, and @len is the remaining space in the header buffer,
1039 * which is typically some hundreds of bytes. So, to add a canned
1040 * cookie, your handler code might look similar to:
1042 * char **p = (char **)in;
1047 * *p += sprintf(*p, "Cookie: a=b\x0d\x0a");
1051 * Notice if you add anything, you just have to take care about
1052 * the CRLF on the line you added. Obviously this callback is
1053 * optional, if you don't handle it everything is fine.
1055 * Notice the callback is coming to protocols[0] all the time,
1056 * because there is no specific protocol handshook yet.
1058 * LWS_CALLBACK_CONFIRM_EXTENSION_OKAY: When the server handshake code
1059 * sees that it does support a requested extension, before
1060 * accepting the extension by additing to the list sent back to
1061 * the client it gives this callback just to check that it's okay
1062 * to use that extension. It calls back to the requested protocol
1063 * and with @in being the extension name, @len is 0 and @user is
1064 * valid. Note though at this time the ESTABLISHED callback hasn't
1065 * happened yet so if you initialize @user content there, @user
1066 * content during this callback might not be useful for anything.
1067 * Notice this callback comes to protocols[0].
1069 * LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED: When a client
1070 * connection is being prepared to start a handshake to a server,
1071 * each supported extension is checked with protocols[0] callback
1072 * with this reason, giving the user code a chance to suppress the
1073 * claim to support that extension by returning non-zero. If
1074 * unhandled, by default 0 will be returned and the extension
1075 * support included in the header to the server. Notice this
1076 * callback comes to protocols[0].
1078 * LWS_CALLBACK_PROTOCOL_INIT: One-time call per protocol so it can
1079 * do initial setup / allocations etc
1081 * LWS_CALLBACK_PROTOCOL_DESTROY: One-time call per protocol indicating
1082 * this protocol won't get used at all after this callback, the
1083 * context is getting destroyed. Take the opportunity to
1084 * deallocate everything that was allocated by the protocol.
1086 * LWS_CALLBACK_WSI_CREATE: outermost (earliest) wsi create notification
1088 * LWS_CALLBACK_WSI_DESTROY: outermost (latest) wsi destroy notification
1090 * The next five reasons are optional and only need taking care of if you
1091 * will be integrating libwebsockets sockets into an external polling
1094 * For these calls, @in points to a struct lws_pollargs that
1095 * contains @fd, @events and @prev_events members
1097 * LWS_CALLBACK_ADD_POLL_FD: libwebsocket deals with its poll() loop
1098 * internally, but in the case you are integrating with another
1099 * server you will need to have libwebsocket sockets share a
1100 * polling array with the other server. This and the other
1101 * POLL_FD related callbacks let you put your specialized
1102 * poll array interface code in the callback for protocol 0, the
1103 * first protocol you support, usually the HTTP protocol in the
1105 * This callback happens when a socket needs to be
1106 * added to the polling loop: @in points to a struct
1107 * lws_pollargs; the @fd member of the struct is the file
1108 * descriptor, and @events contains the active events.
1110 * If you are using the internal polling loop (the "service"
1111 * callback), you can just ignore these callbacks.
1113 * LWS_CALLBACK_DEL_POLL_FD: This callback happens when a socket descriptor
1114 * needs to be removed from an external polling array. @in is
1115 * again the struct lws_pollargs containing the @fd member
1116 * to be removed. If you are using the internal polling
1117 * loop, you can just ignore it.
1119 * LWS_CALLBACK_CHANGE_MODE_POLL_FD: This callback happens when
1120 * libwebsockets wants to modify the events for a connectiion.
1121 * @in is the struct lws_pollargs with the @fd to change.
1122 * The new event mask is in @events member and the old mask is in
1123 * the @prev_events member.
1124 * If you are using the internal polling loop, you can just ignore
1127 * LWS_CALLBACK_LOCK_POLL:
1128 * LWS_CALLBACK_UNLOCK_POLL: These allow the external poll changes driven
1129 * by libwebsockets to participate in an external thread locking
1130 * scheme around the changes, so the whole thing is threadsafe.
1131 * These are called around three activities in the library,
1132 * - inserting a new wsi in the wsi / fd table (len=1)
1133 * - deleting a wsi from the wsi / fd table (len=1)
1134 * - changing a wsi's POLLIN/OUT state (len=0)
1135 * Locking and unlocking external synchronization objects when
1136 * len == 1 allows external threads to be synchronized against
1137 * wsi lifecycle changes if it acquires the same lock for the
1138 * duration of wsi dereference from the other thread context.
1140 * LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
1141 * The peer has sent an unsolicited Close WS packet. @in and
1142 * @len are the optional close code (first 2 bytes, network
1143 * order) and the optional additional information which is not
1144 * defined in the standard, and may be a string or non-human-
1146 * If you return 0 lws will echo the close and then close the
1147 * connection. If you return nonzero lws will just close the
1151 lws_callback_function(struct lws *wsi, enum lws_callback_reasons reason,
1152 void *user, void *in, size_t len);
1155 * typedef lws_extension_callback_function() - Hooks to allow extensions to operate
1156 * @context: Websockets context
1157 * @ext: This extension
1158 * @wsi: Opaque websocket instance pointer
1159 * @reason: The reason for the call
1160 * @user: Pointer to ptr to per-session user data allocated by library
1161 * @in: Pointer used for some callback reasons
1162 * @len: Length set for some callback reasons
1164 * Each extension that is active on a particular connection receives
1165 * callbacks during the connection lifetime to allow the extension to
1166 * operate on websocket data and manage itself.
1168 * Libwebsockets takes care of allocating and freeing "user" memory for
1169 * each active extension on each connection. That is what is pointed to
1170 * by the @user parameter.
1172 * LWS_EXT_CB_CONSTRUCT: called when the server has decided to
1173 * select this extension from the list provided by the client,
1174 * just before the server will send back the handshake accepting
1175 * the connection with this extension active. This gives the
1176 * extension a chance to initialize its connection context found
1179 * LWS_EXT_CB_CLIENT_CONSTRUCT: same as LWS_EXT_CB_CONSTRUCT
1180 * but called when client is instantiating this extension. Some
1181 * extensions will work the same on client and server side and then
1182 * you can just merge handlers for both CONSTRUCTS.
1184 * LWS_EXT_CB_DESTROY: called when the connection the extension was
1185 * being used on is about to be closed and deallocated. It's the
1186 * last chance for the extension to deallocate anything it has
1187 * allocated in the user data (pointed to by @user) before the
1188 * user data is deleted. This same callback is used whether you
1189 * are in client or server instantiation context.
1191 * LWS_EXT_CB_PACKET_RX_PREPARSE: when this extension was active on
1192 * a connection, and a packet of data arrived at the connection,
1193 * it is passed to this callback to give the extension a chance to
1194 * change the data, eg, decompress it. @user is pointing to the
1195 * extension's private connection context data, @in is pointing
1196 * to an lws_tokens struct, it consists of a char * pointer called
1197 * token, and an int called token_len. At entry, these are
1198 * set to point to the received buffer and set to the content
1199 * length. If the extension will grow the content, it should use
1200 * a new buffer allocated in its private user context data and
1201 * set the pointed-to lws_tokens members to point to its buffer.
1203 * LWS_EXT_CB_PACKET_TX_PRESEND: this works the same way as
1204 * LWS_EXT_CB_PACKET_RX_PREPARSE above, except it gives the
1205 * extension a chance to change websocket data just before it will
1206 * be sent out. Using the same lws_token pointer scheme in @in,
1207 * the extension can change the buffer and the length to be
1208 * transmitted how it likes. Again if it wants to grow the
1209 * buffer safely, it should copy the data into its own buffer and
1210 * set the lws_tokens token pointer to it.
1212 * LWS_EXT_CB_ARGS_VALIDATE:
1215 lws_extension_callback_function(struct lws_context *context,
1216 const struct lws_extension *ext, struct lws *wsi,
1217 enum lws_extension_callback_reasons reason,
1218 void *user, void *in, size_t len);
1221 * struct lws_protocols - List of protocols and handlers server
1223 * @name: Protocol name that must match the one given in the client
1224 * Javascript new WebSocket(url, 'protocol') name.
1225 * @callback: The service callback used for this protocol. It allows the
1226 * service action for an entire protocol to be encapsulated in
1227 * the protocol-specific callback
1228 * @per_session_data_size: Each new connection using this protocol gets
1229 * this much memory allocated on connection establishment and
1230 * freed on connection takedown. A pointer to this per-connection
1231 * allocation is passed into the callback in the 'user' parameter
1232 * @rx_buffer_size: if you want atomic frames delivered to the callback, you
1233 * should set this to the size of the biggest legal frame that
1234 * you support. If the frame size is exceeded, there is no
1235 * error, but the buffer will spill to the user callback when
1236 * full, which you can detect by using
1237 * lws_remaining_packet_payload(). Notice that you
1238 * just talk about frame size here, the LWS_PRE
1239 * and post-padding are automatically also allocated on top.
1240 * @id: ignored by lws, but useful to contain user information bound
1241 * to the selected protocol. For example if this protocol was
1242 * called "myprotocol-v2", you might set id to 2, and the user
1243 * code that acts differently according to the version can do so by
1244 * switch (wsi->protocol->id), user code might use some bits as
1245 * capability flags based on selected protocol version, etc.
1246 * @user: User provided context data at the protocol level.
1247 * Accessible via lws_get_protocol(wsi)->user
1248 * This should not be confused with wsi->user, it is not the same.
1249 * The library completely ignores any value in here.
1251 * This structure represents one protocol supported by the server. An
1252 * array of these structures is passed to lws_create_server()
1253 * allows as many protocols as you like to be handled by one server.
1255 * The first protocol given has its callback used for user callbacks when
1256 * there is no agreed protocol name, that's true during HTTP part of the
1257 * connection and true if the client did not send a Protocol: header.
1260 struct lws_protocols {
1262 lws_callback_function *callback;
1263 size_t per_session_data_size;
1264 size_t rx_buffer_size;
1268 /* Add new things just above here ---^
1269 * This is part of the ABI, don't needlessly break compatibility */
1272 enum lws_ext_options_types {
1277 /* Add new things just above here ---^
1278 * This is part of the ABI, don't needlessly break compatibility */
1282 * struct lws_ext_options - Option arguments to the extension. These are
1283 * used in the negotiation at ws upgrade time.
1284 * The helper function lws_ext_parse_options()
1285 * uses these to generate callbacks
1287 * @name: Option name, eg, "server_no_context_takeover"
1288 * @type: What kind of args the option can take
1290 struct lws_ext_options {
1292 enum lws_ext_options_types type;
1294 /* Add new things just above here ---^
1295 * This is part of the ABI, don't needlessly break compatibility */
1298 struct lws_ext_option_arg {
1299 const char *option_name; /* may be NULL, option_index used then */
1306 * struct lws_extension - An extension we know how to cope with
1308 * @name: Formal extension name, eg, "permessage-deflate"
1309 * @callback: Service callback
1310 * @client_offer: String containing exts and options client offers
1313 struct lws_extension {
1315 lws_extension_callback_function *callback;
1316 const char *client_offer;
1318 /* Add new things just above here ---^
1319 * This is part of the ABI, don't needlessly break compatibility */
1323 #ifdef LWS_WITH_PLUGINS
1325 /* PLUGINS implies LIBUV */
1327 #define LWS_PLUGIN_API_MAGIC 180
1329 struct lws_plugin_capability {
1330 unsigned int api_magic; /* caller fills this in, plugin fills rest */
1331 const struct lws_protocols *protocols;
1332 int count_protocols;
1333 const struct lws_extension *extensions;
1334 int count_extensions;
1337 typedef int (*lws_plugin_init_func)(struct lws_context *,
1338 struct lws_plugin_capability *);
1339 typedef int (*lws_plugin_destroy_func)(struct lws_context *);
1341 struct lws_plugin *list;
1342 #if (UV_VERSION_MAJOR > 0)
1348 struct lws_plugin_capability caps;
1354 * The internal exts are part of the public abi
1355 * If we add more extensions, publish the callback here ------v
1358 extern int lws_extension_callback_pm_deflate(
1359 struct lws_context *context, const struct lws_extension *ext,
1360 struct lws *wsi, enum lws_extension_callback_reasons reason,
1361 void *user, void *in, size_t len);
1364 lws_set_extension_option(struct lws *wsi, const char *ext_name,
1365 const char *opt_name, const char *opt_val);
1367 struct lws_protocol_vhost_options {
1368 struct lws_protocol_vhost_options *next;
1369 struct lws_protocol_vhost_options *options;
1374 struct lws_http_mount {
1375 struct lws_http_mount *mount_next;
1376 const char *mountpoint; /* mountpoint in http pathspace, eg, "/" */
1377 const char *origin; /* path to be mounted, eg, "/var/www/warmcat.com" */
1378 const char *def; /* default target, eg, "index.html" */
1380 struct lws_protocol_vhost_options *cgienv;
1385 unsigned int cache_reusable:1;
1386 unsigned int cache_revalidate:1;
1387 unsigned int cache_intermediaries:1;
1389 unsigned char origin_protocol;
1390 unsigned char mountpoint_len;
1394 * struct lws_context_creation_info - parameters to create context with
1396 * This is also used to create vhosts.... if LWS_SERVER_OPTION_EXPLICIT_VHOSTS
1397 * is not given, then for backwards compatibility one vhost is created at
1398 * context-creation time using the info from this struct.
1400 * If LWS_SERVER_OPTION_EXPLICIT_VHOSTS is given, then no vhosts are created
1401 * at the same time as the context, they are expected to be created afterwards.
1403 * @port: Port to listen on... you can use CONTEXT_PORT_NO_LISTEN to
1404 * suppress listening on any port, that's what you want if you are
1405 * not running a websocket server at all but just using it as a
1407 * @iface: NULL to bind the listen socket to all interfaces, or the
1408 * interface name, eg, "eth2"
1409 * If options specifies LWS_SERVER_OPTION_UNIX_SOCK, this member is
1410 * the pathname of a UNIX domain socket. you can use the UNIX domain
1411 * sockets in abstract namespace, by prepending an @ symbole to the
1413 * @protocols: Array of structures listing supported protocols and a protocol-
1414 * specific callback for each one. The list is ended with an
1415 * entry that has a NULL callback pointer.
1416 * It's not const because we write the owning_server member
1417 * @extensions: NULL or array of lws_extension structs listing the
1418 * extensions this context supports. If you configured with
1419 * --without-extensions, you should give NULL here.
1420 * @token_limits: NULL or struct lws_token_limits pointer which is initialized
1421 * with a token length limit for each possible WSI_TOKEN_***
1422 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1423 * to listen using SSL, set to the filepath to fetch the
1424 * server cert from, otherwise NULL for unencrypted
1425 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode;
1426 * if this is set to NULL but sll_cert_filepath is set, the
1427 * OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY callback is called
1428 * to allow setting of the private key directly via openSSL
1430 * @ssl_ca_filepath: CA certificate filepath or NULL
1431 * @ssl_cipher_list: List of valid ciphers to use (eg,
1432 * "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
1433 * or you can leave it as NULL to get "DEFAULT"
1434 * @http_proxy_address: If non-NULL, attempts to proxy via the given address.
1435 * If proxy auth is required, use format
1436 * "username:password@server:port"
1437 * @http_proxy_port: If http_proxy_address was non-NULL, uses this port at
1439 * @gid: group id to change to after setting listen socket, or -1.
1440 * @uid: user id to change to after setting listen socket, or -1.
1441 * @options: 0, or LWS_SERVER_OPTION_... bitfields
1442 * @user: optional user pointer that can be recovered via the context
1443 * pointer using lws_context_user
1444 * @ka_time: 0 for no keepalive, otherwise apply this keepalive timeout to
1445 * all libwebsocket sockets, client or server
1446 * @ka_probes: if ka_time was nonzero, after the timeout expires how many
1447 * times to try to get a response from the peer before giving up
1448 * and killing the connection
1449 * @ka_interval: if ka_time was nonzero, how long to wait before each ka_probes
1451 * @provided_client_ssl_ctx: If non-null, swap out libwebsockets ssl
1452 * implementation for the one provided by provided_ssl_ctx.
1453 * Libwebsockets no longer is responsible for freeing the context
1454 * if this option is selected.
1455 * @max_http_header_data: The max amount of header payload that can be handled
1456 * in an http request (unrecognized header payload is dropped)
1457 * @max_http_header_pool: The max number of connections with http headers that
1458 * can be processed simultaneously (the corresponding memory is
1459 * allocated for the lifetime of the context). If the pool is
1460 * busy new incoming connections must wait for accept until one
1462 * @count_threads: how many contexts to create in an array, 0 = 1
1463 * @fd_limit_per_thread: nonzero means restrict each service thread to this
1464 * many fds, 0 means the default which is divide the process fd
1465 * limit by the number of threads.
1466 * @timeout_secs: various processes involving network roundtrips in the
1467 * library are protected from hanging forever by timeouts. If
1468 * nonzero, this member lets you set the timeout used in seconds.
1469 * Otherwise a default timeout is used.
1470 * @ecdh_curve: if NULL, defaults to initializing server with "prime256v1"
1473 struct lws_context_creation_info {
1475 const char *iface; /* VH */
1476 const struct lws_protocols *protocols; /* VH */
1477 const struct lws_extension *extensions; /* VH */
1478 const struct lws_token_limits *token_limits;
1479 const char *ssl_private_key_password; /* VH */
1480 const char *ssl_cert_filepath; /* VH */
1481 const char *ssl_private_key_filepath; /* VH */
1482 const char *ssl_ca_filepath; /* VH */
1483 const char *ssl_cipher_list; /* VH */
1484 const char *http_proxy_address; /* VH */
1485 unsigned int http_proxy_port; /* VH */
1486 int gid; /* context */
1487 int uid; /* context */
1488 unsigned int options; /* context */
1489 void *user; /* context */
1493 #ifdef LWS_OPENSSL_SUPPORT
1494 SSL_CTX *provided_client_ssl_ctx;
1495 #else /* maintain structure layout either way */
1496 void *provided_client_ssl_ctx;
1499 short max_http_header_data;
1500 short max_http_header_pool;
1502 unsigned int count_threads; /* context */
1503 unsigned int fd_limit_per_thread; /* context */
1504 unsigned int timeout_secs; /* VH */
1505 const char *ecdh_curve; /* VH */
1506 const char *vhost_name; /* VH */
1507 const char *plugins_dir; /* context */
1508 struct lws_protocol_vhost_options *pvo; /* VH */
1509 int keepalive_timeout; /* VH */
1510 const char *log_filepath; /* VH */
1511 const char *server_string; /* context */
1513 /* Add new things just above here ---^
1514 * This is part of the ABI, don't needlessly break compatibility
1516 * The below is to ensure later library versions with new
1517 * members added above will see 0 (default) even if the app
1518 * was not built against the newer headers.
1525 * struct lws_client_connect_info - parameters to connect with when using
1526 * lws_client_connect_via_info()
1528 * @context: lws context to create connection in
1529 * @address: remote address to connect to
1530 * @port: remote port to connect to
1531 * @ssl_connection: nonzero for ssl
1533 * @host: content of host header
1534 * @origin: content of origin header
1535 * @protocol: list of ws protocols
1536 * @ietf_version_or_minus_one: currently leave at 0 or -1
1537 * @userdata: if non-NULL, use this as wsi user_data instead of malloc it
1538 * @client_exts: array of extensions that may be used on connection
1539 * @method: if non-NULL, do this http method instead of ws[s] upgrade.
1540 * use "GET" to be a simple http client connection
1541 * @parent_wsi: if another wsi is responsible for this connection, give it here.
1542 * this is used to make sure if the parent closes so do any
1543 * child connections first.
1544 * @uri_replace_from: if non-NULL, when this string is found in URIs in
1545 * text/html content-encoding, it's replaced with @uri_replace_to
1546 * @uri_replace_to: see above
1547 * @vhost: vhost to bind to (used to determine related SSL_CTX)
1550 struct lws_client_connect_info {
1551 struct lws_context *context;
1552 const char *address;
1558 const char *protocol;
1559 int ietf_version_or_minus_one;
1561 const struct lws_extension *client_exts;
1563 struct lws *parent_wsi;
1564 const char *uri_replace_from;
1565 const char *uri_replace_to;
1566 struct lws_vhost *vhost;
1568 /* Add new things just above here ---^
1569 * This is part of the ABI, don't needlessly break compatibility
1571 * The below is to ensure later library versions with new
1572 * members added above will see 0 (default) even if the app
1573 * was not built against the newer headers.
1585 LWSMPRO_REDIR_HTTPS,
1589 lws_json_dump_vhost(const struct lws_vhost *vh, char *buf, int len);
1592 lws_json_dump_context(const struct lws_context *context, char *buf, int len);
1594 LWS_VISIBLE LWS_EXTERN void
1595 lws_set_log_level(int level,
1596 void (*log_emit_function)(int level, const char *line));
1598 LWS_VISIBLE LWS_EXTERN void
1599 lwsl_emit_syslog(int level, const char *line);
1601 LWS_VISIBLE LWS_EXTERN struct lws_context *
1602 lws_create_context(struct lws_context_creation_info *info);
1606 LWS_VISIBLE struct lws_vhost *
1607 lws_create_vhost(struct lws_context *context,
1608 struct lws_context_creation_info *info,
1609 struct lws_http_mount *mounts);
1611 LWS_VISIBLE struct lws_vhost *
1612 lws_vhost_get(struct lws *wsi);
1614 LWS_VISIBLE const struct lws_protocols *
1615 lws_protocol_get(struct lws *wsi);
1618 lws_protocol_vh_priv_zalloc(struct lws_vhost *vhost, const struct lws_protocols *prot,
1621 lws_protocol_vh_priv_get(struct lws_vhost *vhost, const struct lws_protocols *prot);
1623 LWS_VISIBLE LWS_EXTERN int
1624 lws_finalize_startup(struct lws_context *context);
1626 LWS_VISIBLE LWS_EXTERN int
1627 lws_set_proxy(struct lws_vhost *vhost, const char *proxy);
1629 LWS_VISIBLE LWS_EXTERN void
1630 lws_context_destroy(struct lws_context *context);
1632 LWS_VISIBLE LWS_EXTERN int
1633 lws_service(struct lws_context *context, int timeout_ms);
1635 LWS_VISIBLE LWS_EXTERN int
1636 lws_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1638 LWS_VISIBLE LWS_EXTERN void
1639 lws_cancel_service_pt(struct lws *wsi);
1641 LWS_VISIBLE LWS_EXTERN void
1642 lws_cancel_service(struct lws_context *context);
1644 LWS_VISIBLE LWS_EXTERN int
1645 lws_interface_to_sa(int ipv6, const char *ifname, struct sockaddr_in *addr,
1648 LWS_VISIBLE LWS_EXTERN const unsigned char *
1649 lws_token_to_string(enum lws_token_indexes token);
1651 /* all the below must be LWS_WARN_UNUSED_RESULT as they can run short */
1653 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1654 lws_add_http_header_by_name(struct lws *wsi, const unsigned char *name,
1655 const unsigned char *value, int length,
1656 unsigned char **p, unsigned char *end);
1657 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1658 lws_finalize_http_header(struct lws *wsi, unsigned char **p,
1659 unsigned char *end);
1660 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1661 lws_add_http_header_by_token(struct lws *wsi, enum lws_token_indexes token,
1662 const unsigned char *value, int length,
1663 unsigned char **p, unsigned char *end);
1664 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1665 lws_add_http_header_content_length(struct lws *wsi,
1666 unsigned long content_length,
1667 unsigned char **p, unsigned char *end);
1668 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1669 lws_add_http_header_status(struct lws *wsi,
1670 unsigned int code, unsigned char **p,
1671 unsigned char *end);
1673 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1674 lws_http_redirect(struct lws *wsi, int code, const unsigned char *loc, int len,
1675 unsigned char **p, unsigned char *end);
1677 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1678 lws_http_transaction_completed(struct lws *wsi);
1680 #ifdef LWS_USE_LIBEV
1681 typedef void (lws_ev_signal_cb_t)(EV_P_ struct ev_signal *w, int revents);
1683 LWS_VISIBLE LWS_EXTERN int
1684 lws_ev_sigint_cfg(struct lws_context *context, int use_ev_sigint,
1685 lws_ev_signal_cb_t *cb);
1687 LWS_VISIBLE LWS_EXTERN int
1688 lws_ev_initloop(struct lws_context *context, struct ev_loop *loop, int tsi);
1691 lws_ev_sigint_cb(struct ev_loop *loop, struct ev_signal *watcher, int revents);
1692 #endif /* LWS_USE_LIBEV */
1694 #ifdef LWS_USE_LIBUV
1695 LWS_VISIBLE LWS_EXTERN int
1696 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
1699 LWS_VISIBLE LWS_EXTERN void
1700 lws_libuv_run(const struct lws_context *context, int tsi);
1703 lws_libuv_stop(struct lws_context *context);
1705 LWS_VISIBLE LWS_EXTERN int
1706 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
1708 LWS_VISIBLE LWS_EXTERN uv_loop_t *
1709 lws_uv_getloop(struct lws_context *context, int tsi);
1712 lws_uv_sigint_cb(uv_signal_t *watcher, int signum);
1713 #endif /* LWS_USE_LIBUV */
1715 LWS_VISIBLE LWS_EXTERN int
1716 lws_service_fd(struct lws_context *context, struct lws_pollfd *pollfd);
1718 LWS_VISIBLE LWS_EXTERN int
1719 lws_service_fd_tsi(struct lws_context *context, struct lws_pollfd *pollfd,
1722 LWS_VISIBLE LWS_EXTERN void *
1723 lws_context_user(struct lws_context *context);
1725 LWS_VISIBLE LWS_EXTERN void *
1726 lws_wsi_user(struct lws *wsi);
1729 * NOTE: These public enums are part of the abi. If you want to add one,
1730 * add it at where specified so existing users are unaffected.
1732 enum pending_timeout {
1733 NO_PENDING_TIMEOUT = 0,
1734 PENDING_TIMEOUT_AWAITING_PROXY_RESPONSE = 1,
1735 PENDING_TIMEOUT_AWAITING_CONNECT_RESPONSE = 2,
1736 PENDING_TIMEOUT_ESTABLISH_WITH_SERVER = 3,
1737 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE = 4,
1738 PENDING_TIMEOUT_AWAITING_PING = 5,
1739 PENDING_TIMEOUT_CLOSE_ACK = 6,
1740 PENDING_TIMEOUT_AWAITING_EXTENSION_CONNECT_RESPONSE = 7,
1741 PENDING_TIMEOUT_SENT_CLIENT_HANDSHAKE = 8,
1742 PENDING_TIMEOUT_SSL_ACCEPT = 9,
1743 PENDING_TIMEOUT_HTTP_CONTENT = 10,
1744 PENDING_TIMEOUT_AWAITING_CLIENT_HS_SEND = 11,
1745 PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE = 12,
1746 PENDING_TIMEOUT_SHUTDOWN_FLUSH = 13,
1747 PENDING_TIMEOUT_CGI = 14,
1748 PENDING_TIMEOUT_HTTP_KEEPALIVE_IDLE = 15,
1750 /****** add new things just above ---^ ******/
1753 LWS_VISIBLE LWS_EXTERN void
1754 lws_set_timeout(struct lws *wsi, enum pending_timeout reason, int secs);
1759 * When sending with websocket protocol
1763 * LWS_WRITE_CONTINUATION,
1767 * the send buffer has to have LWS_PRE bytes valid BEFORE
1768 * the buffer pointer you pass to lws_write().
1770 * This allows us to add protocol info before and after the data, and send as
1771 * one packet on the network without payload copying, for maximum efficiency.
1773 * So for example you need this kind of code to use lws_write with a
1776 * char buf[LWS_PRE + 128];
1778 * // fill your part of the buffer... for example here it's all zeros
1779 * memset(&buf[LWS_PRE], 0, 128);
1781 * lws_write(wsi, &buf[LWS_PRE], 128, LWS_WRITE_TEXT);
1783 * When sending HTTP, with
1786 * LWS_WRITE_HTTP_HEADERS
1787 * LWS_WRITE_HTTP_FINAL
1789 * there is no protocol data prepended, and don't need to take care about the
1790 * LWS_PRE bytes valid before the buffer pointer.
1792 * LWS_PRE is at least the frame nonce + 2 header + 8 length
1793 * LWS_SEND_BUFFER_POST_PADDING is deprecated, it's now 0 and can be left off.
1794 * The example apps no longer use it.
1796 * Pad LWS_PRE to the CPU word size, so that word references
1797 * to the address immediately after the padding won't cause an unaligned access
1798 * error. Sometimes for performance reasons the recommended padding is even
1799 * larger than sizeof(void *).
1802 #if !defined(LWS_SIZEOFPTR)
1803 #define LWS_SIZEOFPTR (sizeof (void *))
1805 #if !defined(u_int64_t)
1806 #define u_int64_t unsigned long long
1810 #define _LWS_PAD_SIZE 16 /* Intel recommended for best performance */
1812 #define _LWS_PAD_SIZE LWS_SIZEOFPTR /* Size of a pointer on the target arch */
1814 #define _LWS_PAD(n) (((n) % _LWS_PAD_SIZE) ? \
1815 ((n) + (_LWS_PAD_SIZE - ((n) % _LWS_PAD_SIZE))) : (n))
1816 #define LWS_PRE _LWS_PAD(4 + 10)
1817 /* used prior to 1.7 and retained for backward compatibility */
1818 #define LWS_SEND_BUFFER_PRE_PADDING LWS_PRE
1819 #define LWS_SEND_BUFFER_POST_PADDING 0
1821 LWS_VISIBLE LWS_EXTERN int
1822 lws_write(struct lws *wsi, unsigned char *buf, size_t len,
1823 enum lws_write_protocol protocol);
1826 * lws_close_reason - Set reason and aux data to send with Close packet
1827 * If you are going to return nonzero from the callback
1828 * requesting the connection to close, you can optionally
1829 * call this to set the reason the peer will be told if
1832 * @wsi: The websocket connection to set the close reason on
1833 * @status: A valid close status from websocket standard
1834 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
1835 * @len: Length of data in @buf to send
1837 LWS_VISIBLE LWS_EXTERN void
1838 lws_close_reason(struct lws *wsi, enum lws_close_status status,
1839 unsigned char *buf, size_t len);
1841 /* helper for case where buffer may be const */
1842 #define lws_write_http(wsi, buf, len) \
1843 lws_write(wsi, (unsigned char *)(buf), len, LWS_WRITE_HTTP)
1845 LWS_VISIBLE LWS_EXTERN int
1846 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
1847 const char *other_headers, int other_headers_len);
1848 LWS_VISIBLE LWS_EXTERN int
1849 lws_serve_http_file_fragment(struct lws *wsi);
1851 LWS_VISIBLE LWS_EXTERN int
1852 lws_return_http_status(struct lws *wsi, unsigned int code,
1853 const char *html_body);
1855 LWS_VISIBLE LWS_EXTERN const struct lws_protocols *
1856 lws_get_protocol(struct lws *wsi);
1858 LWS_VISIBLE LWS_EXTERN int
1859 lws_callback_on_writable(struct lws *wsi);
1861 LWS_VISIBLE LWS_EXTERN int
1862 lws_callback_on_writable_all_protocol(const struct lws_context *context,
1863 const struct lws_protocols *protocol);
1866 lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
1867 const struct lws_protocols *protocol);
1869 LWS_VISIBLE LWS_EXTERN int
1870 lws_callback_all_protocol(struct lws_context *context,
1871 const struct lws_protocols *protocol, int reason);
1874 lws_callback_all_protocol_vhost(struct lws_vhost *vh,
1875 const struct lws_protocols *protocol, int reason);
1877 LWS_VISIBLE LWS_EXTERN int
1878 lws_get_socket_fd(struct lws *wsi);
1880 LWS_VISIBLE LWS_EXTERN int
1881 lws_is_final_fragment(struct lws *wsi);
1883 LWS_VISIBLE LWS_EXTERN unsigned char
1884 lws_get_reserved_bits(struct lws *wsi);
1886 LWS_VISIBLE LWS_EXTERN int
1887 lws_rx_flow_control(struct lws *wsi, int enable);
1889 LWS_VISIBLE LWS_EXTERN void
1890 lws_rx_flow_allow_all_protocol(const struct lws_context *context,
1891 const struct lws_protocols *protocol);
1893 LWS_VISIBLE LWS_EXTERN size_t
1894 lws_remaining_packet_payload(struct lws *wsi);
1897 * if the protocol does not have any guidance, returns -1. Currently only
1898 * http2 connections get send window information from this API. But your code
1899 * should use it so it can work properly with any protocol.
1901 * If nonzero return is the amount of payload data the peer or intermediary has
1902 * reported it has buffer space for. That has NO relationship with the amount
1903 * of buffer space your OS can accept on this connection for a write action.
1905 * This number represents the maximum you could send to the peer or intermediary
1906 * on this connection right now without it complaining.
1908 * lws manages accounting for send window updates and payload writes
1909 * automatically, so this number reflects the situation at the peer or
1910 * intermediary dynamically.
1912 LWS_VISIBLE LWS_EXTERN size_t
1913 lws_get_peer_write_allowance(struct lws *wsi);
1915 /* deprecated, use lws_client_connect_via_info() */
1916 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1917 lws_client_connect(struct lws_context *clients, const char *address,
1918 int port, int ssl_connection, const char *path,
1919 const char *host, const char *origin, const char *protocol,
1920 int ietf_version_or_minus_one) LWS_WARN_DEPRECATED;
1921 /* deprecated, use lws_client_connect_via_info() */
1922 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1923 lws_client_connect_extended(struct lws_context *clients, const char *address,
1924 int port, int ssl_connection, const char *path,
1925 const char *host, const char *origin,
1926 const char *protocol, int ietf_version_or_minus_one,
1927 void *userdata) LWS_WARN_DEPRECATED;
1929 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1930 lws_client_connect_via_info(struct lws_client_connect_info * ccinfo);
1932 LWS_VISIBLE LWS_EXTERN struct lws *
1933 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd);
1934 LWS_VISIBLE LWS_EXTERN struct lws *
1935 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
1936 const char *readbuf, size_t len);
1938 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1939 lws_canonical_hostname(struct lws_context *context);
1942 LWS_VISIBLE LWS_EXTERN void
1943 lws_get_peer_addresses(struct lws *wsi, lws_sockfd_type fd, char *name,
1944 int name_len, char *rip, int rip_len);
1946 LWS_VISIBLE LWS_EXTERN int
1947 lws_get_random(struct lws_context *context, void *buf, int len);
1949 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1950 lws_daemonize(const char *_lock_path);
1952 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1953 lws_send_pipe_choked(struct lws *wsi);
1955 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1956 lws_partial_buffered(struct lws *wsi);
1958 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1959 lws_frame_is_binary(struct lws *wsi);
1961 LWS_VISIBLE LWS_EXTERN int
1962 lws_is_ssl(struct lws *wsi);
1964 LWS_VISIBLE LWS_EXTERN int
1965 lws_is_cgi(struct lws *wsi);
1967 #ifdef LWS_SHA1_USE_OPENSSL_NAME
1968 #define lws_SHA1 SHA1
1970 LWS_VISIBLE LWS_EXTERN unsigned char *
1971 lws_SHA1(const unsigned char *d, size_t n, unsigned char *md);
1974 LWS_VISIBLE LWS_EXTERN int
1975 lws_b64_encode_string(const char *in, int in_len, char *out, int out_size);
1977 LWS_VISIBLE LWS_EXTERN int
1978 lws_b64_decode_string(const char *in, char *out, int out_size);
1980 LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1981 lws_get_library_version(void);
1983 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1984 lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
1988 * Access to http headers
1990 * In lws the client http headers are temporarily malloc'd only for the
1991 * duration of the http part of the handshake. It's because in most cases,
1992 * the header content is ignored for the whole rest of the connection lifetime
1993 * and would then just be taking up space needlessly.
1995 * During LWS_CALLBACK_HTTP when the URI path is delivered is the last time
1996 * the http headers are still allocated, you can use these apis then to
1997 * look at and copy out interesting header content (cookies, etc)
1999 * Notice that the header total length reported does not include a terminating
2000 * '\0', however you must allocate for it when using the _copy apis. So the
2001 * length reported for a header containing "123" is 3, but you must provide
2002 * a buffer of length 4 so that "123\0" may be copied into it, or the copy
2003 * will fail with a nonzero return code.
2006 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2007 lws_hdr_total_length(struct lws *wsi, enum lws_token_indexes h);
2009 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2010 lws_hdr_fragment_length(struct lws *wsi, enum lws_token_indexes h, int frag_idx);
2013 * copies the whole, aggregated header, even if it was delivered in
2014 * several actual headers piece by piece
2016 LWS_VISIBLE LWS_EXTERN int
2017 lws_hdr_copy(struct lws *wsi, char *dest, int len, enum lws_token_indexes h);
2020 * copies only fragment frag_idx of a header. Normally this is only useful
2021 * to parse URI arguments like ?x=1&y=2, token index WSI_TOKEN_HTTP_URI_ARGS
2022 * fragment 0 will contain "x=1" and fragment 1 "y=2"
2024 LWS_VISIBLE LWS_EXTERN int
2025 lws_hdr_copy_fragment(struct lws *wsi, char *dest, int len,
2026 enum lws_token_indexes h, int frag_idx);
2029 /* get the active file operations struct */
2030 LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops * LWS_WARN_UNUSED_RESULT
2031 lws_get_fops(struct lws_context *context);
2033 LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
2034 lws_get_context(const struct lws *wsi);
2036 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2037 lws_get_count_threads(struct lws_context *context);
2039 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2040 lws_get_parent(const struct lws *wsi);
2042 LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
2043 lws_get_child(const struct lws *wsi);
2046 enum lws_enum_stdinouterr {
2052 enum lws_cgi_hdr_state {
2062 struct lws_cgi_args {
2063 struct lws **stdwsi; /* get fd with lws_get_socket_fd() */
2064 enum lws_enum_stdinouterr ch;
2065 unsigned char *data; /* for messages with payload */
2066 enum lws_cgi_hdr_state hdr_state;
2070 LWS_VISIBLE LWS_EXTERN int
2071 lws_cgi(struct lws *wsi, const char * const *exec_array,
2072 int script_uri_path_len, int timeout_secs,
2073 struct lws_protocol_vhost_options *mp_cgienv);
2075 LWS_VISIBLE LWS_EXTERN int
2076 lws_cgi_write_split_stdout_headers(struct lws *wsi);
2078 LWS_VISIBLE LWS_EXTERN int
2079 lws_cgi_kill(struct lws *wsi);
2082 LWS_VISIBLE LWS_EXTERN int
2083 lws_http_client_read(struct lws *wsi, char **buf, int *len);
2086 * Wsi-associated File Operations access helpers
2088 * Use these helper functions if you want to access a file from the perspective
2089 * of a specific wsi, which is usually the case. If you just want contextless
2090 * file access, use the fops callbacks directly with NULL wsi instead of these
2093 * If so, then it calls the platform handler or user overrides where present
2094 * (as defined in info->fops)
2096 * The advantage from all this is user code can be portable for file operations
2097 * without having to deal with differences between platforms.
2100 static LWS_INLINE lws_filefd_type LWS_WARN_UNUSED_RESULT
2101 lws_plat_file_open(struct lws *wsi, const char *filename,
2102 unsigned long *filelen, int flags)
2104 return lws_get_fops(lws_get_context(wsi))->open(wsi, filename,
2108 static LWS_INLINE int
2109 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
2111 return lws_get_fops(lws_get_context(wsi))->close(wsi, fd);
2114 static LWS_INLINE unsigned long
2115 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
2117 return lws_get_fops(lws_get_context(wsi))->seek_cur(wsi, fd, offset);
2120 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
2121 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
2122 unsigned char *buf, unsigned long len)
2124 return lws_get_fops(lws_get_context(wsi))->read(wsi, fd, amount, buf,
2128 static LWS_INLINE int LWS_WARN_UNUSED_RESULT
2129 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
2130 unsigned char *buf, unsigned long len)
2132 return lws_get_fops(lws_get_context(wsi))->write(wsi, fd, amount, buf,
2137 * Note: this is not normally needed as a user api. It's provided in case it is
2138 * useful when integrating with other app poll loop service code.
2140 LWS_VISIBLE LWS_EXTERN int
2141 lws_read(struct lws *wsi, unsigned char *buf, size_t len);
2143 #ifndef LWS_NO_EXTENSIONS
2146 * There is no longer a set internal extensions table. The table is provided
2147 * by user code along with application-specific settings. See the test
2148 * client and server for how to do.
2150 static LWS_INLINE LWS_WARN_DEPRECATED const struct lws_extension *
2151 lws_get_internal_extensions() { return NULL; }
2152 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2153 lws_ext_parse_options(const struct lws_extension *ext, struct lws *wsi,
2154 void *ext_user, const struct lws_ext_options *opts,
2155 const char *o, int len);
2159 * custom allocator support
2161 LWS_VISIBLE LWS_EXTERN void
2162 lws_set_allocator(void *(*realloc)(void *ptr, size_t size));