10 1) There is now a "permessage-deflate" / RFC7692 implementation. It's very
11 similar to "deflate-frame" we have offered for a long while; deflate-frame is
12 now provided as an alias of permessage-deflate.
14 The main differences are that the new permessage-deflate implementation:
16 - properly performs streaming respecting input and output buffer limits. The
17 old deflate-frame implementation could only work on complete deflate input
18 and produce complete inflate output for each frame. The new implementation
19 only mallocs buffers at initialization.
21 - goes around the event loop after each input package is processed allowing
22 interleaved output processing. The RX flow control api can be used to
23 force compressed input processing to match the rate of compressed output
24 processing (test--echo shows an example of how to do this).
26 - when being "deflate-frame" for compatibility he uses the same default zlib
27 settings as the old "deflate-frame", but instead of exponentially increasing
28 malloc allocations until the whole output will fit, he observes the default
29 input and output chunking buffer sizes of "permessage-deflate", that's
30 1024 in and 1024 out at a time.
32 2) deflate-stream has been disabled for many versions (for over a year) and is
33 now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
35 3) struct lws_extension is simplified, and lws extensions now have a public
36 api (their callback) for use in user code to compose extensions and options
37 the user code wants. lws_get_internal_exts() is deprecated but kept around
38 as a NOP. The changes allow one extension implementation to go by different
39 names and allows the user client code to control option offers per-ext.
41 The test client and server are updated to use the new way. If you use
42 the old way it should still work, but extensions will be disabled until you
45 Extensions are now responsible for allocating and per-instance private struct
46 at instance construction time and freeing it when the instance is destroyed.
47 Not needing to know the size means the extension's struct can be opaque
54 1) The info struct gained three new members
56 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
57 http header payload that lws can deal with. Payload in unknown http
58 headers is dropped silently. If for some reason you need to send huge
59 cookies or other HTTP-level headers, you can now increase this at context-
62 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
63 headers that can be tracked by lws in this context. For the server, if
64 the header pool is completely in use then accepts on the listen socket
65 are disabled until one becomes free. For the client, if you simultaneously
66 have pending connects for more than this number of client connections,
67 additional connects will fail until some of the pending connections timeout
70 - timeout_secs: 0 for default (currently 20s), or set the library's
71 network activity timeout to the given number of seconds
73 HTTP header processing in lws only exists until just after the first main
74 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
75 for HTTP connections the HTTP callback.
77 So these settings are not related to the maximum number of simultaneous
78 connections, but the number of HTTP handshakes that may be expected or ongoing,
79 or have just completed, at one time. The reason it's useful is it changes the
80 memory allocation for header processing to be one-time at context creation
81 instead of every time there is a new connection, and gives you control over
84 Setting max_http_header_pool to 1 is fine it will just queue incoming
85 connections before the accept as necessary, you can still have as many
86 simultaneous post-header connections as you like. Since the http header
87 processing is completed and the allocation released after ESTABLISHED or the
88 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
90 2) There is a new callback that allows the user code to get acccess to the
91 optional close code + aux data that may have been sent by the peer.
93 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
94 The peer has sent an unsolicited Close WS packet. @in and
95 @len are the optional close code (first 2 bytes, network
96 order) and the optional additional information which is not
97 defined in the standard, and may be a string or non-human-
99 If you return 0 lws will echo the close and then close the
100 connection. If you return nonzero lws will just close the
103 As usual not handling it does the right thing, if you're not interested in it
106 The test server has "open and close" testing buttons at the bottom, if you
107 open and close that connection, on close it will send a close code 3000 decimal
108 and the string "Bye!" as the aux data.
110 The test server dumb-increment callback handles this callback reason and prints
112 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
113 lwsts[15714]: 0: 0x0B
114 lwsts[15714]: 1: 0xB8
115 lwsts[15714]: 2: 0x42
116 lwsts[15714]: 3: 0x79
117 lwsts[15714]: 4: 0x65
118 lwsts[15714]: 5: 0x21
120 3) There is a new API to allow the user code to control the content of the
121 close frame sent when about to return nonzero from the user callback to
122 indicate the connection should close.
125 * lws_close_reason - Set reason and aux data to send with Close packet
126 * If you are going to return nonzero from the callback
127 * requesting the connection to close, you can optionally
128 * call this to set the reason the peer will be told if
131 * @wsi: The websocket connection to set the close reason on
132 * @status: A valid close status from websocket standard
133 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
134 * @len: Length of data in @buf to send
136 LWS_VISIBLE LWS_EXTERN void
137 lws_close_reason(struct lws *wsi, enum lws_close_status status,
138 unsigned char *buf, size_t len);
140 An extra button is added to the "open and close" test server page that requests
141 that the test server close the connection from his end.
143 The test server code will do so by
145 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
146 (unsigned char *)"seeya", 5);
149 The browser shows the close code and reason he received
151 websocket connection CLOSED, code: 1001, reason: seeya
153 4) There's a new context creation time option flag
155 LWS_SERVER_OPTION_VALIDATE_UTF8
157 if you set it in info->options, then TEXT and CLOSE frames will get checked to
158 confirm that they contain valid UTF-8. If they don't, the connection will get
161 5) ECDH Certs are now supported. Enable the CMake option
163 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
165 **and** the info->options flag
167 LWS_SERVER_OPTION_SSL_ECDH
169 to build in support and select it at runtime.
171 6) There's a new api lws_parse_uri() that simplifies chopping up
172 https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
173 to allow proper uris as well as the old address style.
175 7) SMP support is integrated into LWS without any internal threading. It's
176 very simple to use, libwebsockets-test-server-pthread shows how to do it,
177 use -j <n> argument there to control the number of service threads up to 32.
179 Two new members are added to the info struct
181 unsigned int count_threads;
182 unsigned int fd_limit_per_thread;
184 leave them at the default 0 to get the normal singlethreaded service loop.
186 Set count_threads to n to tell lws you will have n simultaneous service threads
187 operating on the context.
189 There is still a single listen socket on one port, no matter how many
192 When a connection is made, it is accepted by the service thread with the least
193 connections active to perform load balancing.
195 The user code is responsible for spawning n threads running the service loop
196 associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
197 the libwebsockets-test-server-pthread for how to do.
199 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
200 between the service threads; if you process was allowed 1024 fds overall then
201 each thread is limited to 1024 / n.
203 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
204 the overall supported fd limit is less than the process allowance.
206 You can control the context basic data allocation for multithreading from Cmake
207 using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
208 for the threads (currently 4096) is made at runtime only for active threads.
210 Because lws will limit the requested number of actual threads supported
211 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
212 discover how many threads were actually allowed when the context was created.
214 It's required to implement locking in the user code in the same way that
215 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
217 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
218 library. If more than 1, a small amount of pthread mutex code is built into
223 LWS_VISIBLE struct lws *
224 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
226 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
227 had just been accepted by lws' own listen socket.
229 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
231 10) Libuv support is added, there are new related user apis
233 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
235 LWS_VISIBLE LWS_EXTERN int
236 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
237 lws_uv_signal_cb_t *cb);
239 LWS_VISIBLE LWS_EXTERN int
240 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
243 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
253 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
254 you still use it, obviously it does nothing. Old binary code with nonzero
255 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
256 allocated a buffer bigger than the library is going to use.
258 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
260 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
262 2) Because of lws_close_reason() formalizing handling close frames,
263 LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
264 close frames...close frame content should be managed using lws_close_reason()
267 3) We check for invalid CLOSE codes and complain about protocol violation in
268 our close code. But it changes little since we were in the middle of closing
271 4) zero-length RX frames and zero length TX frames are now allowed.
273 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
274 so that is now also allowed.
276 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
279 7) There's generic support for RFC7462 style extension options built into the
280 library now. As a consequence, a field "options" is added to lws_extension.
281 It can be NULL if there are no options on the extension. Extension internal
282 info is part of the public abi because extensions may be implemented outside
285 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
286 of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
289 9) With the addition of libuv support, libev is not the only event loop
290 library in town and his api names must be elaborated with _ev_
292 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
293 lws_sigint_cfg --> lws_ev_sigint_cfg
294 lws_initloop --> lws_ev_initloop
295 lws_sigint_cb --> lws_ev_sigint_cb
297 10) Libev support is made compatible with multithreaded service,
298 lws_ev_initloop (was lws_initloop) gets an extra argument for the
299 thread service index (use 0 if you will just have 1 service thread).
301 LWS_VISIBLE LWS_EXTERN int
302 lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
305 v1.6.0-chrome48-firefox42
306 =======================
308 Major API improvements
309 ----------------------
311 v1.6.0 has many cleanups and improvements in the API. Although at first it
312 looks pretty drastic, user code will only need four actions to update it.
314 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
315 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
317 - Remove the context parameter from your user callbacks
319 - Remove context as the first parameter from the "Eleven APIS" listed in the
320 User Api Changes section
322 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
323 in the User Api Changes section, and anywhere else you still need context
325 That's it... generally only a handful of the 14 affected APIs are actually in
326 use in your user code and you can find them quickest by compiling and visiting
327 the errors each in turn. And the end results are much cleaner, more
328 predictable and maintainable.
334 1) lws now exposes his internal platform file abstraction in a way that can be
335 both used by user code to make it platform-agnostic, and be overridden or
336 subclassed by user code. This allows things like handling the URI "directory
337 space" as a virtual filesystem that may or may not be backed by a regular
338 filesystem. One example use is serving files from inside large compressed
339 archive storage without having to unpack anything except the file being
342 The test server shows how to use it, basically the platform-specific part of
343 lws prepares a file operations structure that lives in the lws context.
345 Helpers are provided to also leverage these platform-independent file handling
348 static inline lws_filefd_type
349 lws_plat_file_open(struct lws *wsi, const char *filename,
350 unsigned long *filelen, int flags)
352 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
354 static inline unsigned long
355 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
358 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
359 unsigned char *buf, unsigned long len)
362 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
363 unsigned char *buf, unsigned long len)
365 The user code can also override or subclass the file operations, to either
366 wrap or replace them. An example is shown in test server.
368 A wsi can be associated with the file activity, allowing per-connection
369 authentication and state to be used when interpreting the file request.
371 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
372 the user data associated with the wsi, just from the wsi.
374 3) URI argument handling. Libwebsockets parses and protects URI arguments
375 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
376 path attacks like ../.../../etc/passwd so they cannot go behind the web
377 server's /. There is a list of confirmed attacks we're proof against in
378 ./test-server/attack.sh.
380 There is a new API lws_hdr_copy_fragment that should be used now to access
381 the URI arguments (it returns the fragments length)
383 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
384 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
385 lwsl_info("URI Arg %d: %s\n", ++n, buf);
388 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
389 All legal uriencodings will have been reduced in those strings.
391 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
392 possible to deal with arguments containing %00. If you don't care about that,
393 the returned string has '\0' appended to simplify processing.
401 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
402 - lws_callback_all_protocol(const struct lws_protocols *protocol)
403 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
405 Now take an additional pointer to the lws_context in their first argument.
407 The reason for this change is struct lws_protocols has been changed to remove
408 members that lws used for private storage: so the protocols struct in now
409 truly const and may be reused serially or simultaneously by different contexts.
413 LWS_VISIBLE LWS_EXTERN int
414 lws_add_http_header_by_name(struct lws_context *context,
416 const unsigned char *name,
417 const unsigned char *value,
421 LWS_VISIBLE LWS_EXTERN int
422 lws_finalize_http_header(struct lws_context *context,
426 LWS_VISIBLE LWS_EXTERN int
427 lws_add_http_header_by_token(struct lws_context *context,
429 enum lws_token_indexes token,
430 const unsigned char *value,
434 LWS_VISIBLE LWS_EXTERN int
435 lws_add_http_header_content_length(struct lws_context *context,
437 unsigned long content_length,
440 LWS_VISIBLE LWS_EXTERN int
441 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
442 unsigned int code, unsigned char **p,
445 LWS_VISIBLE LWS_EXTERN int
446 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
447 const char *file, const char *content_type,
448 const char *other_headers, int other_headers_len);
449 LWS_VISIBLE LWS_EXTERN int
450 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
452 LWS_VISIBLE LWS_EXTERN int
453 lws_return_http_status(struct lws_context *context, struct lws *wsi,
454 unsigned int code, const char *html_body);
456 LWS_VISIBLE LWS_EXTERN int
457 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
459 LWS_VISIBLE LWS_EXTERN void
460 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
461 lws_sockfd_type fd, char *name, int name_len,
462 char *rip, int rip_len);
464 LWS_VISIBLE LWS_EXTERN int
465 lws_read(struct lws_context *context, struct lws *wsi,
466 unsigned char *buf, size_t len);
468 no longer require their initial struct lws_context * parameter.
470 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
471 all begin lws_. These apis have been changed to all begin with lws_.
473 To convert, search-replace
475 - libwebsockets_/lws_
477 - struct\ libwebsocket/struct\ lws
479 4) context parameter removed from user callback.
481 Since almost all apis no longer need the context as a parameter, it's no longer
482 provided at the user callback directly.
484 However if you need it, for ALL callbacks wsi is valid and has a valid context
485 pointer you can recover using lws_get_context(wsi).
488 v1.5-chrome47-firefox41
489 =======================
494 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
495 non-NULL. If so, the string has length len.
497 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
498 for peer certs if you are using the option to require client certs.
500 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
501 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
504 v1.4-chrome43-firefox36
505 =======================
510 There's a new member in the info struct used to control context creation,
511 ssl_private_key_password, which allows passing into lws the passphrase on
514 There's a new member in struct protocols, id, which is ignored by lws but can
515 be used by the user code to mark the selected protocol by user-defined version
516 or capabliity flag information, for the case multiple versions of a protocol are
519 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
520 over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
521 ssl and non-ssl connections are possible and may need to be treated differently
524 int lws_partial_buffered(wsi) added... should be checked after any
525 libwebsocket_write that will be followed by another libwebsocket_write inside
526 the same writeable callback. If set, you can't do any more writes until the
527 writeable callback is called again. If you only do one write per writeable callback,
530 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
531 agnositic header creation APIs. These do the right thing depending on each
532 connection's HTTP version without the user code having to know or care, except
533 to make sure to use the new APIs for headers (test-server is updated to use
534 them already, so look there for examples)
536 The APIs "render" the headers into a user-provided buffer and bump *p as it
537 is used. If *p reaches end, then the APIs return nonzero for error.
539 LWS_VISIBLE LWS_EXTERN int
540 lws_add_http_header_status(struct libwebsocket_context *context,
541 struct libwebsocket *wsi,
546 Start a response header reporting status like 200, 500, etc
548 LWS_VISIBLE LWS_EXTERN int
549 lws_add_http_header_by_name(struct libwebsocket_context *context,
550 struct libwebsocket *wsi,
551 const unsigned char *name,
552 const unsigned char *value,
557 Add a header like name: value in HTTP1.x
559 LWS_VISIBLE LWS_EXTERN int
560 lws_finalize_http_header(struct libwebsocket_context *context,
561 struct libwebsocket *wsi,
565 Finish off the headers, like add the extra \r\n in HTTP1.x
567 LWS_VISIBLE LWS_EXTERN int
568 lws_add_http_header_by_token(struct libwebsocket_context *context,
569 struct libwebsocket *wsi,
570 enum lws_token_indexes token,
571 const unsigned char *value,
576 Add a header by using a lws token as the name part. In HTTP2, this can be
577 compressed to one or two bytes.
583 protocols struct member no_buffer_all_partial_tx is removed. Under some
584 conditions like rewriting extension such as compression in use, the built-in
585 partial send buffering is the only way to deal with the problem, so turning
586 it off is deprecated.
592 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
595 int other_headers_len)
597 If you are providing other headers, they must be generated using the new
598 HTTP-version-agnostic APIs, and you must provide the length of them using this
599 additional parameter.
601 struct lws_context_creation_info now has an additional member
602 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
603 SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
604 lws managing the context, if you memset the struct to 0 or have as a filescope
605 initialized struct in bss, no need to change anything.
608 v1.3-chrome37-firefox30
609 =======================
612 CMakeLists.txt | 447 +++--
616 cmake/LibwebsocketsConfig.cmake.in | 17 +
617 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
618 config.h.cmake | 18 +
619 cross-ming.cmake | 31 +
620 cross-openwrt-makefile | 91 +
621 lib/client-handshake.c | 205 ++-
622 lib/client-parser.c | 58 +-
623 lib/client.c | 158 +-
624 lib/context.c | 341 ++++
625 lib/extension-deflate-frame.c | 2 +-
626 lib/extension.c | 178 ++
627 lib/handshake.c | 287 +---
628 lib/lextable.h | 338 ++++
630 lib/libwebsockets.c | 2089 +++--------------------
631 lib/libwebsockets.h | 253 ++-
632 lib/lws-plat-unix.c | 404 +++++
633 lib/lws-plat-win.c | 358 ++++
634 lib/minilex.c | 530 +++---
635 lib/output.c | 445 ++---
636 lib/parsers.c | 682 ++++----
637 lib/pollfd.c | 239 +++
638 lib/private-libwebsockets.h | 501 +++++-
639 lib/server-handshake.c | 274 +--
640 lib/server.c | 858 ++++++++--
641 lib/service.c | 517 ++++++
643 lib/ssl-http2.c | 78 +
644 lib/ssl.c | 571 +++++++
645 test-server/attack.sh | 101 +-
646 test-server/test-client.c | 9 +-
647 test-server/test-echo.c | 17 +-
648 test-server/test-fraggle.c | 7 -
649 test-server/test-ping.c | 12 +-
650 test-server/test-server.c | 330 ++--
651 test-server/test.html | 4 +-
652 win32port/client/client.vcxproj | 259 ---
653 win32port/client/client.vcxproj.filters | 39 -
654 .../libwebsocketswin32.vcxproj.filters | 93 -
655 win32port/server/server.vcxproj | 276 ---
656 win32port/server/server.vcxproj.filters | 51 -
657 win32port/win32helpers/gettimeofday.h | 59 +-
658 win32port/win32helpers/netdb.h | 1 -
659 win32port/win32helpers/strings.h | 0
660 win32port/win32helpers/sys/time.h | 1 -
661 win32port/win32helpers/unistd.h | 0
662 win32port/win32helpers/websock-w32.c | 104 --
663 win32port/win32helpers/websock-w32.h | 62 -
664 win32port/win32port.sln | 100 --
665 win32port/zlib/gzio.c | 3 +-
666 55 files changed, 6779 insertions(+), 5059 deletions(-)
672 POST method is supported
674 The protocol 0 / HTTP callback can now get two new kinds of callback,
675 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
676 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
677 and been passed to the user code already). These callbacks are used with the
678 post method (see the test server for details).
680 The period between the HTTP header completion and the completion of the body
681 processing is protected by a 5s timeout.
683 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
686 New server option you can enable from user code
687 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
688 also be accepted on an SSL listening port. It's disabled unless you enable
692 Two new callbacks are added in protocols[0] that are optional for allowing
693 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
694 LWS_CALLBACK_UNLOCK_POLL.
696 If you use them, they protect internal and external poll list changes, but if
697 you want to use external thread access to libwebsocket_callback_on_writable()
698 you have to implement your locking here even if you don't use external
701 If you will use another thread for this, take a lot of care about managing
702 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
703 (with your own locking).
705 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
706 eventloop instead of the default poll() one will also be compiled in. But to
707 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
708 creation info struct options member.
710 IPV6 is supported and enabled by default except for Windows, you can disable
711 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
712 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
713 the context creation info struct options member.
715 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
716 guarantee the OS CAs will not be used, even if that support was selected at
719 Optional "token limits" may be enforced by setting the member "token_limits"
720 in struct lws_context_creation_info to point to a struct lws_token_limits.
721 NULL means no token limits used for compatibility.
727 Extra optional argument to libwebsockets_serve_http_file() allows injecion
728 of HTTP headers into the canned response. Eg, cookies may be added like
729 that without getting involved in having to send the header by hand.
731 A new info member http_proxy_address may be used at context creation time to
732 set the http proxy. If non-NULL, it overrides http_proxy environment var.
734 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
735 the client to use the OS CA Roots. If you're worried somebody with the
736 ability to forge for force creation of a client cert from the root CA in
737 your OS, you should disable this since your selfsigned $0 cert is a lot safer
741 v1.23-chrome32-firefox24
742 ========================
745 CMakeLists.txt | 573 ++++++++----
746 COPYING | 503 -----------
747 INSTALL | 365 --------
749 README.build | 371 ++------
750 README.coding | 63 ++
751 autogen.sh | 1578 ---------------------------------
753 cmake/FindGit.cmake | 163 ++++
754 cmake/FindOpenSSLbins.cmake | 15 +-
755 cmake/UseRPMTools.cmake | 176 ++++
756 config.h.cmake | 25 +-
757 configure.ac | 226 -----
758 cross-arm-linux-gnueabihf.cmake | 28 +
759 lib/Makefile.am | 89 --
760 lib/base64-decode.c | 98 +-
761 lib/client-handshake.c | 123 ++-
762 lib/client-parser.c | 19 +-
763 lib/client.c | 145 ++-
764 lib/daemonize.c | 4 +-
765 lib/extension.c | 2 +-
766 lib/getifaddrs.h | 4 +-
767 lib/handshake.c | 76 +-
768 lib/libwebsockets.c | 491 ++++++----
769 lib/libwebsockets.h | 164 ++--
770 lib/output.c | 214 ++++-
771 lib/parsers.c | 102 +--
772 lib/private-libwebsockets.h | 66 +-
773 lib/server-handshake.c | 5 +-
776 libwebsockets-api-doc.html | 249 +++---
777 libwebsockets.pc.in | 11 -
778 libwebsockets.spec | 14 +-
780 scripts/FindLibWebSockets.cmake | 33 +
781 scripts/kernel-doc | 1 +
782 test-server/Makefile.am | 131 ---
783 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
784 test-server/test-client.c | 78 +-
785 test-server/test-echo.c | 33 +-
786 test-server/test-fraggle.c | 26 +-
787 test-server/test-ping.c | 15 +-
788 test-server/test-server.c | 197 +++-
789 test-server/test.html | 5 +-
790 win32port/win32helpers/gettimeofday.c | 74 +-
791 win32port/win32helpers/websock-w32.h | 6 +-
792 48 files changed, 2493 insertions(+), 4212 deletions(-)
798 - You can now call libwebsocket_callback_on_writable() on http connectons,
799 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
800 regulate writes with a websocket protocol connection.
802 - A new member in the context creation parameter struct "ssl_cipher_list" is
803 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
804 default list of ciphers.
806 - Not really an api addition, but libwebsocket_service_fd() will now zero
807 the revents field of the pollfd it was called with if it handled the
808 descriptor. So you can tell if it is a non-lws fd by checking revents
809 after the service call... if it's still nonzero, the descriptor
810 belongs to you and you need to take care of it.
812 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
813 connections with the established protocol. It's designed to be
814 called from user server code when it sees it can accept more input
815 and may have throttled connections using the server rx flow apis
816 while it was unable to accept any other input The user server code
817 then does not have to try to track while connections it choked, this
818 will free up all of them in one call.
820 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
821 called when an HTTP protocol socket closes
823 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
824 has already been done before the callback happens. That means we can
825 use the user parameter to the callback to contain the user pointer, and
826 move the protocol name to the "in" parameter. The docs for this
827 callback are also updated to reflect how to check headers in there.
829 - libwebsocket_client_connect() is now properly nonblocking and async. See
830 README.coding and test-client.c for information on the callbacks you
831 can rely on controlling the async connection period with.
833 - if your OS does not support the http_proxy environment variable convention
834 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
835 to set the proxy details in between context creation and the connection
836 action. For OSes that support http_proxy, that's used automatically.
841 - the external poll callbacks now get the socket descriptor coming from the
842 "in" parameter. The user parameter provides the user_space for the
843 wsi as it normally does on the other callbacks.
844 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
845 delivered by @in now instead of @user.
847 - libwebsocket_write() now returns -1 for error, or the amount of data
848 actually accepted for send. Under load, the OS may signal it is
849 ready to send new data on the socket, but have only a restricted
850 amount of memory to buffer the packet compared to usual.
856 - libwebsocket_ensure_user_space() is removed from the public api, if you
857 were using it to get user_space, you need to adapt your code to only
858 use user_space inside the user callback.
860 - CIPHERS_LIST_STRING is removed
862 - autotools build has been removed. See README.build for info on how to
863 use CMake for your platform
866 v1.21-chrome26-firefox18
867 ========================
869 - Fixes buffer overflow bug in max frame size handling if you used the
870 default protocol buffer size. If you declared rx_buffer_size in your
871 protocol, which is recommended anyway, your code was unaffected.
873 v1.2-chrome26-firefox18
874 =======================
880 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
881 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
884 README.build | 258 ++++++++++++++++++++++++++++++++-----
885 README.coding | 52 ++++++++
886 changelog | 136 ++++++++++++++++++++
887 cmake/FindOpenSSLbins.cmake | 33 +++++
888 config.h.cmake | 173 +++++++++++++++++++++++++
889 configure.ac | 22 +++-
890 lib/Makefile.am | 20 ++-
891 lib/base64-decode.c | 2 +-
892 lib/client-handshake.c | 190 +++++++++++-----------------
893 lib/client-parser.c | 88 +++++++------
894 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
895 lib/daemonize.c | 32 +++--
896 lib/extension-deflate-frame.c | 58 +++++----
897 lib/extension-deflate-stream.c | 19 ++-
898 lib/extension-deflate-stream.h | 4 +-
899 lib/extension.c | 11 +-
900 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
901 lib/getifaddrs.h | 30 ++---
902 lib/handshake.c | 124 +++++++++++-------
903 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
904 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
905 lib/output.c | 192 +++++++++++-----------------
906 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
907 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
908 lib/server-handshake.c | 82 ++++++------
909 lib/server.c | 96 +++++++-------
910 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
911 libwebsockets.spec | 17 +--
912 test-server/attack.sh | 148 ++++++++++++++++++++++
913 test-server/test-client.c | 125 +++++++++---------
914 test-server/test-echo.c | 31 +++--
915 test-server/test-fraggle.c | 32 ++---
916 test-server/test-ping.c | 52 ++++----
917 test-server/test-server.c | 129 ++++++++++++-------
918 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
919 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
920 41 files changed, 4398 insertions(+), 2219 deletions(-)
926 - lws_get_library_version() returns a const char * with a string like
927 "1.1 9e7f737", representing the library version from configure.ac
928 and the git HEAD hash the library was built from
930 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
931 also with controllable timeout, number of probes and probe interval.
932 (On BSD type OS, you can only use system default settings for the
933 timing and retries, although enabling it is supported by setting
934 ka_time to nonzero, the exact value has no meaning.)
935 This enables detection of idle connections which are logically okay,
936 but are in fact dead, due to network connectivity issues at the server,
937 client, or any intermediary. By default it's not enabled, but you
938 can enable it by setting a non-zero timeout (in seconds) at the new
939 ka_time member at context creation time.
941 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
942 is called one-time per protocol as the context is being destroyed, and
943 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
944 and the protocols are added, again it's a one-time affair.
945 This lets you manage per-protocol allocations properly including
946 cleaning up after yourself when the server goes down.
951 - libwebsocket_create_context() has changed from taking a ton of parameters
952 to just taking a pointer to a struct containing the parameters. The
953 struct lws_context_creation_info is in libwebsockets.h, the members
954 are in the same order as when they were parameters to the call
955 previously. The test apps are all updated accordingly so you can
956 see example code there.
958 - Header tokens are now deleted after the websocket connection is
959 established. Not just the header data is saved, but the pointer and
960 length array is also removed from (union) scope saving several hundred
961 bytes per connection once it is established
963 - struct libwebsocket_protocols has a new member rx_buffer_size, this
964 controls rx buffer size per connection of that protocol now. Sources
965 for apps built against older versions of the library won't declare
966 this in their protocols, defaulting it to 0. Zero buffer is legal,
967 it causes a default buffer to be allocated (currently 4096)
969 If you want to receive only atomic frames in your user callback, you
970 should set this to greater than your largest frame size. If a frame
971 comes that exceeds that, no error occurs but the callback happens as
972 soon as the buffer limit is reached, and again if it is reached again
973 or the frame completes. You can detect that has happened by seeing
974 there is still frame content pending using
975 libwebsockets_remaining_packet_payload()
977 By correctly setting this, you can save a lot of memory when your
978 protocol has small frames (see the test server and client sources).
980 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
981 header payload lws can cope with, that includes the GET URL, origin
982 etc. Headers not understood by lws are ignored and their payload
983 not included in this.
989 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
990 buffer size chosen per-protocol. For compatibility, there's a default
991 of 4096 rx buffer, but user code should set the appropriate size for
994 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
995 and have been removed. There's a new header management scheme that
996 handles them in a much more compact way.
998 - libwebsockets_hangup_on_client() is removed. If you want to close the
999 connection you must do so from the user callback and by returning
1002 - libwebsocket_close_and_free_session() is now private to the library code
1003 only and not exposed for user code. If you want to close the
1004 connection, you must do so from the user callback by returning -1
1011 - Cmake project file added, aimed initially at Windows support: this replaces
1012 the visual studio project files that were in the tree until now.
1014 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1016 - PATH_MAX or MAX_PATH no longer needed
1018 - cutomizable frame rx buffer size by protocol
1020 - optional TCP keepalive so dead peers can be detected, can be enabled at
1021 context-creation time
1023 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1024 lost at OpenSSL library init and symptomless reports of uninitialized
1025 memory usage... seems to be a known and ignored problem at OpenSSL
1027 - By default debug is enabled and the library is built for -O0 -g to faclitate
1028 that. Use --disable-debug configure option to build instead with -O4
1029 and no -g (debug info), obviously providing best performance and
1030 reduced binary size.
1032 - 1.0 introduced some code to try to not deflate small frames, however this
1033 seems to break when confronted with a mixture of frames above and
1034 below the threshold, so it's removed. Veto the compression extension
1035 in your user callback if you will typically have very small frames.
1037 - There are many memory usage improvements, both a reduction in malloc/
1038 realloc and architectural changes. A websocket connection now
1039 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1040 during header processing an additional 1262 bytes is allocated in a
1041 single malloc, but is freed when the websocket connection starts.
1042 The RX frame buffer defined by the protocol in user
1043 code is also allocated per connection, this represents the largest
1044 frame you can receive atomically in that protocol.
1046 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1047 and 112 bytes per connection (+1328 only during header processing)
1050 v1.1-chrome26-firefox18
1051 =======================
1057 README-test-server | 291 ---
1058 README.build | 239 ++
1059 README.coding | 138 ++
1061 README.test-apps | 272 +++
1062 configure.ac | 116 +-
1063 lib/Makefile.am | 55 +-
1064 lib/base64-decode.c | 5 +-
1065 lib/client-handshake.c | 121 +-
1066 lib/client-parser.c | 394 ++++
1067 lib/client.c | 807 +++++++
1068 lib/daemonize.c | 212 ++
1069 lib/extension-deflate-frame.c | 132 +-
1070 lib/extension-deflate-stream.c | 12 +-
1071 lib/extension-x-google-mux.c | 1223 ----------
1072 lib/extension-x-google-mux.h | 96 -
1073 lib/extension.c | 8 -
1074 lib/getifaddrs.c | 271 +++
1075 lib/getifaddrs.h | 76 +
1076 lib/handshake.c | 582 +----
1077 lib/libwebsockets.c | 2493 ++++++---------------
1078 lib/libwebsockets.h | 115 +-
1080 lib/minilex.c | 440 ++++
1081 lib/output.c | 628 ++++++
1082 lib/parsers.c | 2016 +++++------------
1083 lib/private-libwebsockets.h | 284 +--
1084 lib/server-handshake.c | 275 +++
1085 lib/server.c | 377 ++++
1086 libwebsockets-api-doc.html | 300 +--
1088 test-server/Makefile.am | 111 +-
1089 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1090 test-server/test-client.c | 45 +-
1091 test-server/test-echo.c | 330 +++
1092 test-server/test-fraggle.c | 20 +-
1093 test-server/test-ping.c | 22 +-
1094 test-server/test-server-extpoll.c | 554 -----
1095 test-server/test-server.c | 349 ++-
1096 test-server/test.html | 3 +-
1097 win32port/zlib/ZLib.vcxproj | 749 ++++---
1098 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1099 win32port/zlib/adler32.c | 348 ++-
1100 win32port/zlib/compress.c | 160 +-
1101 win32port/zlib/crc32.c | 867 ++++----
1102 win32port/zlib/crc32.h | 882 ++++----
1103 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1104 win32port/zlib/deflate.h | 688 +++---
1105 win32port/zlib/gzclose.c | 50 +-
1106 win32port/zlib/gzguts.h | 325 ++-
1107 win32port/zlib/gzlib.c | 1157 +++++-----
1108 win32port/zlib/gzread.c | 1242 ++++++-----
1109 win32port/zlib/gzwrite.c | 1096 +++++----
1110 win32port/zlib/infback.c | 1272 ++++++-----
1111 win32port/zlib/inffast.c | 680 +++---
1112 win32port/zlib/inffast.h | 22 +-
1113 win32port/zlib/inffixed.h | 188 +-
1114 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1115 win32port/zlib/inflate.h | 244 +-
1116 win32port/zlib/inftrees.c | 636 +++---
1117 win32port/zlib/inftrees.h | 124 +-
1118 win32port/zlib/trees.c | 2468 +++++++++++----------
1119 win32port/zlib/trees.h | 256 +--
1120 win32port/zlib/uncompr.c | 118 +-
1121 win32port/zlib/zconf.h | 934 ++++----
1122 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1123 win32port/zlib/zutil.c | 642 +++---
1124 win32port/zlib/zutil.h | 526 ++---
1125 69 files changed, 19556 insertions(+), 20145 deletions(-)
1130 - libwebsockets_serve_http_file() now takes a context as first argument
1132 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1139 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1140 may be used also by user code
1142 - lws_set_log_level() set which logging apis are able to emit (defaults to
1143 notice, warn, err severities), optionally set the emit callback
1145 - lwsl_emit_syslog() helper callback emits to syslog
1147 - lws_daemonize() helper code that forks the app into a headless daemon
1148 properly, maintains a lock file with pid in suitable for sysvinit etc to
1151 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1152 transfer is now asynchronous (see test server code)
1154 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1155 data was sent in BINARY mode
1161 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1162 arrange your code to act from the user callback instead from same
1163 process context as the service loop
1165 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1166 instead from same process context as the service loop. See the test apps
1169 - x-google-mux() removed until someone wants it
1171 - pre -v13 (ancient) protocol support removed
1177 - echo test server and client compatible with echo.websocket.org added
1179 - many new configure options (see README.build) to reduce footprint of the
1180 library to what you actually need, eg, --without-client and
1183 - http + websocket server can build to as little as 12K .text for ARM
1185 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1186 allowed to the process by ulimit, defaults to 1024 on Fedora and
1187 Ubuntu. Use ulimit to control this without needing to configure
1188 the library. Code here is smaller and faster.
1190 - adaptive ratio of listen socket to connection socket service allows
1191 good behaviour under Apache ab test load. Tested with thousands
1192 of simultaneous connections
1194 - reduction in per-connection memory footprint by moving to a union to hold
1195 mutually-exclusive state for the connection
1197 - robustness: Out of Memory taken care of for all allocation code now
1199 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1201 - configurable memory limit for deflate operations
1203 - improvements in SSL code nonblocking operation, possible hang solved,
1204 some SSL operations broken down into pollable states so there is
1205 no library blocking, timeout coverage for SSL_connect
1207 - extpoll test server merged into single test server source
1209 - robustness: library should deal with all recoverable socket conditions
1211 - rx flowcontrol for backpressure notification fixed and implmeneted
1212 correctly in the test server
1214 - optimal lexical parser added for header processing; all headers in a
1215 single 276-byte state table
1217 - latency tracking api added (configure --with-latency)
1219 - Improved in-tree documentation, REAME.build, README.coding,
1220 README.test-apps, changelog
1225 v1.0-chrome25-firefox17 (6cd1ea9b005933f)