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