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