changelog

   1 Changelog
   2 ---------
   3
   4 (development since 1.1....)
   5
   6 User api additions
   7 ------------------
   8
   9  - lws_get_library_version() returns a const char * with a string like
  10          "1.1 9e7f737", representing the library version from configure.ac
  11          and the git HEAD hash the library was built from
  12
  13  - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
  14         also with controllable timeout, number of probes and probe interval.
  15         (On BSD type OS, you can only use system default settings for the
  16         timing and retries, although enabling it is supported by setting
  17         ka_time to nonzero, the exact value has no meaning.)
  18         This enables detection of idle connections which are logically okay,
  19         but are in fact dead, due to network connectivity issues at the server,
  20         client, or any intermediary.  By default it's not enabled, but you
  21         can enable it by setting a non-zero timeout (in seconds) at the new
  22         ka_time member at context creation time.
  23
  24  - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
  25         is called one-time per protocol as the context is being destroyed, and
  26         LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
  27         and the protocols are added, again it's a one-time affair.
  28         This lets you manage per-protocol allocations properly including
  29         cleaning up after yourself when the server goes down.
  30
  31 User api changes
  32 ----------------
  33
  34  - libwebsocket_create_context() has changed from taking a ton of parameters
  35         to just taking a pointer to a struct containing the parameters.  The
  36         struct lws_context_creation_info is in libwebsockets.h, the members
  37         are in the same order as when they were parameters to the call
  38         previously.  The test apps are all updated accordingly so you can
  39         see example code there.
  40
  41  - Header tokens are now deleted after the websocket connection is
  42         established.  Not just the header data is saved, but the pointer and
  43         length array is also removed from (union) scope saving several hundred
  44         bytes per connection once it is established
  45
  46  - struct libwebsocket_protocols has a new member rx_buffer_size, this
  47         controls rx buffer size per connection of that protocol now.  Sources
  48         for apps built against older versions of the library won't declare
  49         this in their protocols, defaulting it to 0.  Zero buffer is legal,
  50         it causes a default buffer to be allocated (currently 4096)
  51
  52         If you want to receive only atomic frames in your user callback, you
  53         should set this to greater than your largest frame size.  If a frame
  54         comes that exceeds that, no error occurs but the callback happens as
  55         soon as the buffer limit is reached, and again if it is reached again
  56         or the frame completes.  You can detect that has happened by seeing
  57         there is still frame content pending using
  58         libwebsockets_remaining_packet_payload()
  59
  60         By correctly setting this, you can save a lot of memory when your
  61         protocol has small frames (see the test server and client sources).
  62
  63  - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
  64         header payload lws can cope with, that includes the GET URL, origin
  65         etc.  Headers not understood by lws are ignored and their payload
  66         not included in this.
  67
  68
  69 User api removals
  70 -----------------
  71
  72  - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
  73         buffer size chosen per-protocol.  For compatibility, there's a default
  74         of 4096 rx buffer, but user code should set the appropriate size for
  75         the protocol frames.
  76
  77  - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
  78         and have been removed.  There's a new header management scheme that
  79         handles them in a much more compact way.
  80
  81
  82 New features
  83 ------------
  84
  85  - Cmake project file added, aimed initially at Windows support: this replaces
  86         the visual studio project files that were in the tree until now.
  87
  88  - PATH_MAX or MAX_PATH no longer needed
  89
  90  - cutomizable frame rx buffer size by protocol
  91
  92  - By default debug is enabled and the library is built for -O0 -g to faclitate
  93         that.  Use --disable-debug configure option to build instead with -O4
  94         and no -g (debug info), obviously providing best performance and
  95         reduced binary size.
  96
  97  - 1.0 introduced some code to try to not deflate small frames, however this
  98         seems to break when confronted with a mixture of frames above and
  99         below the threshold, so it's removed.  Veto the compression extension
 100         in your user callback if you will typically have very small frames.
 101
 102  - There are many memory usage improvements, both a reduction in malloc/
 103         realloc and architectural changes.  A websocket connection now
 104         consumes only 296 bytes with SSL or 272 bytes without on x86_64,
 105         during header processing an additional 1262 bytes is allocated in a
 106         single malloc, but is freed when the websocket connection starts.
 107         The RX frame buffer defined by the protocol in user
 108         code is also allocated per connection, this represents the largest
 109         frame you can receive atomically in that protocol.
 110
 111
 112 v1.1-chrome26-firefox18
 113 =======================
 114
 115 Diffstat
 116 --------
 117
 118  Makefile.am                            |    4 +
 119  README-test-server                     |  291 ---
 120  README.build                           |  239 ++
 121  README.coding                          |  138 ++
 122  README.rst                             |   72 -
 123  README.test-apps                       |  272 +++
 124  configure.ac                           |  116 +-
 125  lib/Makefile.am                        |   55 +-
 126  lib/base64-decode.c                    |    5 +-
 127  lib/client-handshake.c                 |  121 +-
 128  lib/client-parser.c                    |  394 ++++
 129  lib/client.c                           |  807 +++++++
 130  lib/daemonize.c                        |  212 ++
 131  lib/extension-deflate-frame.c          |  132 +-
 132  lib/extension-deflate-stream.c         |   12 +-
 133  lib/extension-x-google-mux.c           | 1223 ----------
 134  lib/extension-x-google-mux.h           |   96 -
 135  lib/extension.c                        |    8 -
 136  lib/getifaddrs.c                       |  271 +++
 137  lib/getifaddrs.h                       |   76 +
 138  lib/handshake.c                        |  582 +----
 139  lib/libwebsockets.c                    | 2493 ++++++---------------
 140  lib/libwebsockets.h                    |  115 +-
 141  lib/md5.c                              |  217 --
 142  lib/minilex.c                          |  440 ++++
 143  lib/output.c                           |  628 ++++++
 144  lib/parsers.c                          | 2016 +++++------------
 145  lib/private-libwebsockets.h            |  284 +--
 146  lib/server-handshake.c                 |  275 +++
 147  lib/server.c                           |  377 ++++
 148  libwebsockets-api-doc.html             |  300 +--
 149  m4/ignore-me                           |    2 +
 150  test-server/Makefile.am                |  111 +-
 151  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
 152  test-server/test-client.c              |   45 +-
 153  test-server/test-echo.c                |  330 +++
 154  test-server/test-fraggle.c             |   20 +-
 155  test-server/test-ping.c                |   22 +-
 156  test-server/test-server-extpoll.c      |  554 -----
 157  test-server/test-server.c              |  349 ++-
 158  test-server/test.html                  |    3 +-
 159  win32port/zlib/ZLib.vcxproj            |  749 ++++---
 160  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
 161  win32port/zlib/adler32.c               |  348 ++-
 162  win32port/zlib/compress.c              |  160 +-
 163  win32port/zlib/crc32.c                 |  867 ++++----
 164  win32port/zlib/crc32.h                 |  882 ++++----
 165  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
 166  win32port/zlib/deflate.h               |  688 +++---
 167  win32port/zlib/gzclose.c               |   50 +-
 168  win32port/zlib/gzguts.h                |  325 ++-
 169  win32port/zlib/gzlib.c                 | 1157 +++++-----
 170  win32port/zlib/gzread.c                | 1242 ++++++-----
 171  win32port/zlib/gzwrite.c               | 1096 +++++----
 172  win32port/zlib/infback.c               | 1272 ++++++-----
 173  win32port/zlib/inffast.c               |  680 +++---
 174  win32port/zlib/inffast.h               |   22 +-
 175  win32port/zlib/inffixed.h              |  188 +-
 176  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
 177  win32port/zlib/inflate.h               |  244 +-
 178  win32port/zlib/inftrees.c              |  636 +++---
 179  win32port/zlib/inftrees.h              |  124 +-
 180  win32port/zlib/trees.c                 | 2468 +++++++++++----------
 181  win32port/zlib/trees.h                 |  256 +--
 182  win32port/zlib/uncompr.c               |  118 +-
 183  win32port/zlib/zconf.h                 |  934 ++++----
 184  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
 185  win32port/zlib/zutil.c                 |  642 +++---
 186  win32port/zlib/zutil.h                 |  526 ++---
 187  69 files changed, 19556 insertions(+), 20145 deletions(-)
 188
 189 user api changes
 190 ----------------
 191
 192  - libwebsockets_serve_http_file() now takes a context as first argument
 193
 194  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
 195         two arguments
 196
 197
 198 user api additions
 199 ------------------
 200
 201  - lwsl_...() logging apis, default to stderr but retargetable by user code;
 202         may be used also by user code
 203
 204  - lws_set_log_level() set which logging apis are able to emit (defaults to
 205         notice, warn, err severities), optionally set the emit callback
 206
 207  - lwsl_emit_syslog() helper callback emits to syslog
 208
 209  - lws_daemonize() helper code that forks the app into a headless daemon
 210         properly, maintains a lock file with pid in suitable for sysvinit etc to
 211         control lifecycle
 212
 213  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
 214         transfer is now asynchronous (see test server code)
 215
 216  - lws_frame_is_binary() from a wsi pointer, let you know if the received
 217         data was sent in BINARY mode
 218
 219
 220 user api removals
 221 -----------------
 222
 223  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
 224         arrange your code to act from the user callback instead from same
 225         process context as the service loop
 226
 227  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
 228         instead from same process context as the service loop.  See the test apps
 229         for examples.
 230
 231  - x-google-mux() removed until someone wants it
 232
 233  - pre -v13 (ancient) protocol support removed
 234
 235
 236 New features
 237 ------------
 238
 239  - echo test server and client compatible with echo.websocket.org added
 240
 241  - many new configure options (see README.build) to reduce footprint of the
 242         library to what you actually need, eg, --without-client and
 243         --without-server
 244
 245  - http + websocket server can build to as little as 12K .text for ARM
 246
 247  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
 248         allowed to the process by ulimit, defaults to 1024 on Fedora and
 249         Ubuntu.  Use ulimit to control this without needing to configure
 250         the library.  Code here is smaller and faster.
 251
 252  - adaptive ratio of listen socket to connection socket service allows
 253         good behaviour under Apache ab test load.  Tested with thousands
 254         of simultaneous connections
 255
 256  - reduction in per-connection memory footprint by moving to a union to hold
 257         mutually-exclusive state for the connection
 258
 259  - robustness: Out of Memory taken care of for all allocation code now
 260
 261  - internal getifaddrs option if your toolchain lacks it (some uclibc)
 262
 263  - configurable memory limit for deflate operations
 264
 265  - improvements in SSL code nonblocking operation, possible hang solved,
 266         some SSL operations broken down into pollable states so there is
 267         no library blocking, timeout coverage for SSL_connect
 268
 269  - extpoll test server merged into single test server source
 270
 271  - robustness: library should deal with all recoverable socket conditions
 272
 273  - rx flowcontrol for backpressure notification fixed and implmeneted
 274         correctly in the test server
 275
 276  - optimal lexical parser added for header processing; all headers in a
 277         single 276-byte state table
 278
 279  - latency tracking api added (configure --with-latency)
 280
 281  - Improved in-tree documentation, REAME.build, README.coding,
 282         README.test-apps, changelog
 283
 284  - Many small fixes
 285
 286
 287 v1.0-chrome25-firefox17 (6cd1ea9b005933f)