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