blob: 3290c7a81682bf5aaf29332c1f07f02969454d0e [file] [log] [blame]
Andy Greena35c86f2013-01-31 10:16:44 +08001Changelog
2---------
3
MGadkari020c53c2015-08-21 16:15:36 +05304(since last tag)
5
6User api changes
7----------------
8
9LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
10non-NULL. If so, the string has length len.
11
Andy Green6d59f592015-10-15 09:12:58 +080012LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
13for peer certs if you are using the option to require client certs.
14
Andy Green4c79ee72015-10-15 11:20:40 +080015LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
16externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
17
18
Andy Green16fb0132015-03-28 11:35:40 +080019v1.4-chrome43-firefox36
20=======================
Olehfaeac3c2014-07-29 23:18:41 +080021
22User api additions
23------------------
24
25There's a new member in the info struct used to control context creation,
26ssl_private_key_password, which allows passing into lws the passphrase on
27an SSL cetificate
28
Andy Greeneabed8d2014-08-11 12:11:36 +080029There's a new member in struct protocols, id, which is ignored by lws but can
30be used by the user code to mark the selected protocol by user-defined version
31or capabliity flag information, for the case multiple versions of a protocol are
32supported.
33
Andy Greenb128ccc2014-08-16 09:54:27 +080034int lws_is_ssl(wsi) added to allow user code to know if the connection was made
35over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
36ssl and non-ssl connections are possible and may need to be treated differently
37in the user code.
38
Andy Green14425ea2014-08-18 22:49:39 +080039int lws_partial_buffered(wsi) added... should be checked after any
40libwebsocket_write that will be followed by another libwebsocket_write inside
41the same writeable callback. If set, you can't do any more writes until the
42writeable callback is called again. If you only do one write per writeable callback,
43you can ignore this.
44
Andy Green917f43a2014-10-12 14:31:47 +080045HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
46agnositic header creation APIs. These do the right thing depending on each
47connection's HTTP version without the user code having to know or care, except
48to make sure to use the new APIs for headers (test-server is updated to use
49them already, so look there for examples)
50
51The APIs "render" the headers into a user-provided buffer and bump *p as it
52is used. If *p reaches end, then the APIs return nonzero for error.
53
54LWS_VISIBLE LWS_EXTERN int
55lws_add_http_header_status(struct libwebsocket_context *context,
56 struct libwebsocket *wsi,
57 unsigned int code,
58 unsigned char **p,
59 unsigned char *end);
60
61Start a response header reporting status like 200, 500, etc
62
63LWS_VISIBLE LWS_EXTERN int
64lws_add_http_header_by_name(struct libwebsocket_context *context,
65 struct libwebsocket *wsi,
66 const unsigned char *name,
67 const unsigned char *value,
68 int length,
69 unsigned char **p,
70 unsigned char *end);
71
72Add a header like name: value in HTTP1.x
73
74LWS_VISIBLE LWS_EXTERN int
75lws_finalize_http_header(struct libwebsocket_context *context,
76 struct libwebsocket *wsi,
77 unsigned char **p,
78 unsigned char *end);
79
80Finish off the headers, like add the extra \r\n in HTTP1.x
81
82LWS_VISIBLE LWS_EXTERN int
83lws_add_http_header_by_token(struct libwebsocket_context *context,
84 struct libwebsocket *wsi,
85 enum lws_token_indexes token,
86 const unsigned char *value,
87 int length,
88 unsigned char **p,
89 unsigned char *end);
90
91Add a header by using a lws token as the name part. In HTTP2, this can be
92compressed to one or two bytes.
93
Olehfaeac3c2014-07-29 23:18:41 +080094
Andy Green822241c2014-08-18 22:21:51 +080095User api removal
96----------------
97
98protocols struct member no_buffer_all_partial_tx is removed. Under some
99conditions like rewriting extention such as compression in use, the built-in
100partial send buffering is the only way to deal with the problem, so turning
101it off is deprecated.
102
103
Andy Green917f43a2014-10-12 14:31:47 +0800104User api changes
105----------------
106
107HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
108the end now
109
110int other_headers_len)
111
112If you are providing other headers, they must be generated using the new
113HTTP-version-agnostic APIs, and you must provide the length of them using this
114additional parameter.
115
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800116struct lws_context_creation_info now has an additional member
117SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
118SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
119lws managing the context, if you memset the struct to 0 or have as a filescope
120initialized struct in bss, no need to change anything.
121
Andy Green822241c2014-08-18 22:21:51 +0800122
Andy Greenc1fdd102014-07-06 09:56:11 +0800123v1.3-chrome37-firefox30
124=======================
125
126 .gitignore | 1 -
127 CMakeLists.txt | 447 +++--
128 README.build | 35 +-
129 README.coding | 14 +
130 changelog | 66 +
131 cmake/LibwebsocketsConfig.cmake.in | 17 +
132 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
133 config.h.cmake | 18 +
134 cross-ming.cmake | 31 +
135 cross-openwrt-makefile | 91 +
136 lib/client-handshake.c | 205 ++-
137 lib/client-parser.c | 58 +-
138 lib/client.c | 158 +-
139 lib/context.c | 341 ++++
140 lib/extension-deflate-frame.c | 2 +-
141 lib/extension.c | 178 ++
142 lib/handshake.c | 287 +---
143 lib/lextable.h | 338 ++++
144 lib/libev.c | 175 ++
145 lib/libwebsockets.c | 2089 +++--------------------
146 lib/libwebsockets.h | 253 ++-
147 lib/lws-plat-unix.c | 404 +++++
148 lib/lws-plat-win.c | 358 ++++
149 lib/minilex.c | 530 +++---
150 lib/output.c | 445 ++---
151 lib/parsers.c | 682 ++++----
152 lib/pollfd.c | 239 +++
153 lib/private-libwebsockets.h | 501 +++++-
154 lib/server-handshake.c | 274 +--
155 lib/server.c | 858 ++++++++--
156 lib/service.c | 517 ++++++
157 lib/sha-1.c | 38 +-
158 lib/ssl-http2.c | 78 +
159 lib/ssl.c | 571 +++++++
160 test-server/attack.sh | 101 +-
161 test-server/test-client.c | 9 +-
162 test-server/test-echo.c | 17 +-
163 test-server/test-fraggle.c | 7 -
164 test-server/test-ping.c | 12 +-
165 test-server/test-server.c | 330 ++--
166 test-server/test.html | 4 +-
167 win32port/client/client.vcxproj | 259 ---
168 win32port/client/client.vcxproj.filters | 39 -
169 .../libwebsocketswin32.vcxproj.filters | 93 -
170 win32port/server/server.vcxproj | 276 ---
171 win32port/server/server.vcxproj.filters | 51 -
172 win32port/win32helpers/gettimeofday.h | 59 +-
173 win32port/win32helpers/netdb.h | 1 -
174 win32port/win32helpers/strings.h | 0
175 win32port/win32helpers/sys/time.h | 1 -
176 win32port/win32helpers/unistd.h | 0
177 win32port/win32helpers/websock-w32.c | 104 --
178 win32port/win32helpers/websock-w32.h | 62 -
179 win32port/win32port.sln | 100 --
180 win32port/zlib/gzio.c | 3 +-
181 55 files changed, 6779 insertions(+), 5059 deletions(-)
182
Andy Green79002562013-11-09 11:04:35 +0800183
kapejodce64fb02013-11-19 13:38:16 +0100184User api additions
185------------------
186
187POST method is supported
188
189The protocol 0 / HTTP callback can now get two new kinds of callback,
190LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
191and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
192and been passed to the user code already). These callbacks are used with the
193post method (see the test server for details).
194
195The period between the HTTP header completion and the completion of the body
196processing is protected by a 5s timeout.
197
198The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
199
200
James Devine5b34c972013-12-14 11:41:29 +0800201New server option you can enable from user code
202LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
203also be accepted on an SSL listening port. It's disabled unless you enable
204it explicitly.
205
206
Andy Green7a132792013-12-18 09:48:26 +0800207Two new callbacks are added in protocols[0] that are optional for allowing
208limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
209LWS_CALLBACK_UNLOCK_POLL.
210
211If you use them, they protect internal and external poll list changes, but if
212you want to use external thread access to libwebsocket_callback_on_writable()
213you have to implement your locking here even if you don't use external
214poll support.
215
216If you will use another thread for this, take a lot of care about managing
217your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
218(with your own locking).
219
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800220If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
221eventloop instead of the default poll() one will also be compiled in. But to
222use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
223creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800224
Andy Greenc1fdd102014-07-06 09:56:11 +0800225IPV6 is supported and enabled by default except for Windows, you can disable
226the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800227compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
228the context creation info struct options member.
229
Andy Greenc1fdd102014-07-06 09:56:11 +0800230You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
231guarantee the OS CAs will not be used, even if that support was selected at
232build-time.
233
234Optional "token limits" may be enforced by setting the member "token_limits"
235in struct lws_context_creation_info to point to a struct lws_token_limits.
236NULL means no token limits used for compatibility.
237
Andy Green7a132792013-12-18 09:48:26 +0800238
Andy Green79002562013-11-09 11:04:35 +0800239User api changes
240----------------
241
242Extra optional argument to libwebsockets_serve_http_file() allows injecion
243of HTTP headers into the canned response. Eg, cookies may be added like
244that without getting involved in having to send the header by hand.
245
Patrick Gansterer148b9452014-02-28 02:31:23 +0100246A new info member http_proxy_address may be used at context creation time to
247set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800248
Andy Greend2ec7ad2014-03-15 10:39:29 +0800249Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
250the client to use the OS CA Roots. If you're worried somebody with the
251ability to forge for force creation of a client cert from the root CA in
252your OS, you should disable this since your selfsigned $0 cert is a lot safer
253then...
254
Andy Green79002562013-11-09 11:04:35 +0800255
Andy Green81877e62013-10-26 20:36:08 +0800256v1.23-chrome32-firefox24
257========================
258
259 Android.mk | 29 +
260 CMakeLists.txt | 573 ++++++++----
261 COPYING | 503 -----------
262 INSTALL | 365 --------
263 Makefile.am | 13 -
264 README.build | 371 ++------
265 README.coding | 63 ++
266 autogen.sh | 1578 ---------------------------------
267 changelog | 69 ++
268 cmake/FindGit.cmake | 163 ++++
269 cmake/FindOpenSSLbins.cmake | 15 +-
270 cmake/UseRPMTools.cmake | 176 ++++
271 config.h.cmake | 25 +-
272 configure.ac | 226 -----
273 cross-arm-linux-gnueabihf.cmake | 28 +
274 lib/Makefile.am | 89 --
275 lib/base64-decode.c | 98 +-
276 lib/client-handshake.c | 123 ++-
277 lib/client-parser.c | 19 +-
278 lib/client.c | 145 ++-
279 lib/daemonize.c | 4 +-
280 lib/extension.c | 2 +-
281 lib/getifaddrs.h | 4 +-
282 lib/handshake.c | 76 +-
283 lib/libwebsockets.c | 491 ++++++----
284 lib/libwebsockets.h | 164 ++--
285 lib/output.c | 214 ++++-
286 lib/parsers.c | 102 +--
287 lib/private-libwebsockets.h | 66 +-
288 lib/server-handshake.c | 5 +-
289 lib/server.c | 29 +-
290 lib/sha-1.c | 2 +-
291 libwebsockets-api-doc.html | 249 +++---
292 libwebsockets.pc.in | 11 -
293 libwebsockets.spec | 14 +-
294 m4/ignore-me | 2 -
295 scripts/FindLibWebSockets.cmake | 33 +
296 scripts/kernel-doc | 1 +
297 test-server/Makefile.am | 131 ---
298 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
299 test-server/test-client.c | 78 +-
300 test-server/test-echo.c | 33 +-
301 test-server/test-fraggle.c | 26 +-
302 test-server/test-ping.c | 15 +-
303 test-server/test-server.c | 197 +++-
304 test-server/test.html | 5 +-
305 win32port/win32helpers/gettimeofday.c | 74 +-
306 win32port/win32helpers/websock-w32.h | 6 +-
307 48 files changed, 2493 insertions(+), 4212 deletions(-)
308
Andy Green54cb3462013-02-14 22:23:54 +0800309
310User api additions
311------------------
312
313 - You can now call libwebsocket_callback_on_writable() on http connectons,
314 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
315 regulate writes with a websocket protocol connection.
316
Andy Green2672fb22013-02-22 09:54:35 +0800317 - A new member in the context creation parameter struct "ssl_cipher_list" is
318 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
319 default list of ciphers.
320
Andy Green58f214e2013-03-09 13:03:53 +0800321 - Not really an api addition, but libwebsocket_service_fd() will now zero
322 the revents field of the pollfd it was called with if it handled the
323 descriptor. So you can tell if it is a non-lws fd by checking revents
324 after the service call... if it's still nonzero, the descriptor
325 belongs to you and you need to take care of it.
326
Andy Greenb55451c2013-03-16 12:32:27 +0800327 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
328 connections with the established protocol. It's designed to be
329 called from user server code when it sees it can accept more input
330 and may have throttled connections using the server rx flow apis
331 while it was unable to accept any other input The user server code
332 then does not have to try to track while connections it choked, this
333 will free up all of them in one call.
334
Andy Green0c9563b2013-06-10 22:54:40 +0800335 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
336 called when an HTTP protocol socket closes
337
Andy Green96d48fd2013-09-18 08:32:55 +0800338 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
339 has already been done before the callback happens. That means we can
340 use the user parameter to the callback to contain the user pointer, and
341 move the protocol name to the "in" parameter. The docs for this
342 callback are also updated to reflect how to check headers in there.
343
Andy Green5dc62ea2013-09-20 20:26:12 +0800344 - libwebsocket_client_connect() is now properly nonblocking and async. See
345 README.coding and test-client.c for information on the callbacks you
346 can rely on controlling the async connection period with.
347
Andy Green81877e62013-10-26 20:36:08 +0800348 - if your OS does not support the http_proxy environment variable convention
349 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
350 to set the proxy details inbetween context creation and the connection
351 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +0800352
Andy Green50097dd2013-02-15 22:36:30 +0800353User api changes
354----------------
355
356 - the external poll callbacks now get the socket descriptor coming from the
357 "in" parameter. The user parameter provides the user_space for the
358 wsi as it normally does on the other callbacks.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +0800359 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
360 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +0800361
Andy Greenfc7c5e42013-02-23 10:50:10 +0800362 - libwebsocket_write() now returns -1 for error, or the amount of data
363 actually accepted for send. Under load, the OS may signal it is
364 ready to send new data on the socket, but have only a restricted
365 amount of memory to buffer the packet compared to usual.
366
Andy Green50097dd2013-02-15 22:36:30 +0800367
Andy Greendc914cf2013-02-18 16:54:26 +0800368User api removal
369----------------
370
371 - libwebsocket_ensure_user_space() is removed from the public api, if you
372 were using it to get user_space, you need to adapt your code to only
373 use user_space inside the user callback.
374
Andy Green2672fb22013-02-22 09:54:35 +0800375 - CIPHERS_LIST_STRING is removed
376
Andy Green0097a992013-03-09 13:06:37 +0800377 - autotools build has been removed. See README.build for info on how to
378 use CMake for your platform
379
Andy Green54cb3462013-02-14 22:23:54 +0800380
Andy Green53a46782013-02-14 11:23:49 +0800381v1.21-chrome26-firefox18
382========================
383
384 - Fixes buffer overflow bug in max frame size handling if you used the
385 default protocol buffer size. If you declared rx_buffer_size in your
386 protocol, which is recommended anyway, your code was unaffected.
387
Andy Green182cb9a2013-02-13 11:54:08 +0800388v1.2-chrome26-firefox18
389=======================
390
391Diffstat
392--------
393
394 .gitignore | 16 +++
395 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
396 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
397 Makefile.am | 1 +
398 README | 20 +++
399 README.build | 258 ++++++++++++++++++++++++++++++++-----
400 README.coding | 52 ++++++++
401 changelog | 136 ++++++++++++++++++++
402 cmake/FindOpenSSLbins.cmake | 33 +++++
403 config.h.cmake | 173 +++++++++++++++++++++++++
404 configure.ac | 22 +++-
405 lib/Makefile.am | 20 ++-
406 lib/base64-decode.c | 2 +-
407 lib/client-handshake.c | 190 +++++++++++-----------------
408 lib/client-parser.c | 88 +++++++------
409 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
410 lib/daemonize.c | 32 +++--
411 lib/extension-deflate-frame.c | 58 +++++----
412 lib/extension-deflate-stream.c | 19 ++-
413 lib/extension-deflate-stream.h | 4 +-
414 lib/extension.c | 11 +-
415 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
416 lib/getifaddrs.h | 30 ++---
417 lib/handshake.c | 124 +++++++++++-------
418 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
419 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
420 lib/output.c | 192 +++++++++++-----------------
421 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
422 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
423 lib/server-handshake.c | 82 ++++++------
424 lib/server.c | 96 +++++++-------
425 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
426 libwebsockets.spec | 17 +--
427 test-server/attack.sh | 148 ++++++++++++++++++++++
428 test-server/test-client.c | 125 +++++++++---------
429 test-server/test-echo.c | 31 +++--
430 test-server/test-fraggle.c | 32 ++---
431 test-server/test-ping.c | 52 ++++----
432 test-server/test-server.c | 129 ++++++++++++-------
433 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
434 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
435 41 files changed, 4398 insertions(+), 2219 deletions(-)
436
Andy Green7b405452013-02-01 10:50:15 +0800437
438User api additions
439------------------
440
441 - lws_get_library_version() returns a const char * with a string like
442 "1.1 9e7f737", representing the library version from configure.ac
443 and the git HEAD hash the library was built from
444
Andy Greena47865f2013-02-10 09:39:47 +0800445 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
446 also with controllable timeout, number of probes and probe interval.
447 (On BSD type OS, you can only use system default settings for the
448 timing and retries, although enabling it is supported by setting
449 ka_time to nonzero, the exact value has no meaning.)
450 This enables detection of idle connections which are logically okay,
451 but are in fact dead, due to network connectivity issues at the server,
Andy Greena690cd02013-02-09 12:25:31 +0800452 client, or any intermediary. By default it's not enabled, but you
453 can enable it by setting a non-zero timeout (in seconds) at the new
454 ka_time member at context creation time.
455
Andy Greena7109e62013-02-11 12:05:54 +0800456 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
457 is called one-time per protocol as the context is being destroyed, and
458 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
459 and the protocols are added, again it's a one-time affair.
460 This lets you manage per-protocol allocations properly including
461 cleaning up after yourself when the server goes down.
Andy Green7b405452013-02-01 10:50:15 +0800462
Andy Greened334462013-02-07 21:14:33 +0800463User api changes
464----------------
465
Andy Green1b265272013-02-09 14:01:09 +0800466 - libwebsocket_create_context() has changed from taking a ton of parameters
467 to just taking a pointer to a struct containing the parameters. The
468 struct lws_context_creation_info is in libwebsockets.h, the members
469 are in the same order as when they were parameters to the call
470 previously. The test apps are all updated accordingly so you can
471 see example code there.
472
Andy Greened334462013-02-07 21:14:33 +0800473 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +0900474 established. Not just the header data is saved, but the pointer and
475 length array is also removed from (union) scope saving several hundred
476 bytes per connection once it is established
477
478 - struct libwebsocket_protocols has a new member rx_buffer_size, this
479 controls rx buffer size per connection of that protocol now. Sources
480 for apps built against older versions of the library won't declare
481 this in their protocols, defaulting it to 0. Zero buffer is legal,
482 it causes a default buffer to be allocated (currently 4096)
483
484 If you want to receive only atomic frames in your user callback, you
485 should set this to greater than your largest frame size. If a frame
486 comes that exceeds that, no error occurs but the callback happens as
487 soon as the buffer limit is reached, and again if it is reached again
488 or the frame completes. You can detect that has happened by seeing
489 there is still frame content pending using
490 libwebsockets_remaining_packet_payload()
491
492 By correctly setting this, you can save a lot of memory when your
493 protocol has small frames (see the test server and client sources).
494
Andy Green16ab3182013-02-10 18:02:31 +0800495 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
496 header payload lws can cope with, that includes the GET URL, origin
497 etc. Headers not understood by lws are ignored and their payload
498 not included in this.
499
Andy Green54495112013-02-06 21:10:16 +0900500
501User api removals
502-----------------
503
Andy Green16ab3182013-02-10 18:02:31 +0800504 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
505 buffer size chosen per-protocol. For compatibility, there's a default
506 of 4096 rx buffer, but user code should set the appropriate size for
507 the protocol frames.
508
509 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
510 and have been removed. There's a new header management scheme that
511 handles them in a much more compact way.
Andy Greened334462013-02-07 21:14:33 +0800512
Andy Green70edd6f2013-02-12 10:15:25 +0800513 - libwebsockets_hangup_on_client() is removed. If you want to close the
514 connection you must do so from the user callback and by returning
515 -1 from there.
516
Andy Green508946c2013-02-12 10:19:08 +0800517 - libwebsocket_close_and_free_session() is now private to the library code
518 only and not exposed for user code. If you want to close the
519 connection, you must do so from the user callback by returning -1
520 from there.
521
Andy Greened334462013-02-07 21:14:33 +0800522
Andy Greendf60b0c2013-02-06 19:57:12 +0900523New features
524------------
525
Andy Green9b09dc02013-02-08 12:48:36 +0800526 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +0800527 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +0900528
Andy Greenc3ef0d62013-02-12 10:50:49 +0800529 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
530
Andy Green9b09dc02013-02-08 12:48:36 +0800531 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +0900532
Andy Green54495112013-02-06 21:10:16 +0900533 - cutomizable frame rx buffer size by protocol
534
Andy Greenc3ef0d62013-02-12 10:50:49 +0800535 - optional TCP keepalive so dead peers can be detected, can be enabled at
536 context-creation time
537
538 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
539 lost at OpenSSL library init and symptomless reports of uninitialized
540 memory usage... seems to be a known and ignored problem at OpenSSL
541
Andy Greena3957ef2013-02-11 09:31:43 +0800542 - By default debug is enabled and the library is built for -O0 -g to faclitate
543 that. Use --disable-debug configure option to build instead with -O4
544 and no -g (debug info), obviously providing best performance and
545 reduced binary size.
Andy Green7b405452013-02-01 10:50:15 +0800546
Andy Green895d56d2013-02-11 09:32:53 +0800547 - 1.0 introduced some code to try to not deflate small frames, however this
548 seems to break when confronted with a mixture of frames above and
549 below the threshold, so it's removed. Veto the compression extension
550 in your user callback if you will typically have very small frames.
551
Andy Green16ab3182013-02-10 18:02:31 +0800552 - There are many memory usage improvements, both a reduction in malloc/
553 realloc and architectural changes. A websocket connection now
554 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
555 during header processing an additional 1262 bytes is allocated in a
556 single malloc, but is freed when the websocket connection starts.
557 The RX frame buffer defined by the protocol in user
558 code is also allocated per connection, this represents the largest
559 frame you can receive atomically in that protocol.
560
Andy Greenc3ef0d62013-02-12 10:50:49 +0800561 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
562 and 112 bytes per connection (+1328 only during header processing)
563
Andy Green895d56d2013-02-11 09:32:53 +0800564
Andy Greenbd1132f2013-01-31 19:53:05 +0800565v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +0800566=======================
567
568Diffstat
569--------
570
571 Makefile.am | 4 +
572 README-test-server | 291 ---
573 README.build | 239 ++
574 README.coding | 138 ++
575 README.rst | 72 -
576 README.test-apps | 272 +++
577 configure.ac | 116 +-
578 lib/Makefile.am | 55 +-
579 lib/base64-decode.c | 5 +-
580 lib/client-handshake.c | 121 +-
581 lib/client-parser.c | 394 ++++
582 lib/client.c | 807 +++++++
583 lib/daemonize.c | 212 ++
584 lib/extension-deflate-frame.c | 132 +-
585 lib/extension-deflate-stream.c | 12 +-
586 lib/extension-x-google-mux.c | 1223 ----------
587 lib/extension-x-google-mux.h | 96 -
588 lib/extension.c | 8 -
589 lib/getifaddrs.c | 271 +++
590 lib/getifaddrs.h | 76 +
591 lib/handshake.c | 582 +----
592 lib/libwebsockets.c | 2493 ++++++---------------
593 lib/libwebsockets.h | 115 +-
594 lib/md5.c | 217 --
595 lib/minilex.c | 440 ++++
596 lib/output.c | 628 ++++++
597 lib/parsers.c | 2016 +++++------------
598 lib/private-libwebsockets.h | 284 +--
599 lib/server-handshake.c | 275 +++
600 lib/server.c | 377 ++++
601 libwebsockets-api-doc.html | 300 +--
602 m4/ignore-me | 2 +
603 test-server/Makefile.am | 111 +-
604 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
605 test-server/test-client.c | 45 +-
606 test-server/test-echo.c | 330 +++
607 test-server/test-fraggle.c | 20 +-
608 test-server/test-ping.c | 22 +-
609 test-server/test-server-extpoll.c | 554 -----
610 test-server/test-server.c | 349 ++-
611 test-server/test.html | 3 +-
612 win32port/zlib/ZLib.vcxproj | 749 ++++---
613 win32port/zlib/ZLib.vcxproj.filters | 188 +-
614 win32port/zlib/adler32.c | 348 ++-
615 win32port/zlib/compress.c | 160 +-
616 win32port/zlib/crc32.c | 867 ++++----
617 win32port/zlib/crc32.h | 882 ++++----
618 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
619 win32port/zlib/deflate.h | 688 +++---
620 win32port/zlib/gzclose.c | 50 +-
621 win32port/zlib/gzguts.h | 325 ++-
622 win32port/zlib/gzlib.c | 1157 +++++-----
623 win32port/zlib/gzread.c | 1242 ++++++-----
624 win32port/zlib/gzwrite.c | 1096 +++++----
625 win32port/zlib/infback.c | 1272 ++++++-----
626 win32port/zlib/inffast.c | 680 +++---
627 win32port/zlib/inffast.h | 22 +-
628 win32port/zlib/inffixed.h | 188 +-
629 win32port/zlib/inflate.c | 2976 +++++++++++++------------
630 win32port/zlib/inflate.h | 244 +-
631 win32port/zlib/inftrees.c | 636 +++---
632 win32port/zlib/inftrees.h | 124 +-
633 win32port/zlib/trees.c | 2468 +++++++++++----------
634 win32port/zlib/trees.h | 256 +--
635 win32port/zlib/uncompr.c | 118 +-
636 win32port/zlib/zconf.h | 934 ++++----
637 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
638 win32port/zlib/zutil.c | 642 +++---
639 win32port/zlib/zutil.h | 526 ++---
640 69 files changed, 19556 insertions(+), 20145 deletions(-)
641
642user api changes
643----------------
644
645 - libwebsockets_serve_http_file() now takes a context as first argument
646
647 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
648 two arguments
649
650
651user api additions
652------------------
653
654 - lwsl_...() logging apis, default to stderr but retargetable by user code;
655 may be used also by user code
656
657 - lws_set_log_level() set which logging apis are able to emit (defaults to
658 notice, warn, err severities), optionally set the emit callback
659
660 - lwsl_emit_syslog() helper callback emits to syslog
661
662 - lws_daemonize() helper code that forks the app into a headless daemon
663 properly, maintains a lock file with pid in suitable for sysvinit etc to
664 control lifecycle
665
666 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
667 transfer is now asynchronous (see test server code)
668
669 - lws_frame_is_binary() from a wsi pointer, let you know if the received
670 data was sent in BINARY mode
671
672
673user api removals
674-----------------
675
676 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
677 arrange your code to act from the user callback instead from same
678 process context as the service loop
679
680 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
681 instead from same process context as the service loop. See the test apps
682 for examples.
683
684 - x-google-mux() removed until someone wants it
685
686 - pre -v13 (ancient) protocol support removed
687
688
689New features
690------------
691
692 - echo test server and client compatible with echo.websocket.org added
693
694 - many new configure options (see README.build) to reduce footprint of the
695 library to what you actually need, eg, --without-client and
696 --without-server
697
698 - http + websocket server can build to as little as 12K .text for ARM
699
700 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
701 allowed to the process by ulimit, defaults to 1024 on Fedora and
702 Ubuntu. Use ulimit to control this without needing to configure
703 the library. Code here is smaller and faster.
704
705 - adaptive ratio of listen socket to connection socket service allows
706 good behaviour under Apache ab test load. Tested with thousands
707 of simultaneous connections
708
709 - reduction in per-connection memory footprint by moving to a union to hold
710 mutually-exclusive state for the connection
711
712 - robustness: Out of Memory taken care of for all allocation code now
713
714 - internal getifaddrs option if your toolchain lacks it (some uclibc)
715
716 - configurable memory limit for deflate operations
717
718 - improvements in SSL code nonblocking operation, possible hang solved,
719 some SSL operations broken down into pollable states so there is
720 no library blocking, timeout coverage for SSL_connect
721
722 - extpoll test server merged into single test server source
723
724 - robustness: library should deal with all recoverable socket conditions
725
726 - rx flowcontrol for backpressure notification fixed and implmeneted
727 correctly in the test server
728
729 - optimal lexical parser added for header processing; all headers in a
730 single 276-byte state table
731
732 - latency tracking api added (configure --with-latency)
733
734 - Improved in-tree documentation, REAME.build, README.coding,
735 README.test-apps, changelog
736
737 - Many small fixes
738
739
740v1.0-chrome25-firefox17 (6cd1ea9b005933f)