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
  14 User api changes
  15 ----------------
  16
  17  - libwebsocket_create_context() has changed from taking a ton of parameters
  18         to just taking a pointer to a struct containing the parameters.  The
  19         struct lws_context_creation_info is in libwebsockets.h, the members
  20         are in the same order as when they were parameters to the call
  21         previously.  The test apps are all updated accordingly so you can
  22         see example code there.
  23
  24  - Header tokens are now deleted after the websocket connection is
  25         established.  Not just the header data is saved, but the pointer and
  26         length array is also removed from (union) scope saving several hundred
  27         bytes per connection once it is established
  28
  29  - struct libwebsocket_protocols has a new member rx_buffer_size, this
  30         controls rx buffer size per connection of that protocol now.  Sources
  31         for apps built against older versions of the library won't declare
  32         this in their protocols, defaulting it to 0.  Zero buffer is legal,
  33         it causes a default buffer to be allocated (currently 4096)
  34
  35         If you want to receive only atomic frames in your user callback, you
  36         should set this to greater than your largest frame size.  If a frame
  37         comes that exceeds that, no error occurs but the callback happens as
  38         soon as the buffer limit is reached, and again if it is reached again
  39         or the frame completes.  You can detect that has happened by seeing
  40         there is still frame content pending using
  41         libwebsockets_remaining_packet_payload()
  42
  43         By correctly setting this, you can save a lot of memory when your
  44         protocol has small frames (see the test server and client sources).
  45
  46
  47 User api removals
  48 -----------------
  49
  50 The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
  51 buffer size chosen per-protocol.  For compatibility, there's a default of
  52 4096 rx buffer, but user code should set the appropriate size for the
  53 protocol frames.
  54
  55
  56 New features
  57 ------------
  58
  59  - Cmake project file added, aimed initially at Windows support: this replaces
  60 the visual studio project files that were in the tree until now.
  61
  62  - PATH_MAX or MAX_PATH no longer needed
  63
  64  - cutomizable frame rx buffer size by protocol
  65
  66
  67
  68 v1.1-chrome26-firefox18
  69 =======================
  70
  71 Diffstat
  72 --------
  73
  74  Makefile.am                            |    4 +
  75  README-test-server                     |  291 ---
  76  README.build                           |  239 ++
  77  README.coding                          |  138 ++
  78  README.rst                             |   72 -
  79  README.test-apps                       |  272 +++
  80  configure.ac                           |  116 +-
  81  lib/Makefile.am                        |   55 +-
  82  lib/base64-decode.c                    |    5 +-
  83  lib/client-handshake.c                 |  121 +-
  84  lib/client-parser.c                    |  394 ++++
  85  lib/client.c                           |  807 +++++++
  86  lib/daemonize.c                        |  212 ++
  87  lib/extension-deflate-frame.c          |  132 +-
  88  lib/extension-deflate-stream.c         |   12 +-
  89  lib/extension-x-google-mux.c           | 1223 ----------
  90  lib/extension-x-google-mux.h           |   96 -
  91  lib/extension.c                        |    8 -
  92  lib/getifaddrs.c                       |  271 +++
  93  lib/getifaddrs.h                       |   76 +
  94  lib/handshake.c                        |  582 +----
  95  lib/libwebsockets.c                    | 2493 ++++++---------------
  96  lib/libwebsockets.h                    |  115 +-
  97  lib/md5.c                              |  217 --
  98  lib/minilex.c                          |  440 ++++
  99  lib/output.c                           |  628 ++++++
 100  lib/parsers.c                          | 2016 +++++------------
 101  lib/private-libwebsockets.h            |  284 +--
 102  lib/server-handshake.c                 |  275 +++
 103  lib/server.c                           |  377 ++++
 104  libwebsockets-api-doc.html             |  300 +--
 105  m4/ignore-me                           |    2 +
 106  test-server/Makefile.am                |  111 +-
 107  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
 108  test-server/test-client.c              |   45 +-
 109  test-server/test-echo.c                |  330 +++
 110  test-server/test-fraggle.c             |   20 +-
 111  test-server/test-ping.c                |   22 +-
 112  test-server/test-server-extpoll.c      |  554 -----
 113  test-server/test-server.c              |  349 ++-
 114  test-server/test.html                  |    3 +-
 115  win32port/zlib/ZLib.vcxproj            |  749 ++++---
 116  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
 117  win32port/zlib/adler32.c               |  348 ++-
 118  win32port/zlib/compress.c              |  160 +-
 119  win32port/zlib/crc32.c                 |  867 ++++----
 120  win32port/zlib/crc32.h                 |  882 ++++----
 121  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
 122  win32port/zlib/deflate.h               |  688 +++---
 123  win32port/zlib/gzclose.c               |   50 +-
 124  win32port/zlib/gzguts.h                |  325 ++-
 125  win32port/zlib/gzlib.c                 | 1157 +++++-----
 126  win32port/zlib/gzread.c                | 1242 ++++++-----
 127  win32port/zlib/gzwrite.c               | 1096 +++++----
 128  win32port/zlib/infback.c               | 1272 ++++++-----
 129  win32port/zlib/inffast.c               |  680 +++---
 130  win32port/zlib/inffast.h               |   22 +-
 131  win32port/zlib/inffixed.h              |  188 +-
 132  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
 133  win32port/zlib/inflate.h               |  244 +-
 134  win32port/zlib/inftrees.c              |  636 +++---
 135  win32port/zlib/inftrees.h              |  124 +-
 136  win32port/zlib/trees.c                 | 2468 +++++++++++----------
 137  win32port/zlib/trees.h                 |  256 +--
 138  win32port/zlib/uncompr.c               |  118 +-
 139  win32port/zlib/zconf.h                 |  934 ++++----
 140  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
 141  win32port/zlib/zutil.c                 |  642 +++---
 142  win32port/zlib/zutil.h                 |  526 ++---
 143  69 files changed, 19556 insertions(+), 20145 deletions(-)
 144
 145 user api changes
 146 ----------------
 147
 148  - libwebsockets_serve_http_file() now takes a context as first argument
 149
 150  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
 151         two arguments
 152
 153
 154 user api additions
 155 ------------------
 156
 157  - lwsl_...() logging apis, default to stderr but retargetable by user code;
 158         may be used also by user code
 159
 160  - lws_set_log_level() set which logging apis are able to emit (defaults to
 161         notice, warn, err severities), optionally set the emit callback
 162
 163  - lwsl_emit_syslog() helper callback emits to syslog
 164
 165  - lws_daemonize() helper code that forks the app into a headless daemon
 166         properly, maintains a lock file with pid in suitable for sysvinit etc to
 167         control lifecycle
 168
 169  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
 170         transfer is now asynchronous (see test server code)
 171
 172  - lws_frame_is_binary() from a wsi pointer, let you know if the received
 173         data was sent in BINARY mode
 174
 175
 176 user api removals
 177 -----------------
 178
 179  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
 180         arrange your code to act from the user callback instead from same
 181         process context as the service loop
 182
 183  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
 184         instead from same process context as the service loop.  See the test apps
 185         for examples.
 186
 187  - x-google-mux() removed until someone wants it
 188
 189  - pre -v13 (ancient) protocol support removed
 190
 191
 192 New features
 193 ------------
 194
 195  - echo test server and client compatible with echo.websocket.org added
 196
 197  - many new configure options (see README.build) to reduce footprint of the
 198         library to what you actually need, eg, --without-client and
 199         --without-server
 200
 201  - http + websocket server can build to as little as 12K .text for ARM
 202
 203  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
 204         allowed to the process by ulimit, defaults to 1024 on Fedora and
 205         Ubuntu.  Use ulimit to control this without needing to configure
 206         the library.  Code here is smaller and faster.
 207
 208  - adaptive ratio of listen socket to connection socket service allows
 209         good behaviour under Apache ab test load.  Tested with thousands
 210         of simultaneous connections
 211
 212  - reduction in per-connection memory footprint by moving to a union to hold
 213         mutually-exclusive state for the connection
 214
 215  - robustness: Out of Memory taken care of for all allocation code now
 216
 217  - internal getifaddrs option if your toolchain lacks it (some uclibc)
 218
 219  - configurable memory limit for deflate operations
 220
 221  - improvements in SSL code nonblocking operation, possible hang solved,
 222         some SSL operations broken down into pollable states so there is
 223         no library blocking, timeout coverage for SSL_connect
 224
 225  - extpoll test server merged into single test server source
 226
 227  - robustness: library should deal with all recoverable socket conditions
 228
 229  - rx flowcontrol for backpressure notification fixed and implmeneted
 230         correctly in the test server
 231
 232  - optimal lexical parser added for header processing; all headers in a
 233         single 276-byte state table
 234
 235  - latency tracking api added (configure --with-latency)
 236
 237  - Improved in-tree documentation, REAME.build, README.coding,
 238         README.test-apps, changelog
 239
 240  - Many small fixes
 241
 242
 243 v1.0-chrome25-firefox17 (6cd1ea9b005933f)