blob: 3fc66e162c6d07bf23e7093e05746b0d10375082 [file] [log] [blame]
Andy Greena35c86f2013-01-31 10:16:44 +08001Changelog
2---------
3
Andy Green4e442b72015-12-10 07:58:58 +08004User api additions
5------------------
6
7lws now exposes his internal platform file abstraction in a way that can be
8both used by user code to make it platform-agnostic, and be overridden or
9subclassed by user code. This allows things like handling the URI "directory
10space" as a virtual filesystem that may or may not be backed by a regular
11filesystem. One example use is serving files from inside large compressed
12archive storage without having to unpack anything except the file being
13requested.
14
15The test server shows how to use it, basically the platform-specific part of
16lws prepares a file operations structure that lives in the lws context.
17
18The user code can get a pointer to the file operations struct
19
20LWS_VISIBLE LWS_EXTERN struct lws_plat_file_ops *
21lws_get_fops(struct lws_context *context);
22
23and then can use it with helpers to also leverage these platform-independent
24file handling apis
25
26static inline lws_filefd_type
27lws_plat_file_open(struct lws_plat_file_ops *fops, const char *filename,
28 unsigned long *filelen, int flags)
29
30static inline int
31lws_plat_file_close(struct lws_plat_file_ops *fops, lws_filefd_type fd)
32
33static inline unsigned long
34lws_plat_file_seek_cur(struct lws_plat_file_ops *fops, lws_filefd_type fd,
35 long offset_from_cur_pos)
36
37static inline int
38lws_plat_file_read(struct lws_plat_file_ops *fops, lws_filefd_type fd,
39 unsigned long *amount, unsigned char *buf, unsigned long len)
40
41static inline int
42lws_plat_file_write(struct lws_plat_file_ops *fops, lws_filefd_type fd,
43 unsigned long *amount, unsigned char *buf, unsigned long len)
44
45The user code can also override or subclass the file operations, to either
46wrap or replace them. An example is shown in test server.
47
48
Andy Green6d417202015-12-04 10:39:23 +080049User api changes
50----------------
51
52Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
53all begin lws_. These apis have been changed to all begin with lws_.
54
55However compatibility defines have been added in libwebsockets.h, so it is
56perfectly build-compatible with older sources using the old api names.
57
58If you are using lws with a distro, or otherwise can't rebuild the user code,
59you should add
60
61 -DLWS_WITH_OLD_API_WRAPPERS=1
62
63to your cmake args. This builds lws with all the old apis as wrappers around
64the new apis, so the library still exports the old apis.
65
66In this way you can have lws export both the new and old apis simultaneously
67for compatibility.
68
69
Andy Greenab620ff2015-10-28 08:39:09 +080070v1.5-chrome47-firefox41
71=======================
MGadkari020c53c2015-08-21 16:15:36 +053072
73User api changes
74----------------
75
76LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
77non-NULL. If so, the string has length len.
78
Andy Green6d59f592015-10-15 09:12:58 +080079LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
80for peer certs if you are using the option to require client certs.
81
Andy Green4c79ee72015-10-15 11:20:40 +080082LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
83externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
84
85
Andy Green16fb0132015-03-28 11:35:40 +080086v1.4-chrome43-firefox36
87=======================
Olehfaeac3c2014-07-29 23:18:41 +080088
89User api additions
90------------------
91
92There's a new member in the info struct used to control context creation,
93ssl_private_key_password, which allows passing into lws the passphrase on
94an SSL cetificate
95
Andy Greeneabed8d2014-08-11 12:11:36 +080096There's a new member in struct protocols, id, which is ignored by lws but can
97be used by the user code to mark the selected protocol by user-defined version
98or capabliity flag information, for the case multiple versions of a protocol are
99supported.
100
Andy Greenb128ccc2014-08-16 09:54:27 +0800101int lws_is_ssl(wsi) added to allow user code to know if the connection was made
102over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
103ssl and non-ssl connections are possible and may need to be treated differently
104in the user code.
105
Andy Green14425ea2014-08-18 22:49:39 +0800106int lws_partial_buffered(wsi) added... should be checked after any
107libwebsocket_write that will be followed by another libwebsocket_write inside
108the same writeable callback. If set, you can't do any more writes until the
109writeable callback is called again. If you only do one write per writeable callback,
110you can ignore this.
111
Andy Green917f43a2014-10-12 14:31:47 +0800112HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
113agnositic header creation APIs. These do the right thing depending on each
114connection's HTTP version without the user code having to know or care, except
115to make sure to use the new APIs for headers (test-server is updated to use
116them already, so look there for examples)
117
118The APIs "render" the headers into a user-provided buffer and bump *p as it
119is used. If *p reaches end, then the APIs return nonzero for error.
120
121LWS_VISIBLE LWS_EXTERN int
122lws_add_http_header_status(struct libwebsocket_context *context,
123 struct libwebsocket *wsi,
124 unsigned int code,
125 unsigned char **p,
126 unsigned char *end);
127
128Start a response header reporting status like 200, 500, etc
129
130LWS_VISIBLE LWS_EXTERN int
131lws_add_http_header_by_name(struct libwebsocket_context *context,
132 struct libwebsocket *wsi,
133 const unsigned char *name,
134 const unsigned char *value,
135 int length,
136 unsigned char **p,
137 unsigned char *end);
138
139Add a header like name: value in HTTP1.x
140
141LWS_VISIBLE LWS_EXTERN int
142lws_finalize_http_header(struct libwebsocket_context *context,
143 struct libwebsocket *wsi,
144 unsigned char **p,
145 unsigned char *end);
146
147Finish off the headers, like add the extra \r\n in HTTP1.x
148
149LWS_VISIBLE LWS_EXTERN int
150lws_add_http_header_by_token(struct libwebsocket_context *context,
151 struct libwebsocket *wsi,
152 enum lws_token_indexes token,
153 const unsigned char *value,
154 int length,
155 unsigned char **p,
156 unsigned char *end);
157
158Add a header by using a lws token as the name part. In HTTP2, this can be
159compressed to one or two bytes.
160
Olehfaeac3c2014-07-29 23:18:41 +0800161
Andy Green822241c2014-08-18 22:21:51 +0800162User api removal
163----------------
164
165protocols struct member no_buffer_all_partial_tx is removed. Under some
Peter Pentchevbb085da2015-12-03 15:55:11 +0200166conditions like rewriting extension such as compression in use, the built-in
Andy Green822241c2014-08-18 22:21:51 +0800167partial send buffering is the only way to deal with the problem, so turning
168it off is deprecated.
169
170
Andy Green917f43a2014-10-12 14:31:47 +0800171User api changes
172----------------
173
174HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
175the end now
176
177int other_headers_len)
178
179If you are providing other headers, they must be generated using the new
180HTTP-version-agnostic APIs, and you must provide the length of them using this
181additional parameter.
182
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800183struct lws_context_creation_info now has an additional member
184SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
185SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
186lws managing the context, if you memset the struct to 0 or have as a filescope
187initialized struct in bss, no need to change anything.
188
Andy Green822241c2014-08-18 22:21:51 +0800189
Andy Greenc1fdd102014-07-06 09:56:11 +0800190v1.3-chrome37-firefox30
191=======================
192
193 .gitignore | 1 -
194 CMakeLists.txt | 447 +++--
195 README.build | 35 +-
196 README.coding | 14 +
197 changelog | 66 +
198 cmake/LibwebsocketsConfig.cmake.in | 17 +
199 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
200 config.h.cmake | 18 +
201 cross-ming.cmake | 31 +
202 cross-openwrt-makefile | 91 +
203 lib/client-handshake.c | 205 ++-
204 lib/client-parser.c | 58 +-
205 lib/client.c | 158 +-
206 lib/context.c | 341 ++++
207 lib/extension-deflate-frame.c | 2 +-
208 lib/extension.c | 178 ++
209 lib/handshake.c | 287 +---
210 lib/lextable.h | 338 ++++
211 lib/libev.c | 175 ++
212 lib/libwebsockets.c | 2089 +++--------------------
213 lib/libwebsockets.h | 253 ++-
214 lib/lws-plat-unix.c | 404 +++++
215 lib/lws-plat-win.c | 358 ++++
216 lib/minilex.c | 530 +++---
217 lib/output.c | 445 ++---
218 lib/parsers.c | 682 ++++----
219 lib/pollfd.c | 239 +++
220 lib/private-libwebsockets.h | 501 +++++-
221 lib/server-handshake.c | 274 +--
222 lib/server.c | 858 ++++++++--
223 lib/service.c | 517 ++++++
224 lib/sha-1.c | 38 +-
225 lib/ssl-http2.c | 78 +
226 lib/ssl.c | 571 +++++++
227 test-server/attack.sh | 101 +-
228 test-server/test-client.c | 9 +-
229 test-server/test-echo.c | 17 +-
230 test-server/test-fraggle.c | 7 -
231 test-server/test-ping.c | 12 +-
232 test-server/test-server.c | 330 ++--
233 test-server/test.html | 4 +-
234 win32port/client/client.vcxproj | 259 ---
235 win32port/client/client.vcxproj.filters | 39 -
236 .../libwebsocketswin32.vcxproj.filters | 93 -
237 win32port/server/server.vcxproj | 276 ---
238 win32port/server/server.vcxproj.filters | 51 -
239 win32port/win32helpers/gettimeofday.h | 59 +-
240 win32port/win32helpers/netdb.h | 1 -
241 win32port/win32helpers/strings.h | 0
242 win32port/win32helpers/sys/time.h | 1 -
243 win32port/win32helpers/unistd.h | 0
244 win32port/win32helpers/websock-w32.c | 104 --
245 win32port/win32helpers/websock-w32.h | 62 -
246 win32port/win32port.sln | 100 --
247 win32port/zlib/gzio.c | 3 +-
248 55 files changed, 6779 insertions(+), 5059 deletions(-)
249
Andy Green79002562013-11-09 11:04:35 +0800250
kapejodce64fb02013-11-19 13:38:16 +0100251User api additions
252------------------
253
254POST method is supported
255
256The protocol 0 / HTTP callback can now get two new kinds of callback,
257LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
258and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
259and been passed to the user code already). These callbacks are used with the
260post method (see the test server for details).
261
262The period between the HTTP header completion and the completion of the body
263processing is protected by a 5s timeout.
264
265The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
266
267
James Devine5b34c972013-12-14 11:41:29 +0800268New server option you can enable from user code
269LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
270also be accepted on an SSL listening port. It's disabled unless you enable
271it explicitly.
272
273
Andy Green7a132792013-12-18 09:48:26 +0800274Two new callbacks are added in protocols[0] that are optional for allowing
275limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
276LWS_CALLBACK_UNLOCK_POLL.
277
278If you use them, they protect internal and external poll list changes, but if
279you want to use external thread access to libwebsocket_callback_on_writable()
280you have to implement your locking here even if you don't use external
281poll support.
282
283If you will use another thread for this, take a lot of care about managing
284your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
285(with your own locking).
286
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800287If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
288eventloop instead of the default poll() one will also be compiled in. But to
289use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
290creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800291
Andy Greenc1fdd102014-07-06 09:56:11 +0800292IPV6 is supported and enabled by default except for Windows, you can disable
293the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800294compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
295the context creation info struct options member.
296
Andy Greenc1fdd102014-07-06 09:56:11 +0800297You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
298guarantee the OS CAs will not be used, even if that support was selected at
299build-time.
300
301Optional "token limits" may be enforced by setting the member "token_limits"
302in struct lws_context_creation_info to point to a struct lws_token_limits.
303NULL means no token limits used for compatibility.
304
Andy Green7a132792013-12-18 09:48:26 +0800305
Andy Green79002562013-11-09 11:04:35 +0800306User api changes
307----------------
308
309Extra optional argument to libwebsockets_serve_http_file() allows injecion
310of HTTP headers into the canned response. Eg, cookies may be added like
311that without getting involved in having to send the header by hand.
312
Patrick Gansterer148b9452014-02-28 02:31:23 +0100313A new info member http_proxy_address may be used at context creation time to
314set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800315
Andy Greend2ec7ad2014-03-15 10:39:29 +0800316Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
317the client to use the OS CA Roots. If you're worried somebody with the
318ability to forge for force creation of a client cert from the root CA in
319your OS, you should disable this since your selfsigned $0 cert is a lot safer
320then...
321
Andy Green79002562013-11-09 11:04:35 +0800322
Andy Green81877e62013-10-26 20:36:08 +0800323v1.23-chrome32-firefox24
324========================
325
326 Android.mk | 29 +
327 CMakeLists.txt | 573 ++++++++----
328 COPYING | 503 -----------
329 INSTALL | 365 --------
330 Makefile.am | 13 -
331 README.build | 371 ++------
332 README.coding | 63 ++
333 autogen.sh | 1578 ---------------------------------
334 changelog | 69 ++
335 cmake/FindGit.cmake | 163 ++++
336 cmake/FindOpenSSLbins.cmake | 15 +-
337 cmake/UseRPMTools.cmake | 176 ++++
338 config.h.cmake | 25 +-
339 configure.ac | 226 -----
340 cross-arm-linux-gnueabihf.cmake | 28 +
341 lib/Makefile.am | 89 --
342 lib/base64-decode.c | 98 +-
343 lib/client-handshake.c | 123 ++-
344 lib/client-parser.c | 19 +-
345 lib/client.c | 145 ++-
346 lib/daemonize.c | 4 +-
347 lib/extension.c | 2 +-
348 lib/getifaddrs.h | 4 +-
349 lib/handshake.c | 76 +-
350 lib/libwebsockets.c | 491 ++++++----
351 lib/libwebsockets.h | 164 ++--
352 lib/output.c | 214 ++++-
353 lib/parsers.c | 102 +--
354 lib/private-libwebsockets.h | 66 +-
355 lib/server-handshake.c | 5 +-
356 lib/server.c | 29 +-
357 lib/sha-1.c | 2 +-
358 libwebsockets-api-doc.html | 249 +++---
359 libwebsockets.pc.in | 11 -
360 libwebsockets.spec | 14 +-
361 m4/ignore-me | 2 -
362 scripts/FindLibWebSockets.cmake | 33 +
363 scripts/kernel-doc | 1 +
364 test-server/Makefile.am | 131 ---
365 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
366 test-server/test-client.c | 78 +-
367 test-server/test-echo.c | 33 +-
368 test-server/test-fraggle.c | 26 +-
369 test-server/test-ping.c | 15 +-
370 test-server/test-server.c | 197 +++-
371 test-server/test.html | 5 +-
372 win32port/win32helpers/gettimeofday.c | 74 +-
373 win32port/win32helpers/websock-w32.h | 6 +-
374 48 files changed, 2493 insertions(+), 4212 deletions(-)
375
Andy Green54cb3462013-02-14 22:23:54 +0800376
377User api additions
378------------------
379
380 - You can now call libwebsocket_callback_on_writable() on http connectons,
381 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
382 regulate writes with a websocket protocol connection.
383
Andy Green2672fb22013-02-22 09:54:35 +0800384 - A new member in the context creation parameter struct "ssl_cipher_list" is
385 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
386 default list of ciphers.
387
Andy Green58f214e2013-03-09 13:03:53 +0800388 - Not really an api addition, but libwebsocket_service_fd() will now zero
389 the revents field of the pollfd it was called with if it handled the
390 descriptor. So you can tell if it is a non-lws fd by checking revents
391 after the service call... if it's still nonzero, the descriptor
392 belongs to you and you need to take care of it.
393
Andy Greenb55451c2013-03-16 12:32:27 +0800394 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
395 connections with the established protocol. It's designed to be
396 called from user server code when it sees it can accept more input
397 and may have throttled connections using the server rx flow apis
398 while it was unable to accept any other input The user server code
399 then does not have to try to track while connections it choked, this
400 will free up all of them in one call.
401
Andy Green0c9563b2013-06-10 22:54:40 +0800402 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
403 called when an HTTP protocol socket closes
404
Andy Green96d48fd2013-09-18 08:32:55 +0800405 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
406 has already been done before the callback happens. That means we can
407 use the user parameter to the callback to contain the user pointer, and
408 move the protocol name to the "in" parameter. The docs for this
409 callback are also updated to reflect how to check headers in there.
410
Andy Green5dc62ea2013-09-20 20:26:12 +0800411 - libwebsocket_client_connect() is now properly nonblocking and async. See
412 README.coding and test-client.c for information on the callbacks you
413 can rely on controlling the async connection period with.
414
Andy Green81877e62013-10-26 20:36:08 +0800415 - if your OS does not support the http_proxy environment variable convention
416 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
Peter Pentchevbb085da2015-12-03 15:55:11 +0200417 to set the proxy details in between context creation and the connection
Andy Green81877e62013-10-26 20:36:08 +0800418 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +0800419
Andy Green50097dd2013-02-15 22:36:30 +0800420User api changes
421----------------
422
423 - the external poll callbacks now get the socket descriptor coming from the
424 "in" parameter. The user parameter provides the user_space for the
425 wsi as it normally does on the other callbacks.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +0800426 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
427 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +0800428
Andy Greenfc7c5e42013-02-23 10:50:10 +0800429 - libwebsocket_write() now returns -1 for error, or the amount of data
430 actually accepted for send. Under load, the OS may signal it is
431 ready to send new data on the socket, but have only a restricted
432 amount of memory to buffer the packet compared to usual.
433
Andy Green50097dd2013-02-15 22:36:30 +0800434
Andy Greendc914cf2013-02-18 16:54:26 +0800435User api removal
436----------------
437
438 - libwebsocket_ensure_user_space() is removed from the public api, if you
439 were using it to get user_space, you need to adapt your code to only
440 use user_space inside the user callback.
441
Andy Green2672fb22013-02-22 09:54:35 +0800442 - CIPHERS_LIST_STRING is removed
443
Andy Green0097a992013-03-09 13:06:37 +0800444 - autotools build has been removed. See README.build for info on how to
445 use CMake for your platform
446
Andy Green54cb3462013-02-14 22:23:54 +0800447
Andy Green53a46782013-02-14 11:23:49 +0800448v1.21-chrome26-firefox18
449========================
450
451 - Fixes buffer overflow bug in max frame size handling if you used the
452 default protocol buffer size. If you declared rx_buffer_size in your
453 protocol, which is recommended anyway, your code was unaffected.
454
Andy Green182cb9a2013-02-13 11:54:08 +0800455v1.2-chrome26-firefox18
456=======================
457
458Diffstat
459--------
460
461 .gitignore | 16 +++
462 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
463 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
464 Makefile.am | 1 +
465 README | 20 +++
466 README.build | 258 ++++++++++++++++++++++++++++++++-----
467 README.coding | 52 ++++++++
468 changelog | 136 ++++++++++++++++++++
469 cmake/FindOpenSSLbins.cmake | 33 +++++
470 config.h.cmake | 173 +++++++++++++++++++++++++
471 configure.ac | 22 +++-
472 lib/Makefile.am | 20 ++-
473 lib/base64-decode.c | 2 +-
474 lib/client-handshake.c | 190 +++++++++++-----------------
475 lib/client-parser.c | 88 +++++++------
476 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
477 lib/daemonize.c | 32 +++--
478 lib/extension-deflate-frame.c | 58 +++++----
479 lib/extension-deflate-stream.c | 19 ++-
480 lib/extension-deflate-stream.h | 4 +-
481 lib/extension.c | 11 +-
482 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
483 lib/getifaddrs.h | 30 ++---
484 lib/handshake.c | 124 +++++++++++-------
485 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
486 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
487 lib/output.c | 192 +++++++++++-----------------
488 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
489 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
490 lib/server-handshake.c | 82 ++++++------
491 lib/server.c | 96 +++++++-------
492 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
493 libwebsockets.spec | 17 +--
494 test-server/attack.sh | 148 ++++++++++++++++++++++
495 test-server/test-client.c | 125 +++++++++---------
496 test-server/test-echo.c | 31 +++--
497 test-server/test-fraggle.c | 32 ++---
498 test-server/test-ping.c | 52 ++++----
499 test-server/test-server.c | 129 ++++++++++++-------
500 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
501 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
502 41 files changed, 4398 insertions(+), 2219 deletions(-)
503
Andy Green7b405452013-02-01 10:50:15 +0800504
505User api additions
506------------------
507
508 - lws_get_library_version() returns a const char * with a string like
509 "1.1 9e7f737", representing the library version from configure.ac
510 and the git HEAD hash the library was built from
511
Andy Greena47865f2013-02-10 09:39:47 +0800512 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
513 also with controllable timeout, number of probes and probe interval.
514 (On BSD type OS, you can only use system default settings for the
515 timing and retries, although enabling it is supported by setting
516 ka_time to nonzero, the exact value has no meaning.)
517 This enables detection of idle connections which are logically okay,
518 but are in fact dead, due to network connectivity issues at the server,
Andy Greena690cd02013-02-09 12:25:31 +0800519 client, or any intermediary. By default it's not enabled, but you
520 can enable it by setting a non-zero timeout (in seconds) at the new
521 ka_time member at context creation time.
522
Andy Greena7109e62013-02-11 12:05:54 +0800523 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
524 is called one-time per protocol as the context is being destroyed, and
525 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
526 and the protocols are added, again it's a one-time affair.
527 This lets you manage per-protocol allocations properly including
528 cleaning up after yourself when the server goes down.
Andy Green7b405452013-02-01 10:50:15 +0800529
Andy Greened334462013-02-07 21:14:33 +0800530User api changes
531----------------
532
Andy Green1b265272013-02-09 14:01:09 +0800533 - libwebsocket_create_context() has changed from taking a ton of parameters
534 to just taking a pointer to a struct containing the parameters. The
535 struct lws_context_creation_info is in libwebsockets.h, the members
536 are in the same order as when they were parameters to the call
537 previously. The test apps are all updated accordingly so you can
538 see example code there.
539
Andy Greened334462013-02-07 21:14:33 +0800540 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +0900541 established. Not just the header data is saved, but the pointer and
542 length array is also removed from (union) scope saving several hundred
543 bytes per connection once it is established
544
545 - struct libwebsocket_protocols has a new member rx_buffer_size, this
546 controls rx buffer size per connection of that protocol now. Sources
547 for apps built against older versions of the library won't declare
548 this in their protocols, defaulting it to 0. Zero buffer is legal,
549 it causes a default buffer to be allocated (currently 4096)
550
551 If you want to receive only atomic frames in your user callback, you
552 should set this to greater than your largest frame size. If a frame
553 comes that exceeds that, no error occurs but the callback happens as
554 soon as the buffer limit is reached, and again if it is reached again
555 or the frame completes. You can detect that has happened by seeing
556 there is still frame content pending using
557 libwebsockets_remaining_packet_payload()
558
559 By correctly setting this, you can save a lot of memory when your
560 protocol has small frames (see the test server and client sources).
561
Andy Green16ab3182013-02-10 18:02:31 +0800562 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
563 header payload lws can cope with, that includes the GET URL, origin
564 etc. Headers not understood by lws are ignored and their payload
565 not included in this.
566
Andy Green54495112013-02-06 21:10:16 +0900567
568User api removals
569-----------------
570
Andy Green16ab3182013-02-10 18:02:31 +0800571 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
572 buffer size chosen per-protocol. For compatibility, there's a default
573 of 4096 rx buffer, but user code should set the appropriate size for
574 the protocol frames.
575
576 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
577 and have been removed. There's a new header management scheme that
578 handles them in a much more compact way.
Andy Greened334462013-02-07 21:14:33 +0800579
Andy Green70edd6f2013-02-12 10:15:25 +0800580 - libwebsockets_hangup_on_client() is removed. If you want to close the
581 connection you must do so from the user callback and by returning
582 -1 from there.
583
Andy Green508946c2013-02-12 10:19:08 +0800584 - libwebsocket_close_and_free_session() is now private to the library code
585 only and not exposed for user code. If you want to close the
586 connection, you must do so from the user callback by returning -1
587 from there.
588
Andy Greened334462013-02-07 21:14:33 +0800589
Andy Greendf60b0c2013-02-06 19:57:12 +0900590New features
591------------
592
Andy Green9b09dc02013-02-08 12:48:36 +0800593 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +0800594 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +0900595
Andy Greenc3ef0d62013-02-12 10:50:49 +0800596 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
597
Andy Green9b09dc02013-02-08 12:48:36 +0800598 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +0900599
Andy Green54495112013-02-06 21:10:16 +0900600 - cutomizable frame rx buffer size by protocol
601
Andy Greenc3ef0d62013-02-12 10:50:49 +0800602 - optional TCP keepalive so dead peers can be detected, can be enabled at
603 context-creation time
604
605 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
606 lost at OpenSSL library init and symptomless reports of uninitialized
607 memory usage... seems to be a known and ignored problem at OpenSSL
608
Andy Greena3957ef2013-02-11 09:31:43 +0800609 - By default debug is enabled and the library is built for -O0 -g to faclitate
610 that. Use --disable-debug configure option to build instead with -O4
611 and no -g (debug info), obviously providing best performance and
612 reduced binary size.
Andy Green7b405452013-02-01 10:50:15 +0800613
Andy Green895d56d2013-02-11 09:32:53 +0800614 - 1.0 introduced some code to try to not deflate small frames, however this
615 seems to break when confronted with a mixture of frames above and
616 below the threshold, so it's removed. Veto the compression extension
617 in your user callback if you will typically have very small frames.
618
Andy Green16ab3182013-02-10 18:02:31 +0800619 - There are many memory usage improvements, both a reduction in malloc/
620 realloc and architectural changes. A websocket connection now
621 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
622 during header processing an additional 1262 bytes is allocated in a
623 single malloc, but is freed when the websocket connection starts.
624 The RX frame buffer defined by the protocol in user
625 code is also allocated per connection, this represents the largest
626 frame you can receive atomically in that protocol.
627
Andy Greenc3ef0d62013-02-12 10:50:49 +0800628 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
629 and 112 bytes per connection (+1328 only during header processing)
630
Andy Green895d56d2013-02-11 09:32:53 +0800631
Andy Greenbd1132f2013-01-31 19:53:05 +0800632v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +0800633=======================
634
635Diffstat
636--------
637
638 Makefile.am | 4 +
639 README-test-server | 291 ---
640 README.build | 239 ++
641 README.coding | 138 ++
642 README.rst | 72 -
643 README.test-apps | 272 +++
644 configure.ac | 116 +-
645 lib/Makefile.am | 55 +-
646 lib/base64-decode.c | 5 +-
647 lib/client-handshake.c | 121 +-
648 lib/client-parser.c | 394 ++++
649 lib/client.c | 807 +++++++
650 lib/daemonize.c | 212 ++
651 lib/extension-deflate-frame.c | 132 +-
652 lib/extension-deflate-stream.c | 12 +-
653 lib/extension-x-google-mux.c | 1223 ----------
654 lib/extension-x-google-mux.h | 96 -
655 lib/extension.c | 8 -
656 lib/getifaddrs.c | 271 +++
657 lib/getifaddrs.h | 76 +
658 lib/handshake.c | 582 +----
659 lib/libwebsockets.c | 2493 ++++++---------------
660 lib/libwebsockets.h | 115 +-
661 lib/md5.c | 217 --
662 lib/minilex.c | 440 ++++
663 lib/output.c | 628 ++++++
664 lib/parsers.c | 2016 +++++------------
665 lib/private-libwebsockets.h | 284 +--
666 lib/server-handshake.c | 275 +++
667 lib/server.c | 377 ++++
668 libwebsockets-api-doc.html | 300 +--
669 m4/ignore-me | 2 +
670 test-server/Makefile.am | 111 +-
671 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
672 test-server/test-client.c | 45 +-
673 test-server/test-echo.c | 330 +++
674 test-server/test-fraggle.c | 20 +-
675 test-server/test-ping.c | 22 +-
676 test-server/test-server-extpoll.c | 554 -----
677 test-server/test-server.c | 349 ++-
678 test-server/test.html | 3 +-
679 win32port/zlib/ZLib.vcxproj | 749 ++++---
680 win32port/zlib/ZLib.vcxproj.filters | 188 +-
681 win32port/zlib/adler32.c | 348 ++-
682 win32port/zlib/compress.c | 160 +-
683 win32port/zlib/crc32.c | 867 ++++----
684 win32port/zlib/crc32.h | 882 ++++----
685 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
686 win32port/zlib/deflate.h | 688 +++---
687 win32port/zlib/gzclose.c | 50 +-
688 win32port/zlib/gzguts.h | 325 ++-
689 win32port/zlib/gzlib.c | 1157 +++++-----
690 win32port/zlib/gzread.c | 1242 ++++++-----
691 win32port/zlib/gzwrite.c | 1096 +++++----
692 win32port/zlib/infback.c | 1272 ++++++-----
693 win32port/zlib/inffast.c | 680 +++---
694 win32port/zlib/inffast.h | 22 +-
695 win32port/zlib/inffixed.h | 188 +-
696 win32port/zlib/inflate.c | 2976 +++++++++++++------------
697 win32port/zlib/inflate.h | 244 +-
698 win32port/zlib/inftrees.c | 636 +++---
699 win32port/zlib/inftrees.h | 124 +-
700 win32port/zlib/trees.c | 2468 +++++++++++----------
701 win32port/zlib/trees.h | 256 +--
702 win32port/zlib/uncompr.c | 118 +-
703 win32port/zlib/zconf.h | 934 ++++----
704 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
705 win32port/zlib/zutil.c | 642 +++---
706 win32port/zlib/zutil.h | 526 ++---
707 69 files changed, 19556 insertions(+), 20145 deletions(-)
708
709user api changes
710----------------
711
712 - libwebsockets_serve_http_file() now takes a context as first argument
713
714 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
715 two arguments
716
717
718user api additions
719------------------
720
721 - lwsl_...() logging apis, default to stderr but retargetable by user code;
722 may be used also by user code
723
724 - lws_set_log_level() set which logging apis are able to emit (defaults to
725 notice, warn, err severities), optionally set the emit callback
726
727 - lwsl_emit_syslog() helper callback emits to syslog
728
729 - lws_daemonize() helper code that forks the app into a headless daemon
730 properly, maintains a lock file with pid in suitable for sysvinit etc to
731 control lifecycle
732
733 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
734 transfer is now asynchronous (see test server code)
735
736 - lws_frame_is_binary() from a wsi pointer, let you know if the received
737 data was sent in BINARY mode
738
739
740user api removals
741-----------------
742
743 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
744 arrange your code to act from the user callback instead from same
745 process context as the service loop
746
747 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
748 instead from same process context as the service loop. See the test apps
749 for examples.
750
751 - x-google-mux() removed until someone wants it
752
753 - pre -v13 (ancient) protocol support removed
754
755
756New features
757------------
758
759 - echo test server and client compatible with echo.websocket.org added
760
761 - many new configure options (see README.build) to reduce footprint of the
762 library to what you actually need, eg, --without-client and
763 --without-server
764
765 - http + websocket server can build to as little as 12K .text for ARM
766
767 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
768 allowed to the process by ulimit, defaults to 1024 on Fedora and
769 Ubuntu. Use ulimit to control this without needing to configure
770 the library. Code here is smaller and faster.
771
772 - adaptive ratio of listen socket to connection socket service allows
773 good behaviour under Apache ab test load. Tested with thousands
774 of simultaneous connections
775
776 - reduction in per-connection memory footprint by moving to a union to hold
777 mutually-exclusive state for the connection
778
779 - robustness: Out of Memory taken care of for all allocation code now
780
781 - internal getifaddrs option if your toolchain lacks it (some uclibc)
782
783 - configurable memory limit for deflate operations
784
785 - improvements in SSL code nonblocking operation, possible hang solved,
786 some SSL operations broken down into pollable states so there is
787 no library blocking, timeout coverage for SSL_connect
788
789 - extpoll test server merged into single test server source
790
791 - robustness: library should deal with all recoverable socket conditions
792
793 - rx flowcontrol for backpressure notification fixed and implmeneted
794 correctly in the test server
795
796 - optimal lexical parser added for header processing; all headers in a
797 single 276-byte state table
798
799 - latency tracking api added (configure --with-latency)
800
801 - Improved in-tree documentation, REAME.build, README.coding,
802 README.test-apps, changelog
803
804 - Many small fixes
805
806
807v1.0-chrome25-firefox17 (6cd1ea9b005933f)