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  - libwebsockets_hangup_on_client() is removed.  If you want to close the
  82         connection you must do so from the user callback and by returning
  83         -1 from there.
  84
  85  - libwebsocket_close_and_free_session() is now private to the library code
  86         only and not exposed for user code.  If you want to close the
  87         connection, you must do so from the user callback by returning -1
  88         from there.
  89
  90
  91 New features
  92 ------------
  93
  94  - Cmake project file added, aimed initially at Windows support: this replaces
  95         the visual studio project files that were in the tree until now.
  96
  97  - PATH_MAX or MAX_PATH no longer needed
  98
  99  - cutomizable frame rx buffer size by protocol
 100
 101  - By default debug is enabled and the library is built for -O0 -g to faclitate
 102         that.  Use --disable-debug configure option to build instead with -O4
 103         and no -g (debug info), obviously providing best performance and
 104         reduced binary size.
 105
 106  - 1.0 introduced some code to try to not deflate small frames, however this
 107         seems to break when confronted with a mixture of frames above and
 108         below the threshold, so it's removed.  Veto the compression extension
 109         in your user callback if you will typically have very small frames.
 110
 111  - There are many memory usage improvements, both a reduction in malloc/
 112         realloc and architectural changes.  A websocket connection now
 113         consumes only 296 bytes with SSL or 272 bytes without on x86_64,
 114         during header processing an additional 1262 bytes is allocated in a
 115         single malloc, but is freed when the websocket connection starts.
 116         The RX frame buffer defined by the protocol in user
 117         code is also allocated per connection, this represents the largest
 118         frame you can receive atomically in that protocol.
 119
 120
 121 v1.1-chrome26-firefox18
 122 =======================
 123
 124 Diffstat
 125 --------
 126
 127  Makefile.am                            |    4 +
 128  README-test-server                     |  291 ---
 129  README.build                           |  239 ++
 130  README.coding                          |  138 ++
 131  README.rst                             |   72 -
 132  README.test-apps                       |  272 +++
 133  configure.ac                           |  116 +-
 134  lib/Makefile.am                        |   55 +-
 135  lib/base64-decode.c                    |    5 +-
 136  lib/client-handshake.c                 |  121 +-
 137  lib/client-parser.c                    |  394 ++++
 138  lib/client.c                           |  807 +++++++
 139  lib/daemonize.c                        |  212 ++
 140  lib/extension-deflate-frame.c          |  132 +-
 141  lib/extension-deflate-stream.c         |   12 +-
 142  lib/extension-x-google-mux.c           | 1223 ----------
 143  lib/extension-x-google-mux.h           |   96 -
 144  lib/extension.c                        |    8 -
 145  lib/getifaddrs.c                       |  271 +++
 146  lib/getifaddrs.h                       |   76 +
 147  lib/handshake.c                        |  582 +----
 148  lib/libwebsockets.c                    | 2493 ++++++---------------
 149  lib/libwebsockets.h                    |  115 +-
 150  lib/md5.c                              |  217 --
 151  lib/minilex.c                          |  440 ++++
 152  lib/output.c                           |  628 ++++++
 153  lib/parsers.c                          | 2016 +++++------------
 154  lib/private-libwebsockets.h            |  284 +--
 155  lib/server-handshake.c                 |  275 +++
 156  lib/server.c                           |  377 ++++
 157  libwebsockets-api-doc.html             |  300 +--
 158  m4/ignore-me                           |    2 +
 159  test-server/Makefile.am                |  111 +-
 160  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
 161  test-server/test-client.c              |   45 +-
 162  test-server/test-echo.c                |  330 +++
 163  test-server/test-fraggle.c             |   20 +-
 164  test-server/test-ping.c                |   22 +-
 165  test-server/test-server-extpoll.c      |  554 -----
 166  test-server/test-server.c              |  349 ++-
 167  test-server/test.html                  |    3 +-
 168  win32port/zlib/ZLib.vcxproj            |  749 ++++---
 169  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
 170  win32port/zlib/adler32.c               |  348 ++-
 171  win32port/zlib/compress.c              |  160 +-
 172  win32port/zlib/crc32.c                 |  867 ++++----
 173  win32port/zlib/crc32.h                 |  882 ++++----
 174  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
 175  win32port/zlib/deflate.h               |  688 +++---
 176  win32port/zlib/gzclose.c               |   50 +-
 177  win32port/zlib/gzguts.h                |  325 ++-
 178  win32port/zlib/gzlib.c                 | 1157 +++++-----
 179  win32port/zlib/gzread.c                | 1242 ++++++-----
 180  win32port/zlib/gzwrite.c               | 1096 +++++----
 181  win32port/zlib/infback.c               | 1272 ++++++-----
 182  win32port/zlib/inffast.c               |  680 +++---
 183  win32port/zlib/inffast.h               |   22 +-
 184  win32port/zlib/inffixed.h              |  188 +-
 185  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
 186  win32port/zlib/inflate.h               |  244 +-
 187  win32port/zlib/inftrees.c              |  636 +++---
 188  win32port/zlib/inftrees.h              |  124 +-
 189  win32port/zlib/trees.c                 | 2468 +++++++++++----------
 190  win32port/zlib/trees.h                 |  256 +--
 191  win32port/zlib/uncompr.c               |  118 +-
 192  win32port/zlib/zconf.h                 |  934 ++++----
 193  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
 194  win32port/zlib/zutil.c                 |  642 +++---
 195  win32port/zlib/zutil.h                 |  526 ++---
 196  69 files changed, 19556 insertions(+), 20145 deletions(-)
 197
 198 user api changes
 199 ----------------
 200
 201  - libwebsockets_serve_http_file() now takes a context as first argument
 202
 203  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
 204         two arguments
 205
 206
 207 user api additions
 208 ------------------
 209
 210  - lwsl_...() logging apis, default to stderr but retargetable by user code;
 211         may be used also by user code
 212
 213  - lws_set_log_level() set which logging apis are able to emit (defaults to
 214         notice, warn, err severities), optionally set the emit callback
 215
 216  - lwsl_emit_syslog() helper callback emits to syslog
 217
 218  - lws_daemonize() helper code that forks the app into a headless daemon
 219         properly, maintains a lock file with pid in suitable for sysvinit etc to
 220         control lifecycle
 221
 222  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
 223         transfer is now asynchronous (see test server code)
 224
 225  - lws_frame_is_binary() from a wsi pointer, let you know if the received
 226         data was sent in BINARY mode
 227
 228
 229 user api removals
 230 -----------------
 231
 232  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
 233         arrange your code to act from the user callback instead from same
 234         process context as the service loop
 235
 236  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
 237         instead from same process context as the service loop.  See the test apps
 238         for examples.
 239
 240  - x-google-mux() removed until someone wants it
 241
 242  - pre -v13 (ancient) protocol support removed
 243
 244
 245 New features
 246 ------------
 247
 248  - echo test server and client compatible with echo.websocket.org added
 249
 250  - many new configure options (see README.build) to reduce footprint of the
 251         library to what you actually need, eg, --without-client and
 252         --without-server
 253
 254  - http + websocket server can build to as little as 12K .text for ARM
 255
 256  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
 257         allowed to the process by ulimit, defaults to 1024 on Fedora and
 258         Ubuntu.  Use ulimit to control this without needing to configure
 259         the library.  Code here is smaller and faster.
 260
 261  - adaptive ratio of listen socket to connection socket service allows
 262         good behaviour under Apache ab test load.  Tested with thousands
 263         of simultaneous connections
 264
 265  - reduction in per-connection memory footprint by moving to a union to hold
 266         mutually-exclusive state for the connection
 267
 268  - robustness: Out of Memory taken care of for all allocation code now
 269
 270  - internal getifaddrs option if your toolchain lacks it (some uclibc)
 271
 272  - configurable memory limit for deflate operations
 273
 274  - improvements in SSL code nonblocking operation, possible hang solved,
 275         some SSL operations broken down into pollable states so there is
 276         no library blocking, timeout coverage for SSL_connect
 277
 278  - extpoll test server merged into single test server source
 279
 280  - robustness: library should deal with all recoverable socket conditions
 281
 282  - rx flowcontrol for backpressure notification fixed and implmeneted
 283         correctly in the test server
 284
 285  - optimal lexical parser added for header processing; all headers in a
 286         single 276-byte state table
 287
 288  - latency tracking api added (configure --with-latency)
 289
 290  - Improved in-tree documentation, REAME.build, README.coding,
 291         README.test-apps, changelog
 292
 293  - Many small fixes
 294
 295
 296 v1.0-chrome25-firefox17 (6cd1ea9b005933f)