v1.7.9
[platform/upstream/libwebsockets.git] / changelog
1 Changelog
2 ---------
3
4 v1.7.9
5 ======
6
7 NB: lws_snprintf() added, but only used in library and test apps
8 SONAME bump to 7.1
9
10 Fixes:
11
12 1) Fix leak caused by undestroyed pthread mutex
13
14 2) Add CLIENT_CONNECTION_ERROR callbacks for more failure paths
15
16 3) Fix for client close to callback on one error path 
17
18 4) lws_snprintf() needed in a couple of test apps (1.7.x lib doesn't use it
19 for aggregated buffer truncation)
20
21
22 v1.7.8
23 ======
24
25 NB: No API change since v1.7.0
26
27 Fixes:
28
29 1) MINOR: user_space arg was mistakenly NULL on LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER
30
31 2) MINOR: treating recv() returning 0 as peer close destroyed throughput on ab
32 tests, reverted
33
34 3) MINOR: %3d on URL part was always turned to _... this should only happen in
35 ?na%3dme=x part of the URL
36
37 4) MINOR: some malloc escaped check for NULL / OOM
38
39
40 v1.7.7
41 ======
42
43 NB: No API change since v1.7.0
44
45 Fixes:
46
47 1) MINOR: Android add needed include file
48
49 2) MINOR: Allow build on GCC < 3.4
50
51 3) MINOR: Fix client problems recovering cleanly from SSL negotiation failure
52
53
54 v1.7.6
55 ======
56
57 NB: No API change since v1.7.0
58
59 Fixes
60 -----
61
62 1) MINOR: libuv-specific fixes
63
64 2) MINOR: urldecode forbids malformed %xx in the library 
65
66 3) MINOR: small fixes for Android and Windows
67
68 4) MINOR: handle 0 read() as closed connection
69
70
71 v1.7.5
72 ======
73
74 NB: No API change since v1.7.0
75
76 Fixes
77 -----
78
79 1) MINOR: fix build with musl C library
80
81 2) MINOR: libuv handle signals only if requested
82
83 3) MINOR: Fix compile warning if HTTP2 + RELEASE + ALPN-capable SSL
84
85 4) MINOR: produce and package
86           %{_libdir}/cmake/libwebsockets/LibwebsocketsTargets.cmake
87
88 5) MAJOR: make permessage-deflate enforce protocol rx buffer size requirement
89
90
91 v1.7.4
92 ======
93
94 NB: No API change since v1.7.0
95
96 Fixes
97 -----
98
99 1) MINOR: don't send ext hdr if no exts to discuss
100
101 2) MINOR: libuv + libev small fixes
102
103 3) MINOR: some windows build environments have no snprintf
104
105 4) MINOR: cmake adapts better to ecdh.h cmake situation
106
107 5) MINOR: client missed WSI_CREATE callback
108
109 6) MINOR: base64 decode api worked fine for all ws key handling, however
110 it was broken for some general decode if user code wanted to use it.
111
112 7) MINOR: add optimized parsing path for bulk incoming ws data
113
114
115 v1.7.3
116 ======
117
118 NB: No API change since v1.7.0
119
120 Fixes
121 -----
122
123 1) MAJOR connections on ah waiting list that closed did not get removed from
124 the waiting list...
125
126 2) MAJOR since we added the ability to hold an ah across http keepalive
127 transactions where more headers had already arrived, we broke the ability
128 to tell if more headers had arrived.  Result was if the browser didn't
129 close the keepalive, we retained ah for the lifetime of the keepalive,
130 using up the pool.
131
132 3) MAJOR windows-only-POLLHUP was not coming
133
134 4) Fix build on NetBSD
135
136
137 v1.7.2
138 ======
139
140 NB: No API change since v1.7.0
141
142 Fixes
143 -----
144
145 1) libuv one-per-session valgrind leak fixed
146
147 2) MINOR An error about hdr struct in _lws_ws_related is corrected, it's not
148 known to affect anything added until after it was fixed
149
150 3) MINOR During the close shutdown wait state introduced at v1.7, if something
151 requests callback on writeable for the socket it will busywait until the
152 socket closes
153
154 4) MINOR update URLs in test html for libwebsockets.org https STS changes
155
156 Changes
157 -------
158
159 1) test server html is updated with tabs and a new live server monitoring
160 feature.  Input sanitization added to the js.
161
162
163 v1.7.1
164 ======
165
166 NB: No API change since v1.7.0
167
168 Fixes
169 -----
170
171 1) MAJOR (Windows-only) fix assert firing
172
173 2) MAJOR http:/1.1 connections handled by  lws_return_http_status() did not
174 get sent a content-length resulting in the link hanging until the peer closed
175 it.  attack.sh updated to add a test for this.
176
177
178 Changes
179 -------
180
181 1) MINOR test-server gained some new switches
182
183    -C <file>  use external SSL cert file
184    -K <file>  use external SSL key file
185    -A <file>  use external SSL CA cert file
186    
187    -u <uid>  set effective uid
188    -g <gid>  set effective gid
189
190 together you can use them like this to have the test-server work with the
191 usual purchased SSL certs from an official CA.
192
193    --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
194
195 2) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
196 library, and the ciphers restricted to use ECDH only.
197 Using this, the lws test server can score an A at SSLLABS test
198
199 3) MINOR STS (SSL always) header is added to the test server if you use --ssl.  With
200 that, we score A+ at SSLLABS test
201
202 4) MINOR daemonize function (disabled at cmake by default) is updated to work
203 with systemd
204
205 5) MINOR example systemd .service file now provided for test server
206 (not installed by default)
207
208
209 v1.7.0
210 ======
211
212 Extension Changes
213 -----------------
214
215 1) There is now a "permessage-deflate" / RFC7692 implementation.  It's very
216 similar to "deflate-frame" we have offered for a long while; deflate-frame is
217 now provided as an alias of permessage-deflate.
218
219 The main differences are that the new permessage-deflate implementation:
220
221  - properly performs streaming respecting input and output buffer limits.  The
222    old deflate-frame implementation could only work on complete deflate input
223    and produce complete inflate output for each frame.  The new implementation
224    only mallocs buffers at initialization.
225
226  - goes around the event loop after each input package is processed allowing
227    interleaved output processing.  The RX flow control api can be used to
228    force compressed input processing to match the rate of compressed output
229    processing (test--echo shows an example of how to do this).
230
231  - when being "deflate-frame" for compatibility he uses the same default zlib
232    settings as the old "deflate-frame", but instead of exponentially increasing
233    malloc allocations until the whole output will fit, he observes the default
234    input and output chunking buffer sizes of "permessage-deflate", that's
235    1024 in and 1024 out at a time.
236
237 2) deflate-stream has been disabled for many versions (for over a year) and is
238 now removed.  Browsers are now standardizing on "permessage-deflate" / RFC7692
239
240 3) struct lws_extension is simplified, and lws extensions now have a public
241 api (their callback) for use in user code to compose extensions and options
242 the user code wants.  lws_get_internal_exts() is deprecated but kept around
243 as a NOP.  The changes allow one extension implementation to go by different
244 names and allows the user client code to control option offers per-ext.
245
246 The test client and server are updated to use the new way.  If you use
247 the old way it should still work, but extensions will be disabled until you
248 update your code.
249
250 Extensions are now responsible for allocating and per-instance private struct
251 at instance construction time and freeing it when the instance is destroyed.
252 Not needing to know the size means the extension's struct can be opaque
253 to user code.
254
255
256 User api additions
257 ------------------
258
259 1) The info struct gained three new members
260
261  - max_http_header_data: 0 for default (1024) or set the maximum amount of known
262     http header payload that lws can deal with.  Payload in unknown http
263     headers is dropped silently.  If for some reason you need to send huge
264     cookies or other HTTP-level headers, you can now increase this at context-
265     creation time.
266
267  - max_http_header_pool: 0 for default (16) or set the maximum amount of http
268      headers that can be tracked by lws in this context.  For the server, if
269      the header pool is completely in use then accepts on the listen socket
270      are disabled until one becomes free.  For the client, if you simultaneously
271      have pending connects for more than this number of client connections,
272      additional connects will fail until some of the pending connections timeout
273      or complete.
274
275  - timeout_secs: 0 for default (currently 20s), or set the library's
276      network activity timeout to the given number of seconds
277
278 HTTP header processing in lws only exists until just after the first main
279 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
280 for HTTP connections the HTTP callback.
281
282 So these settings are not related to the maximum number of simultaneous
283 connections, but the number of HTTP handshakes that may be expected or ongoing,
284 or have just completed, at one time.  The reason it's useful is it changes the
285 memory allocation for header processing to be one-time at context creation
286 instead of every time there is a new connection, and gives you control over
287 the peak allocation.
288
289 Setting max_http_header_pool to 1 is fine it will just queue incoming
290 connections before the accept as necessary, you can still have as many
291 simultaneous post-header connections as you like.  Since the http header
292 processing is completed and the allocation released after ESTABLISHED or the
293 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
294
295 2) There is a new callback that allows the user code to get acccess to the
296 optional close code + aux data that may have been sent by the peer.
297
298 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
299              The peer has sent an unsolicited Close WS packet.  @in and
300              @len are the optional close code (first 2 bytes, network
301              order) and the optional additional information which is not
302              defined in the standard, and may be a string or non-human-
303              readble data.
304              If you return 0 lws will echo the close and then close the
305              connection.  If you return nonzero lws will just close the
306              connection.
307
308 As usual not handling it does the right thing, if you're not interested in it
309 just ignore it.
310
311 The test server has "open and close" testing buttons at the bottom, if you
312 open and close that connection, on close it will send a close code 3000 decimal
313 and the string "Bye!" as the aux data.
314
315 The test server dumb-increment callback handles this callback reason and prints
316
317 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
318 lwsts[15714]:  0: 0x0B
319 lwsts[15714]:  1: 0xB8
320 lwsts[15714]:  2: 0x42
321 lwsts[15714]:  3: 0x79
322 lwsts[15714]:  4: 0x65
323 lwsts[15714]:  5: 0x21
324
325 3) There is a new API to allow the user code to control the content of the
326 close frame sent when about to return nonzero from the user callback to
327 indicate the connection should close.
328
329 /**
330  * lws_close_reason - Set reason and aux data to send with Close packet
331  *              If you are going to return nonzero from the callback
332  *              requesting the connection to close, you can optionally
333  *              call this to set the reason the peer will be told if
334  *              possible.
335  *
336  * @wsi:        The websocket connection to set the close reason on
337  * @status:     A valid close status from websocket standard
338  * @buf:        NULL or buffer containing up to 124 bytes of auxiliary data
339  * @len:        Length of data in @buf to send
340  */
341 LWS_VISIBLE LWS_EXTERN void
342 lws_close_reason(struct lws *wsi, enum lws_close_status status,
343                  unsigned char *buf, size_t len);
344
345 An extra button is added to the "open and close" test server page that requests
346 that the test server close the connection from his end.
347
348 The test server code will do so by
349
350                         lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
351                                          (unsigned char *)"seeya", 5);
352                         return -1;
353
354 The browser shows the close code and reason he received
355
356 websocket connection CLOSED, code: 1001, reason: seeya
357
358 4) There's a new context creation time option flag
359
360 LWS_SERVER_OPTION_VALIDATE_UTF8
361
362 if you set it in info->options, then TEXT and CLOSE frames will get checked to
363 confirm that they contain valid UTF-8.  If they don't, the connection will get
364 closed by lws.
365
366 5) ECDH Certs are now supported.  Enable the CMake option
367
368 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1 
369
370 **and** the info->options flag
371
372 LWS_SERVER_OPTION_SSL_ECDH
373
374 to build in support and select it at runtime.
375
376 6) There's a new api lws_parse_uri() that simplifies chopping up
377 https://xxx:yyy/zzz uris into parts nicely.  The test client now uses this
378 to allow proper uris as well as the old address style.
379
380 7) SMP support is integrated into LWS without any internal threading.  It's
381 very simple to use, libwebsockets-test-server-pthread shows how to do it,
382 use -j <n> argument there to control the number of service threads up to 32.
383
384 Two new members are added to the info struct
385
386         unsigned int count_threads;
387         unsigned int fd_limit_per_thread;
388         
389 leave them at the default 0 to get the normal singlethreaded service loop.
390
391 Set count_threads to n to tell lws you will have n simultaneous service threads
392 operating on the context.
393
394 There is still a single listen socket on one port, no matter how many
395 service threads.
396
397 When a connection is made, it is accepted by the service thread with the least
398 connections active to perform load balancing.
399
400 The user code is responsible for spawning n threads running the service loop
401 associated to a specific tsi (Thread Service Index, 0 .. n - 1).  See
402 the libwebsockets-test-server-pthread for how to do.
403
404 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
405 between the service threads; if you process was allowed 1024 fds overall then
406 each thread is limited to 1024 / n.
407
408 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
409 the overall supported fd limit is less than the process allowance.
410
411 You can control the context basic data allocation for multithreading from Cmake
412 using -DLWS_MAX_SMP=, if not given it's set to 32.  The serv_buf allocation
413 for the threads (currently 4096) is made at runtime only for active threads.
414
415 Because lws will limit the requested number of actual threads supported
416 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
417 discover how many threads were actually allowed when the context was created.
418
419 It's required to implement locking in the user code in the same way that
420 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
421
422 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
423 library.  If more than 1, a small amount of pthread mutex code is built into
424 the library.
425
426 8) New API
427
428 LWS_VISIBLE struct lws *
429 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
430
431 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
432 had just been accepted by lws' own listen socket.
433
434 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
435
436 10) Libuv support is added, there are new related user apis
437
438 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
439
440 LWS_VISIBLE LWS_EXTERN int
441 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
442                   lws_uv_signal_cb_t *cb);
443
444 LWS_VISIBLE LWS_EXTERN int
445 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
446
447 LWS_VISIBLE void
448 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
449
450 and CMAKE option
451
452 LWS_WITH_LIBUV
453
454
455 User api changes
456 ----------------
457
458 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated.  You can remove it; if
459 you still use it, obviously it does nothing.  Old binary code with nonzero
460 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
461 allocated a buffer bigger than the library is going to use.
462
463 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
464
465 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
466
467 2) Because of lws_close_reason() formalizing handling close frames,
468 LWS_WRITE_CLOSE is removed from libwebsockets.h.  It was only of use to send
469 close frames...close frame content should be managed using lws_close_reason()
470 now.
471
472 3) We check for invalid CLOSE codes and complain about protocol violation in
473 our close code.  But it changes little since we were in the middle of closing
474 anyway.
475
476 4) zero-length RX frames and zero length TX frames are now allowed.
477
478 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
479 so that is now also allowed.
480
481 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
482 valid to use now.
483
484 7) There's generic support for RFC7462 style extension options built into the
485 library now.  As a consequence, a field "options" is added to lws_extension.
486 It can be NULL if there are no options on the extension.  Extension internal
487 info is part of the public abi because extensions may be implemented outside
488 the library.
489
490 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
491 of value 73.  That's now corrected and WSI_TOKEN_PROXY moved to his own place at
492 77.
493
494 9) With the addition of libuv support, libev is not the only event loop
495 library in town and his api names must be elaborated with _ev_
496
497   Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
498   lws_sigint_cfg --> lws_ev_sigint_cfg
499   lws_initloop --> lws_ev_initloop
500   lws_sigint_cb --> lws_ev_sigint_cb
501
502 10) Libev support is made compatible with multithreaded service,
503 lws_ev_initloop (was lws_initloop) gets an extra argument for the
504 thread service index (use 0 if you will just have 1 service thread).
505
506 LWS_VISIBLE LWS_EXTERN int
507 lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
508
509
510 v1.6.0-chrome48-firefox42
511 =======================
512
513 Major API improvements
514 ----------------------
515
516 v1.6.0 has many cleanups and improvements in the API.  Although at first it
517 looks pretty drastic, user code will only need four actions to update it.
518
519  - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
520    /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
521
522  - Remove the context parameter from your user callbacks
523
524  - Remove context as the first parameter from the "Eleven APIS" listed in the
525    User Api Changes section
526
527  - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
528    in the User Api Changes section, and anywhere else you still need context
529
530 That's it... generally only a handful of the 14 affected APIs are actually in
531 use in your user code and you can find them quickest by compiling and visiting
532 the errors each in turn.  And the end results are much cleaner, more
533 predictable and maintainable.
534
535
536 User api additions
537 ------------------
538
539 1) lws now exposes his internal platform file abstraction in a way that can be
540 both used by user code to make it platform-agnostic, and be overridden or
541 subclassed by user code.  This allows things like handling the URI "directory
542 space" as a virtual filesystem that may or may not be backed by a regular
543 filesystem.  One example use is serving files from inside large compressed
544 archive storage without having to unpack anything except the file being
545 requested.
546
547 The test server shows how to use it, basically the platform-specific part of
548 lws prepares a file operations structure that lives in the lws context.
549
550 Helpers are provided to also leverage these platform-independent file handling
551 apis
552
553 static inline lws_filefd_type
554 lws_plat_file_open(struct lws *wsi, const char *filename,
555                    unsigned long *filelen, int flags)
556 static inline int
557 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
558
559 static inline unsigned long
560 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
561
562 static inline int
563 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
564                    unsigned char *buf, unsigned long len)
565
566 static inline int
567 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
568                     unsigned char *buf, unsigned long len)
569                     
570 The user code can also override or subclass the file operations, to either
571 wrap or replace them.  An example is shown in test server.
572
573 A wsi can be associated with the file activity, allowing per-connection
574 authentication and state to be used when interpreting the file request.
575
576 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
577 the user data associated with the wsi, just from the wsi.
578
579 3) URI argument handling.  Libwebsockets parses and protects URI arguments
580 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
581 path attacks like ../.../../etc/passwd so they cannot go behind the web
582 server's /.  There is a list of confirmed attacks we're proof against in
583 ./test-server/attack.sh.
584
585 There is a new API lws_hdr_copy_fragment that should be used now to access
586 the URI arguments (it returns the fragments length)
587
588                while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
589                                             WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
590                        lwsl_info("URI Arg %d: %s\n", ++n, buf);
591                }
592
593 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
594 All legal uriencodings will have been reduced in those strings.
595
596 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
597 possible to deal with arguments containing %00.  If you don't care about that,
598 the returned string has '\0' appended to simplify processing.
599
600
601 User api changes
602 ----------------
603
604 1) Three APIS
605
606  - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
607  - lws_callback_all_protocol(const struct lws_protocols *protocol)
608  - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
609
610 Now take an additional pointer to the lws_context in their first argument.
611
612 The reason for this change is struct lws_protocols has been changed to remove
613 members that lws used for private storage: so the protocols struct in now
614 truly const and may be reused serially or simultaneously by different contexts.
615
616 2) Eleven APIs
617
618 LWS_VISIBLE LWS_EXTERN int
619 lws_add_http_header_by_name(struct lws_context *context,
620                 struct lws *wsi,
621                 const unsigned char *name,
622                 const unsigned char *value,
623                 int length,
624                 unsigned char **p,
625                 unsigned char *end);
626 LWS_VISIBLE LWS_EXTERN int
627 lws_finalize_http_header(struct lws_context *context,
628              struct lws *wsi,
629              unsigned char **p,
630              unsigned char *end);
631 LWS_VISIBLE LWS_EXTERN int
632 lws_add_http_header_by_token(struct lws_context *context,
633                  struct lws *wsi,
634                  enum lws_token_indexes token,
635                  const unsigned char *value,
636                  int length,
637                  unsigned char **p,
638                  unsigned char *end);
639 LWS_VISIBLE LWS_EXTERN int
640 lws_add_http_header_content_length(struct lws_context *context,
641                    struct lws *wsi,
642                    unsigned long content_length,
643                    unsigned char **p,
644                    unsigned char *end);
645 LWS_VISIBLE LWS_EXTERN int
646 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
647                unsigned int code, unsigned char **p,
648                unsigned char *end);
649
650 LWS_VISIBLE LWS_EXTERN int
651 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
652             const char *file, const char *content_type,
653             const char *other_headers, int other_headers_len);
654 LWS_VISIBLE LWS_EXTERN int
655 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
656
657 LWS_VISIBLE LWS_EXTERN int
658 lws_return_http_status(struct lws_context *context, struct lws *wsi,
659                unsigned int code, const char *html_body);
660
661 LWS_VISIBLE LWS_EXTERN int
662 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
663
664 LWS_VISIBLE LWS_EXTERN void
665 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
666                lws_sockfd_type fd, char *name, int name_len,
667                char *rip, int rip_len);
668
669 LWS_VISIBLE LWS_EXTERN int
670 lws_read(struct lws_context *context, struct lws *wsi,
671      unsigned char *buf, size_t len); 
672
673 no longer require their initial struct lws_context * parameter.
674
675 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
676 all begin lws_.  These apis have been changed to all begin with lws_.
677
678 To convert, search-replace
679
680  - libwebsockets_/lws_
681  - libwebsocket_/lws_
682  - struct\ libwebsocket/struct\ lws
683  
684 4) context parameter removed from user callback.
685
686 Since almost all apis no longer need the context as a parameter, it's no longer
687 provided at the user callback directly.
688
689 However if you need it, for ALL callbacks wsi is valid and has a valid context
690 pointer you can recover using lws_get_context(wsi).
691
692
693 v1.5-chrome47-firefox41
694 =======================
695
696 User api changes
697 ----------------
698
699 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
700 non-NULL.  If so, the string has length len.
701
702 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
703 for peer certs if you are using the option to require client certs.
704
705 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
706 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
707
708
709 v1.4-chrome43-firefox36
710 =======================
711
712 User api additions
713 ------------------
714
715 There's a new member in the info struct used to control context creation,
716 ssl_private_key_password, which allows passing into lws the passphrase on
717 an SSL cetificate
718
719 There's a new member in struct protocols, id, which is ignored by lws but can
720 be used by the user code to mark the selected protocol by user-defined version
721 or capabliity flag information, for the case multiple versions of a protocol are
722 supported.
723
724 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
725 over ssl or not.  If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
726 ssl and non-ssl connections are possible and may need to be treated differently
727 in the user code.
728
729 int lws_partial_buffered(wsi) added... should be checked after any
730 libwebsocket_write that will be followed by another libwebsocket_write inside
731 the same writeable callback.  If set, you can't do any more writes until the
732 writeable callback is called again.  If you only do one write per writeable callback,
733 you can ignore this.
734
735 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
736 agnositic header creation APIs.  These do the right thing depending on each
737 connection's HTTP version without the user code having to know or care, except
738 to make sure to use the new APIs for headers (test-server is updated to use
739 them already, so look there for examples)
740
741 The APIs "render" the headers into a user-provided buffer and bump *p as it
742 is used.  If *p reaches end, then the APIs return nonzero for error.
743
744 LWS_VISIBLE LWS_EXTERN int
745 lws_add_http_header_status(struct libwebsocket_context *context,
746                             struct libwebsocket *wsi,
747                             unsigned int code,
748                             unsigned char **p,
749                             unsigned char *end);
750
751 Start a response header reporting status like 200, 500, etc
752
753 LWS_VISIBLE LWS_EXTERN int
754 lws_add_http_header_by_name(struct libwebsocket_context *context,
755                             struct libwebsocket *wsi,
756                             const unsigned char *name,
757                             const unsigned char *value,
758                             int length,
759                             unsigned char **p,
760                             unsigned char *end);
761
762 Add a header like name: value in HTTP1.x
763
764 LWS_VISIBLE LWS_EXTERN int 
765 lws_finalize_http_header(struct libwebsocket_context *context,
766                             struct libwebsocket *wsi,
767                             unsigned char **p,
768                             unsigned char *end);
769
770 Finish off the headers, like add the extra \r\n in HTTP1.x
771
772 LWS_VISIBLE LWS_EXTERN int
773 lws_add_http_header_by_token(struct libwebsocket_context *context,
774                             struct libwebsocket *wsi,
775                             enum lws_token_indexes token,
776                             const unsigned char *value,
777                             int length,
778                             unsigned char **p,
779                             unsigned char *end);
780
781 Add a header by using a lws token as the name part.  In HTTP2, this can be
782 compressed to one or two bytes.
783
784
785 User api removal
786 ----------------
787
788 protocols struct member no_buffer_all_partial_tx is removed.  Under some
789 conditions like rewriting extension such as compression in use, the built-in
790 partial send buffering is the only way to deal with the problem, so turning
791 it off is deprecated.
792
793
794 User api changes
795 ----------------
796
797 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
798 the end now
799
800 int other_headers_len)
801
802 If you are providing other headers, they must be generated using the new
803 HTTP-version-agnostic APIs, and you must provide the length of them using this
804 additional parameter.
805
806 struct lws_context_creation_info now has an additional member
807 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
808 SSL_CTX managed outside lws.  Defaulting to zero keeps the existing behaviour of
809 lws managing the context, if you memset the struct to 0 or have as a filescope
810 initialized struct in bss, no need to change anything.
811
812
813 v1.3-chrome37-firefox30
814 =======================
815
816  .gitignore                                               |    1 -
817  CMakeLists.txt                                           |  447 +++--
818  README.build                                             |   35 +-
819  README.coding                                            |   14 +
820  changelog                                                |   66 +
821  cmake/LibwebsocketsConfig.cmake.in                       |   17 +
822  cmake/LibwebsocketsConfigVersion.cmake.in                |   11 +
823  config.h.cmake                                           |   18 +
824  cross-ming.cmake                                         |   31 +
825  cross-openwrt-makefile                                   |   91 +
826  lib/client-handshake.c                                   |  205 ++-
827  lib/client-parser.c                                      |   58 +-
828  lib/client.c                                             |  158 +-
829  lib/context.c                                            |  341 ++++
830  lib/extension-deflate-frame.c                            |    2 +-
831  lib/extension.c                                          |  178 ++
832  lib/handshake.c                                          |  287 +---
833  lib/lextable.h                                           |  338 ++++
834  lib/libev.c                                              |  175 ++
835  lib/libwebsockets.c                                      | 2089 +++--------------------
836  lib/libwebsockets.h                                      |  253 ++-
837  lib/lws-plat-unix.c                                      |  404 +++++
838  lib/lws-plat-win.c                                       |  358 ++++
839  lib/minilex.c                                            |  530 +++---
840  lib/output.c                                             |  445 ++---
841  lib/parsers.c                                            |  682 ++++----
842  lib/pollfd.c                                             |  239 +++
843  lib/private-libwebsockets.h                              |  501 +++++-
844  lib/server-handshake.c                                   |  274 +--
845  lib/server.c                                             |  858 ++++++++--
846  lib/service.c                                            |  517 ++++++
847  lib/sha-1.c                                              |   38 +-
848  lib/ssl-http2.c                                          |   78 +
849  lib/ssl.c                                                |  571 +++++++
850  test-server/attack.sh                                    |  101 +-
851  test-server/test-client.c                                |    9 +-
852  test-server/test-echo.c                                  |   17 +-
853  test-server/test-fraggle.c                               |    7 -
854  test-server/test-ping.c                                  |   12 +-
855  test-server/test-server.c                                |  330 ++--
856  test-server/test.html                                    |    4 +-
857  win32port/client/client.vcxproj                          |  259 ---
858  win32port/client/client.vcxproj.filters                  |   39 -
859  .../libwebsocketswin32.vcxproj.filters                   |   93 -
860  win32port/server/server.vcxproj                          |  276 ---
861  win32port/server/server.vcxproj.filters                  |   51 -
862  win32port/win32helpers/gettimeofday.h                    |   59 +-
863  win32port/win32helpers/netdb.h                           |    1 -
864  win32port/win32helpers/strings.h                         |    0
865  win32port/win32helpers/sys/time.h                        |    1 -
866  win32port/win32helpers/unistd.h                          |    0
867  win32port/win32helpers/websock-w32.c                     |  104 --
868  win32port/win32helpers/websock-w32.h                     |   62 -
869  win32port/win32port.sln                                  |  100 --
870  win32port/zlib/gzio.c                                    |    3 +-
871  55 files changed, 6779 insertions(+), 5059 deletions(-)
872
873
874 User api additions
875 ------------------
876
877 POST method is supported
878
879 The protocol 0 / HTTP callback can now get two new kinds of callback,
880 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
881 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
882 and been passed to the user code already).  These callbacks are used with the
883 post method (see the test server for details).
884
885 The period between the HTTP header completion and the completion of the body
886 processing is protected by a 5s timeout.
887
888 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
889
890
891 New server option you can enable from user code
892 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
893 also be accepted on an SSL listening port.  It's disabled unless you enable
894 it explicitly.
895
896
897 Two new callbacks are added in protocols[0] that are optional for allowing
898 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
899 LWS_CALLBACK_UNLOCK_POLL.
900
901 If you use them, they protect internal and external poll list changes, but if
902 you want to use external thread access to libwebsocket_callback_on_writable()
903 you have to implement your locking here even if you don't use external
904 poll support.
905
906 If you will use another thread for this, take a lot of care about managing
907 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
908 (with your own locking).
909
910 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
911 eventloop instead of the default poll() one will also be compiled in.  But to
912 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
913 creation info struct options member.
914
915 IPV6 is supported and enabled by default except for Windows, you can disable
916 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
917 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
918 the context creation info struct options member.
919
920 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
921 guarantee the OS CAs will not be used, even if that support was selected at
922 build-time.
923
924 Optional "token limits" may be enforced by setting the member "token_limits"
925 in struct lws_context_creation_info to point to a struct lws_token_limits.
926 NULL means no token limits used for compatibility.
927
928
929 User api changes
930 ----------------
931
932 Extra optional argument to libwebsockets_serve_http_file() allows injecion
933 of HTTP headers into the canned response.  Eg, cookies may be added like
934 that without getting involved in having to send the header by hand.
935
936 A new info member http_proxy_address may be used at context creation time to
937 set the http proxy.  If non-NULL, it overrides http_proxy environment var.
938
939 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
940 the client to use the OS CA Roots.  If you're worried somebody with the
941 ability to forge for force creation of a client cert from the root CA in
942 your OS, you should disable this since your selfsigned $0 cert is a lot safer
943 then...
944
945
946 v1.23-chrome32-firefox24
947 ========================
948
949  Android.mk                            |   29 +
950  CMakeLists.txt                        |  573 ++++++++----
951  COPYING                               |  503 -----------
952  INSTALL                               |  365 --------
953  Makefile.am                           |   13 -
954  README.build                          |  371 ++------
955  README.coding                         |   63 ++
956  autogen.sh                            | 1578 ---------------------------------
957  changelog                             |   69 ++
958  cmake/FindGit.cmake                   |  163 ++++
959  cmake/FindOpenSSLbins.cmake           |   15 +-
960  cmake/UseRPMTools.cmake               |  176 ++++
961  config.h.cmake                        |   25 +-
962  configure.ac                          |  226 -----
963  cross-arm-linux-gnueabihf.cmake       |   28 +
964  lib/Makefile.am                       |   89 --
965  lib/base64-decode.c                   |   98 +-
966  lib/client-handshake.c                |  123 ++-
967  lib/client-parser.c                   |   19 +-
968  lib/client.c                          |  145 ++-
969  lib/daemonize.c                       |    4 +-
970  lib/extension.c                       |    2 +-
971  lib/getifaddrs.h                      |    4 +-
972  lib/handshake.c                       |   76 +-
973  lib/libwebsockets.c                   |  491 ++++++----
974  lib/libwebsockets.h                   |  164 ++--
975  lib/output.c                          |  214 ++++-
976  lib/parsers.c                         |  102 +--
977  lib/private-libwebsockets.h           |   66 +-
978  lib/server-handshake.c                |    5 +-
979  lib/server.c                          |   29 +-
980  lib/sha-1.c                           |    2 +-
981  libwebsockets-api-doc.html            |  249 +++---
982  libwebsockets.pc.in                   |   11 -
983  libwebsockets.spec                    |   14 +-
984  m4/ignore-me                          |    2 -
985  scripts/FindLibWebSockets.cmake       |   33 +
986  scripts/kernel-doc                    |    1 +
987  test-server/Makefile.am               |  131 ---
988  test-server/leaf.jpg                  |  Bin 0 -> 2477518 bytes
989  test-server/test-client.c             |   78 +-
990  test-server/test-echo.c               |   33 +-
991  test-server/test-fraggle.c            |   26 +-
992  test-server/test-ping.c               |   15 +-
993  test-server/test-server.c             |  197 +++-
994  test-server/test.html                 |    5 +-
995  win32port/win32helpers/gettimeofday.c |   74 +-
996  win32port/win32helpers/websock-w32.h  |    6 +-
997  48 files changed, 2493 insertions(+), 4212 deletions(-)
998
999
1000 User api additions
1001 ------------------
1002
1003  - You can now call libwebsocket_callback_on_writable() on http connectons,
1004         and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
1005         regulate writes with a websocket protocol connection.
1006
1007  - A new member in the context creation parameter struct "ssl_cipher_list" is
1008         added, replacing CIPHERS_LIST_STRING.  NULL means use the ssl library
1009         default list of ciphers.
1010
1011  - Not really an api addition, but libwebsocket_service_fd() will now zero
1012         the revents field of the pollfd it was called with if it handled the
1013         descriptor.  So you can tell if it is a non-lws fd by checking revents
1014         after the service call... if it's still nonzero, the descriptor
1015         belongs to you and you need to take care of it.
1016
1017  - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
1018         connections with the established protocol.  It's designed to be
1019         called from user server code when it sees it can accept more input
1020         and may have throttled connections using the server rx flow apis
1021         while it was unable to accept any other input  The user server code
1022         then does not have to try to track while connections it choked, this
1023         will free up all of them in one call.
1024
1025  - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
1026         called when an HTTP protocol socket closes
1027
1028  - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
1029         has already been done before the callback happens.  That means we can
1030         use the user parameter to the callback to contain the user pointer, and
1031         move the protocol name to the "in" parameter.  The docs for this
1032         callback are also updated to reflect how to check headers in there.
1033
1034  - libwebsocket_client_connect() is now properly nonblocking and async.  See
1035         README.coding and test-client.c for information on the callbacks you
1036         can rely on controlling the async connection period with.
1037
1038  - if your OS does not support the http_proxy environment variable convention
1039         (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
1040         to set the proxy details in between context creation and the connection
1041         action.  For OSes that support http_proxy, that's used automatically.
1042
1043 User api changes
1044 ----------------
1045
1046  - the external poll callbacks now get the socket descriptor coming from the
1047         "in" parameter.  The user parameter provides the user_space for the
1048         wsi as it normally does on the other callbacks.
1049         LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
1050         delivered by @in now instead of @user.
1051
1052  - libwebsocket_write() now returns -1 for error, or the amount of data
1053         actually accepted for send.  Under load, the OS may signal it is
1054         ready to send new data on the socket, but have only a restricted
1055         amount of memory to buffer the packet compared to usual.
1056
1057
1058 User api removal
1059 ----------------
1060
1061  - libwebsocket_ensure_user_space() is removed from the public api, if you
1062         were using it to get user_space, you need to adapt your code to only
1063         use user_space inside the user callback.
1064
1065  - CIPHERS_LIST_STRING is removed
1066
1067  - autotools build has been removed.  See README.build for info on how to
1068         use CMake for your platform
1069
1070
1071 v1.21-chrome26-firefox18
1072 ========================
1073
1074  - Fixes buffer overflow bug in max frame size handling if you used the
1075         default protocol buffer size.  If you declared rx_buffer_size in your
1076         protocol, which is recommended anyway, your code was unaffected.
1077
1078 v1.2-chrome26-firefox18
1079 =======================
1080
1081 Diffstat
1082 --------
1083
1084  .gitignore                                                      |  16 +++
1085  CMakeLists.txt                                                  | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1086  LICENSE                                                         | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1087  Makefile.am                                                     |   1 +
1088  README                                                          |  20 +++
1089  README.build                                                    | 258 ++++++++++++++++++++++++++++++++-----
1090  README.coding                                                   |  52 ++++++++
1091  changelog                                                       | 136 ++++++++++++++++++++
1092  cmake/FindOpenSSLbins.cmake                                     |  33 +++++
1093  config.h.cmake                                                  | 173 +++++++++++++++++++++++++
1094  configure.ac                                                    |  22 +++-
1095  lib/Makefile.am                                                 |  20 ++-
1096  lib/base64-decode.c                                             |   2 +-
1097  lib/client-handshake.c                                          | 190 +++++++++++-----------------
1098  lib/client-parser.c                                             |  88 +++++++------
1099  lib/client.c                                                    | 384 ++++++++++++++++++++++++++++++-------------------------
1100  lib/daemonize.c                                                 |  32 +++--
1101  lib/extension-deflate-frame.c                                   |  58 +++++----
1102  lib/extension-deflate-stream.c                                  |  19 ++-
1103  lib/extension-deflate-stream.h                                  |   4 +-
1104  lib/extension.c                                                 |  11 +-
1105  lib/getifaddrs.c                                                | 315 +++++++++++++++++++++++-----------------------
1106  lib/getifaddrs.h                                                |  30 ++---
1107  lib/handshake.c                                                 | 124 +++++++++++-------
1108  lib/libwebsockets.c                                             | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
1109  lib/libwebsockets.h                                             | 237 ++++++++++++++++++++++------------
1110  lib/output.c                                                    | 192 +++++++++++-----------------
1111  lib/parsers.c                                                   | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
1112  lib/private-libwebsockets.h                                     | 225 +++++++++++++++++++++------------
1113  lib/server-handshake.c                                          |  82 ++++++------
1114  lib/server.c                                                    |  96 +++++++-------
1115  libwebsockets-api-doc.html                                      | 189 ++++++++++++++++++----------
1116  libwebsockets.spec                                              |  17 +--
1117  test-server/attack.sh                                           | 148 ++++++++++++++++++++++
1118  test-server/test-client.c                                       | 125 +++++++++---------
1119  test-server/test-echo.c                                         |  31 +++--
1120  test-server/test-fraggle.c                                      |  32 ++---
1121  test-server/test-ping.c                                         |  52 ++++----
1122  test-server/test-server.c                                       | 129 ++++++++++++-------
1123  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj         | 279 ----------------------------------------
1124  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters |  23 +++-
1125  41 files changed, 4398 insertions(+), 2219 deletions(-)
1126
1127
1128 User api additions
1129 ------------------
1130
1131  - lws_get_library_version() returns a const char * with a string like
1132          "1.1 9e7f737", representing the library version from configure.ac
1133          and the git HEAD hash the library was built from
1134
1135  - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
1136         also with controllable timeout, number of probes and probe interval.
1137         (On BSD type OS, you can only use system default settings for the
1138         timing and retries, although enabling it is supported by setting
1139         ka_time to nonzero, the exact value has no meaning.)
1140         This enables detection of idle connections which are logically okay,
1141         but are in fact dead, due to network connectivity issues at the server,
1142         client, or any intermediary.  By default it's not enabled, but you
1143         can enable it by setting a non-zero timeout (in seconds) at the new
1144         ka_time member at context creation time.
1145
1146  - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
1147         is called one-time per protocol as the context is being destroyed, and
1148         LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
1149         and the protocols are added, again it's a one-time affair.
1150         This lets you manage per-protocol allocations properly including
1151         cleaning up after yourself when the server goes down.
1152
1153 User api changes
1154 ----------------
1155
1156  - libwebsocket_create_context() has changed from taking a ton of parameters
1157         to just taking a pointer to a struct containing the parameters.  The
1158         struct lws_context_creation_info is in libwebsockets.h, the members
1159         are in the same order as when they were parameters to the call
1160         previously.  The test apps are all updated accordingly so you can
1161         see example code there.
1162
1163  - Header tokens are now deleted after the websocket connection is
1164         established.  Not just the header data is saved, but the pointer and
1165         length array is also removed from (union) scope saving several hundred
1166         bytes per connection once it is established
1167
1168  - struct libwebsocket_protocols has a new member rx_buffer_size, this
1169         controls rx buffer size per connection of that protocol now.  Sources
1170         for apps built against older versions of the library won't declare
1171         this in their protocols, defaulting it to 0.  Zero buffer is legal,
1172         it causes a default buffer to be allocated (currently 4096)
1173
1174         If you want to receive only atomic frames in your user callback, you
1175         should set this to greater than your largest frame size.  If a frame
1176         comes that exceeds that, no error occurs but the callback happens as
1177         soon as the buffer limit is reached, and again if it is reached again
1178         or the frame completes.  You can detect that has happened by seeing
1179         there is still frame content pending using
1180         libwebsockets_remaining_packet_payload()
1181
1182         By correctly setting this, you can save a lot of memory when your
1183         protocol has small frames (see the test server and client sources).
1184
1185  - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
1186         header payload lws can cope with, that includes the GET URL, origin
1187         etc.  Headers not understood by lws are ignored and their payload
1188         not included in this.
1189
1190
1191 User api removals
1192 -----------------
1193
1194  - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
1195         buffer size chosen per-protocol.  For compatibility, there's a default
1196         of 4096 rx buffer, but user code should set the appropriate size for
1197         the protocol frames.
1198
1199  - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1200         and have been removed.  There's a new header management scheme that
1201         handles them in a much more compact way.
1202
1203  - libwebsockets_hangup_on_client() is removed.  If you want to close the
1204         connection you must do so from the user callback and by returning
1205         -1 from there.
1206
1207  - libwebsocket_close_and_free_session() is now private to the library code
1208         only and not exposed for user code.  If you want to close the
1209         connection, you must do so from the user callback by returning -1
1210         from there.
1211
1212
1213 New features
1214 ------------
1215
1216  - Cmake project file added, aimed initially at Windows support: this replaces
1217         the visual studio project files that were in the tree until now.
1218
1219  - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1220
1221  - PATH_MAX or MAX_PATH no longer needed
1222
1223  - cutomizable frame rx buffer size by protocol
1224
1225  - optional TCP keepalive so dead peers can be detected, can be enabled at
1226         context-creation time
1227
1228  - valgrind-clean: no SSL or CyaSSL: completely clean.  With OpenSSL, 88 bytes
1229         lost at OpenSSL library init and symptomless reports of uninitialized
1230         memory usage... seems to be a known and ignored problem at OpenSSL
1231
1232  - By default debug is enabled and the library is built for -O0 -g to faclitate
1233         that.  Use --disable-debug configure option to build instead with -O4
1234         and no -g (debug info), obviously providing best performance and
1235         reduced binary size.
1236
1237  - 1.0 introduced some code to try to not deflate small frames, however this
1238         seems to break when confronted with a mixture of frames above and
1239         below the threshold, so it's removed.  Veto the compression extension
1240         in your user callback if you will typically have very small frames.
1241
1242  - There are many memory usage improvements, both a reduction in malloc/
1243         realloc and architectural changes.  A websocket connection now
1244         consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1245         during header processing an additional 1262 bytes is allocated in a
1246         single malloc, but is freed when the websocket connection starts.
1247         The RX frame buffer defined by the protocol in user
1248         code is also allocated per connection, this represents the largest
1249         frame you can receive atomically in that protocol.
1250
1251  - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1252         and 112 bytes per connection (+1328 only during header processing)
1253
1254
1255 v1.1-chrome26-firefox18
1256 =======================
1257
1258 Diffstat
1259 --------
1260
1261  Makefile.am                            |    4 +
1262  README-test-server                     |  291 ---
1263  README.build                           |  239 ++
1264  README.coding                          |  138 ++
1265  README.rst                             |   72 -
1266  README.test-apps                       |  272 +++
1267  configure.ac                           |  116 +-
1268  lib/Makefile.am                        |   55 +-
1269  lib/base64-decode.c                    |    5 +-
1270  lib/client-handshake.c                 |  121 +-
1271  lib/client-parser.c                    |  394 ++++
1272  lib/client.c                           |  807 +++++++
1273  lib/daemonize.c                        |  212 ++
1274  lib/extension-deflate-frame.c          |  132 +-
1275  lib/extension-deflate-stream.c         |   12 +-
1276  lib/extension-x-google-mux.c           | 1223 ----------
1277  lib/extension-x-google-mux.h           |   96 -
1278  lib/extension.c                        |    8 -
1279  lib/getifaddrs.c                       |  271 +++
1280  lib/getifaddrs.h                       |   76 +
1281  lib/handshake.c                        |  582 +----
1282  lib/libwebsockets.c                    | 2493 ++++++---------------
1283  lib/libwebsockets.h                    |  115 +-
1284  lib/md5.c                              |  217 --
1285  lib/minilex.c                          |  440 ++++
1286  lib/output.c                           |  628 ++++++
1287  lib/parsers.c                          | 2016 +++++------------
1288  lib/private-libwebsockets.h            |  284 +--
1289  lib/server-handshake.c                 |  275 +++
1290  lib/server.c                           |  377 ++++
1291  libwebsockets-api-doc.html             |  300 +--
1292  m4/ignore-me                           |    2 +
1293  test-server/Makefile.am                |  111 +-
1294  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
1295  test-server/test-client.c              |   45 +-
1296  test-server/test-echo.c                |  330 +++
1297  test-server/test-fraggle.c             |   20 +-
1298  test-server/test-ping.c                |   22 +-
1299  test-server/test-server-extpoll.c      |  554 -----
1300  test-server/test-server.c              |  349 ++-
1301  test-server/test.html                  |    3 +-
1302  win32port/zlib/ZLib.vcxproj            |  749 ++++---
1303  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
1304  win32port/zlib/adler32.c               |  348 ++-
1305  win32port/zlib/compress.c              |  160 +-
1306  win32port/zlib/crc32.c                 |  867 ++++----
1307  win32port/zlib/crc32.h                 |  882 ++++----
1308  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
1309  win32port/zlib/deflate.h               |  688 +++---
1310  win32port/zlib/gzclose.c               |   50 +-
1311  win32port/zlib/gzguts.h                |  325 ++-
1312  win32port/zlib/gzlib.c                 | 1157 +++++-----
1313  win32port/zlib/gzread.c                | 1242 ++++++-----
1314  win32port/zlib/gzwrite.c               | 1096 +++++----
1315  win32port/zlib/infback.c               | 1272 ++++++-----
1316  win32port/zlib/inffast.c               |  680 +++---
1317  win32port/zlib/inffast.h               |   22 +-
1318  win32port/zlib/inffixed.h              |  188 +-
1319  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
1320  win32port/zlib/inflate.h               |  244 +-
1321  win32port/zlib/inftrees.c              |  636 +++---
1322  win32port/zlib/inftrees.h              |  124 +-
1323  win32port/zlib/trees.c                 | 2468 +++++++++++----------
1324  win32port/zlib/trees.h                 |  256 +--
1325  win32port/zlib/uncompr.c               |  118 +-
1326  win32port/zlib/zconf.h                 |  934 ++++----
1327  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
1328  win32port/zlib/zutil.c                 |  642 +++---
1329  win32port/zlib/zutil.h                 |  526 ++---
1330  69 files changed, 19556 insertions(+), 20145 deletions(-)
1331
1332 user api changes
1333 ----------------
1334
1335  - libwebsockets_serve_http_file() now takes a context as first argument
1336
1337  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1338         two arguments
1339
1340
1341 user api additions
1342 ------------------
1343
1344  - lwsl_...() logging apis, default to stderr but retargetable by user code;
1345         may be used also by user code
1346
1347  - lws_set_log_level() set which logging apis are able to emit (defaults to
1348         notice, warn, err severities), optionally set the emit callback
1349
1350  - lwsl_emit_syslog() helper callback emits to syslog
1351
1352  - lws_daemonize() helper code that forks the app into a headless daemon
1353         properly, maintains a lock file with pid in suitable for sysvinit etc to
1354         control lifecycle
1355
1356  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1357         transfer is now asynchronous (see test server code)
1358
1359  - lws_frame_is_binary() from a wsi pointer, let you know if the received
1360         data was sent in BINARY mode
1361
1362
1363 user api removals
1364 -----------------
1365
1366  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1367         arrange your code to act from the user callback instead from same
1368         process context as the service loop
1369
1370  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1371         instead from same process context as the service loop.  See the test apps
1372         for examples.
1373
1374  - x-google-mux() removed until someone wants it
1375
1376  - pre -v13 (ancient) protocol support removed
1377
1378
1379 New features
1380 ------------
1381
1382  - echo test server and client compatible with echo.websocket.org added
1383
1384  - many new configure options (see README.build) to reduce footprint of the
1385         library to what you actually need, eg, --without-client and
1386         --without-server
1387
1388  - http + websocket server can build to as little as 12K .text for ARM
1389
1390  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1391         allowed to the process by ulimit, defaults to 1024 on Fedora and
1392         Ubuntu.  Use ulimit to control this without needing to configure
1393         the library.  Code here is smaller and faster.
1394
1395  - adaptive ratio of listen socket to connection socket service allows
1396         good behaviour under Apache ab test load.  Tested with thousands
1397         of simultaneous connections
1398
1399  - reduction in per-connection memory footprint by moving to a union to hold
1400         mutually-exclusive state for the connection
1401
1402  - robustness: Out of Memory taken care of for all allocation code now
1403
1404  - internal getifaddrs option if your toolchain lacks it (some uclibc)
1405
1406  - configurable memory limit for deflate operations
1407
1408  - improvements in SSL code nonblocking operation, possible hang solved,
1409         some SSL operations broken down into pollable states so there is
1410         no library blocking, timeout coverage for SSL_connect
1411
1412  - extpoll test server merged into single test server source
1413
1414  - robustness: library should deal with all recoverable socket conditions
1415
1416  - rx flowcontrol for backpressure notification fixed and implmeneted
1417         correctly in the test server
1418
1419  - optimal lexical parser added for header processing; all headers in a
1420         single 276-byte state table
1421
1422  - latency tracking api added (configure --with-latency)
1423
1424  - Improved in-tree documentation, REAME.build, README.coding,
1425         README.test-apps, changelog
1426
1427  - Many small fixes
1428
1429
1430 v1.0-chrome25-firefox17 (6cd1ea9b005933f)