4 - Examples: Add `print_client` example. This demonstrates a minimal non-TLS
5 client that connects to a server and prints out the messages it receives.
6 - Examples: Add `print_client_tls` example. This demonstrates a minimal TLS
7 client, including basic support via Asio+OpenSSL for certificate chain
8 and hostname verification.
9 - Feature: Add getter for all headers to the HTTP parsers. This allows a
10 wrapping library to enumerate all headers to send upstream. Thank you Jupp
11 Müller for reporting and an initial pull request.
12 - Improvement: Move the `socket_init_handler` to execute as a part of `init_asio`
13 rather than connection `pre_init`. This allows setting of socket options prior
14 to the bind/listen/accept system calls. Thank you ChristianRobl3D for
16 - Improvement: Timers in transport integration tests should only fail if their
17 own test times out, rather than any test. #643 Thank you Alex Korotkin for
18 reporting and a patch.
19 - Improvement: Preserve transport layer error codes in more cases, particularly
20 during calls to `endpoint::listen`. #652 Thank you vadz for reporting and
22 - Compatibility: Make sure the chrono library used by Boost/Asio is in sync
23 with what the websocketpp is using. Thank you Flow86 for reporting and a
25 - Compatibility: Update `telemetry_client` to use a slightly more cross platform
26 method of sleeping. Should work on windows now. Thank you Meir Yanovich for
28 - Compatibility: Updated permessage-deflate support to reflect that the zlib
29 library does not actually support a sliding window size of 256 bits.
30 WebSocket++ will no longer negotiate 256 bit deflate windows. If the user
31 of the library tries to request a 256 bit window a 512 bit window will be
32 specified instead (This was the previous behavior). #596 #653 Thank you
33 Vinnie Falco and Gianfranco Costamagna for reporting.
34 - Compatibility: Better error handling and logging in cases where extension
35 requests parse correctly but negotiation fails.
36 - Compatibility: Removed custom handling of `SSL_R_SHORT_READ` error condition.
37 This error code no longer exists in modern versions of OpenSSL and causes
38 a build error. It wasn't being used for anything particularly important
39 (slightly improving error reporting) and there isn't a great replacement.
40 #599 Thank you Gianfranco Costamagna for reporting.
41 - Compatibility: Add missing `<stdint>` headers. Fixes issues with g++ 5.4.0.
42 #638 Thank you Alex Korotkin for reporting and a patch.
43 - Compatibility: Remove the use of `std::auto_ptr` and `std::binary_function`
44 from builds with C++11 or later. These features are deprecated and were
45 removed entirely in C++17. This change allows building WebSocket++ on
46 C++17 compilers. #592 Thank you Michal Fojtak for reporting and a patch
47 - Compatibility: Add 1014 close code and adds missing descriptions for codes
48 1012 and 1013. #589 Thank you jbwdevries and ronneke1996 for reporting and
50 - Compatibility: Add hooks to support `mingw-std-threads` C++11 thread and mutex
51 polyfill library as an alternative to Boost. #608 Thank you Peter Taylor for
52 reporting and an initial patch.
53 - Compatibility: Changed the handshake connection token to 'Upgrade' from
54 'upgrade'. Technically this header is supposed to be processed case
55 insensitively. In practice, there are browsers (such as Edge) that don't do
56 this and they tend to use the uppercase value used as an example in RFC6455.
57 Thank you Johann Bauer for reporting and a patch. #727
58 - Bug: Store loggers in shared pointers to avoid crashes related to connections
59 trying to write logs entries after their respective endpoint has been
60 deallocated. Thank you Thalhammer for reporting and Jupp Müller for the
62 - Bug: Change default listen backlog from 0 to `socket_base::max_connections`.
63 #549. Thank you derwassi and zwelab for reporting and na1pir for providing
64 access to hardware to debug the issue.
65 - Bug: Fix a crash in the accept loop when `get_connection` fails. #551 Thank you
66 Walter Gray for a patch.
67 - Bug/Documentation: Fix incorrect example code that used
68 `websocketpp::lib::error_code` instead of `websocketpp::exception`. Thank you
69 heretic13 for reporting
70 - Bug: Fix uninitialized shared pointer in Asio transport test suite. #647
71 Thank you Alex Korotkin for reporting and a patch.
72 - Bug: Fix a thread safety issue in the permessage-deflate extension that
73 caused message corruption when sending compressed messages from a different
74 thread than the main I/O thread. #615 Thank you KyleNyenhuis and Pieter De
75 Gendt for reporting and a patch.
76 - Bug: Fix an undefined behavior issue performing a 64 bit wide shift on a 64
77 bit value. #636 Thank you Gregor Jasny for reporting and a patch
78 - Bug: Fix some compile issues with ASIO_STANDALONE. #662 #665 Thank you
79 chronoxor and Guillaume Egles for reporting and patches.
82 - MINOR BREAKING SOCKET POLICY CHANGE: Asio transport socket policy method
83 `cancel_socket` will now return `lib::asio::error_code` instead of `void`.
84 Custom Asio transport socket policies will need to be updated accordingly.
85 This does not affect anyone using the bundled socket policies.
86 - Feature: Basic support for the permessage-deflate extension. #344
87 - Feature: Allow accessing the local endpoint when using the Asio transport.
88 This allows inspection of the address and port in cases where they are chosen
89 by the operating system rather than the user. Thank you Andreas Weis and
90 Muzahid Hussain for reporting and related code. #458
91 - Feature: Add support for subprotocols in Hybi00. Thank you Lukas Obermann
92 for reporting and a patch. #518
93 - Feature: Adds `tcp_pre_bind handler` to Asio transport. This allows setting
94 arbitrary socket options after the listen acceptor has been created but before
95 the socket bind has been performed. #634 #439 Thank you Gregor Jasny for
97 - Improvement: Better automatic std::chrono feature detection for Visual Studio
98 - Improvement: Major refactoring to bundled CMake build system. CMake can now be
99 used to build all of the examples and the test suite. Thank you Thijs Wenker
100 for a significant portion of this code. #378, #435, #449
101 - Improvement: In build environments where `lib::error_code` and
102 `lib::asio::error_code` match (such as using `boost::asio` with
103 `boost::system_error` or standalone asio with `std::system_error`, transport
104 errors are passed through natively rather than being reported as a translated
105 `pass_through` error type.
106 - Improvement: Add a `get_transport_error` method to Asio transport connections
107 to allow retrieving a machine readable native transport error.
108 - Improvement: Add `connection::get_response`, `connection::get_response_code`,
109 and `connection::get_response_msg` methods to allow accessing additional
110 information about the HTTP responses that WebSocket++ sends. #465 Thank you
111 Flow86 for reporting.
112 - Improvement: Removes use of empty strings ("") in favor of `string::clear()`
113 and `string::empty()`. This avoids generating unnecessary temporary objects.
114 #468 Thank you Vladislav Yaroslavlev for reporting and a patch.
115 - Documentation: Adds an example demonstrating the use of external `io_service`
116 - Documentation: Adds a simple `echo_client` example.
117 - Documentation: Begins migration of the web based user manual into Doxygen.
118 - Bug: Fix memory leak when `init_asio` produces an error. #454 Thank you Mark
119 Grimes for reporting and fixing.
120 - Bug: Fix crash when processing a specially crafted HTTP header. Thank you Eli
121 Fidler for reporting, test cases, and a patch. #456
122 - Bug: Fix an issue where standalone Asio builds that use TLS would not compile
123 due to lingering boost code. #448 Thank you mjsp for reporting
124 - Bug: Fix an issue where canceling a socket could throw an exception on some
125 older Windows XP platforms. It now prints an appropriate set of log messages
126 instead. Thank you Thijs Wenker for reporting and researching solutions. #460
127 - Bug: Fix an issue where deferred HTTP connections that start sending a very
128 long response before their HTTP handler ends would result in a second set of
129 HTTP headers being injected into the output. Thank you Kevin Smith for
130 reporting and providing test case details. #443
131 - Bug: Fix an issue where the wrong type of strand was being created. Thank you
132 Bastien Brunnenstein for reporting and a patch. #462
133 - Bug: Fix an issue where TLS includes were broken for Asio Standalone builds.
134 Thank you giachi and Bastien Brunnenstein for reporting. #491
135 - Bug: Remove the use of cached read and write handlers in the Asio transport.
136 This feature caused memory leaks when the `io_service` the connection was
137 running on was abruptly stopped. There isn't a clean and safe way of using
138 this optimization without global state and the associated locks. The locks
139 perform worse. Thank you Xavier Gibert for reporting, test cases, and code.
141 - Bug: Fix a heap buffer overflow when checking very short URIs. Thank you
142 Xavier Gibert for reporting and a patch #524
143 - Compatibility: Fixes a number of build & config issues on Visual Studio 2015
144 - Compatibility: Removes non-standards compliant masking behavior. #395, #469
145 - Compatibility: Replace deprecated use of `auto_ptr` on systems where
146 `unique_ptr` is available.
149 - MINOR BREAKING TRANSPORT POLICY CHANGE: Custom transport policies will now be
150 required to include a new method `void set_uri(uri_ptr u)`. An implementation
151 is not required. The stub transport policy includes an example stub method
152 that can be added to any existing custom transport policy to fulfill this
153 requirement. This does not affect anyone using the bundled transports or
155 - MINOR BREAKING SOCKET POLICY CHANGE: Custom asio transport socket policies
156 will now be required to include a new method `void set_uri(uri_ptr u)`. Like
157 with the transport layer, an implementation is not required. This does not
158 affect anyone using the bundled socket policies.
159 - MINOR BREAKING DEPENDENCY CHANGE: When using Boost versions greater than or
160 equal to 1.49 in C++03 mode, `libboost-chrono` is needed now instead of
161 `libboost-date_time`. Users with C++11 compilers or using Boost versions 1.48
162 and earlier are not affected. Note: This change affects the bundled unit test
164 - Feature: WebSocket++ Asio transport policy can now be used with the standalone
165 version of Asio (1.8.0+) when a C++11 compiler and standard library are
166 present. This means that it is possible now to use WebSocket++'s Asio
167 transport entirely without Boost. Thank you Robert Seiler for proof of concept
168 code that was used as a guide for this implementation. Fixes #324
169 - Feature: Adds a vectored/scatter-gather write handler to the iostream
171 - Feature: Adds the ability to defer sending an HTTP response until sometime
172 after the `http_handler` is run. This allows processing of long running http
173 handlers to defer their response until it is ready without blocking the
174 network thread. references #425
175 - Improvement: `echo_server_tls` has been update to demonstrate how to configure
176 it for Mozilla's recommended intermediate and modern TLS security profiles.
177 - Improvement: `endpoint::set_timer` now uses a steady clock provided by
178 `boost::chrono` or `std::chrono` where available instead of the non-monotonic
179 system clock. Thank you breyed for reporting. fixes #241
180 - Improvement: Outgoing TLS connections to servers using the SNI extension to
181 choose a certificate will now work. Thank you moozzyk for reporting.
183 - Improvement: Removes an unnecessary mutex lock in `get_con_from_hdl`.
184 - Cleanup: Asio transport policy has been refactored to remove many Boost
185 dependencies. On C++03 compilers the `boost::noncopyable` dependency has been
186 removed and the `boost::date_time` dependency has been replaced with the newer
187 `boost::chrono` when possible. On C++11 compilers the `boost::aligned_storage`
188 and `boost::date_time` dependencies are gone, replaced with equivalent C++11
189 standard library features.
190 - Bug: Fixes a potential dangling pointer and inconsistent error message
191 handling in `websocketpp::exception`. #432 Thank you Tom Swirly for the fix.
194 - Bug: Fixes an issue where some frame data was counted against the max header
195 size limit, resulting in connections that included a lot of frame data
196 immediately after the opening handshake to fail.
197 - Bug: Fix a typo in the name of the set method for `max_http_body_size`. #406
198 Thank you jplatte for reporting.
201 - BREAKING UTILITY CHANGE: Deprecated methods `http::parser::parse_headers`,
202 `http::response::parse_complete`, and `http::request::parse_complete` have
204 - Security: Disabled SSLv3 in example servers.
205 - Feature: Adds basic support for accessing HTTP request bodies in the http
207 - Feature: Adds the ability to register a shutdown handler when using the
208 iostream transport. This provides a clean interface for triggering the shut
209 down of external sockets and other cleanup without hooking in to higher level
211 - Feature: Adds the ability to register a write handler when using the iostream
212 transport. This handler can be used to handle transport output in place of
213 registering an ostream to write to.
214 - Feature: Adds a new logging policy that outputs to syslog. #386 Thank you Tom
215 Hughes for submitting the initial version of this policy.
216 - Improvement: Message payload logging now prints text for text messages rather
218 - Improvement: Overhaul of handshake state machine. Should make it impossible
219 for exceptions to bubble out of transport methods like `io_service::run`.
220 - Improvement: Overhaul of handshake error reporting. Fail handler error codes
221 will be more detailed and precise. Adds new [fail] and [http] logging channels
222 that log failed websocket connections and successful HTTP connections
223 respectively. A new aggregate channel package, `alevel::access_core`, allows
224 enabling connect, disconnect, fail, and http together. Successful HTTP
225 connections will no longer trigger a fail handler.
226 - Improvement: Ability to terminate connection during an http handler to cleanly
227 suppress the default outgoing HTTP response.
228 - Documentation: Add Sending & Receiving Messages step to chapter one of the
229 `utility_client` tutorial. Update `utility_client` example to match.
230 - Cleanup: Removes unused files & STL includes. Adds required STL includes.
231 Normalizes include order.
232 - Bug: Fixes a fatal state error when a handshake response is completed
233 immediately after that handshake times out. #389
234 - Bug: MinGW fixes; C++11 feature detection, localtime use. #393 Thank you
235 Schebb for reporting, code, and testing.
236 - Bug: Fixes an issue where `websocketpp::exception::what()` could return an out
237 of scope pointer. #397 Thank you fabioang for reporting.
238 - Bug: Fixes an issue where endpoints were not reset properly after a call to
239 `endpoint::listen` failed. #390 Thank you wyyqyl for reporting.
242 - BREAKING API CHANGE: All WebSocket++ methods now throw an exception of type
243 `websocketpp::exception` which derives from `std::exception`. This normalizes
244 all exception types under the standard exception hierarchy and allows
245 WebSocket++ exceptions to be caught in the same statement as others. The error
246 code that was previously thrown is wrapped in the exception object and can be
247 accessed via the `websocketpp::exception::code()` method.
248 - BREAKING API CHANGE: Custom logging policies have some new required
249 constructors that take generic config settings rather than pointers to
250 std::ostreams. This allows writing logging policies that do not involve the
251 use of std::ostream. This does not affect anyone using the built in logging
253 - BREAKING UTILITY CHANGE: `websocketpp::lib::net::htonll` and
254 `websocketpp::lib::net::ntohll` have been prefixed with an underscore to avoid
255 conflicts with similarly named macros in some operating systems. If you are
256 using the WebSocket++ provided 64 bit host/network byte order functions you
257 will need to switch to the prefixed versions.
258 - BREAKING UTILITY CHANGE: The signature of `base64_encode` has changed from
259 `websocketpp::base64_encode(unsigned char const *, unsigned int)` to
260 `websocketpp::base64_encode(unsigned char const *, size_t)`.
261 - BREAKING UTILITY CHANGE: The signature of `sha1::calc` has changed from
262 `websocketpp::sha1::calc(void const *, int, unsigned char *)` to
263 `websocketpp::sha1::calc(void const *, size_t, unsigned char *)`
264 - Feature: Adds incomplete `minimal_server` and `minimal_client` configs that
265 can be used to build custom configs without pulling in the dependencies of
266 `core` or `core_client`. These configs will offer a stable base config to
267 future-proof custom configs.
268 - Improvement: Core library no longer has std::iostream as a dependency.
269 std::iostream is still required for the optional iostream logging policy and
271 - Bug: C++11 Chrono support was being incorrectly detected by the `boost_config`
272 header. Thank you Max Dmitrichenko for reporting and a patch.
273 - Bug: use of `std::put_time` is now guarded by a unique flag rather than a
274 chrono library flag. Thank you Max Dmitrichenko for reporting.
275 - Bug: Fixes non-thread safe use of std::localtime. #347 #383
276 - Compatibility: Adjust usage of std::min to be more compatible with systems
277 that define a min(...) macro.
278 - Compatibility: Removes unused parameters from all library, test, and example
279 code. This assists with those developing with -Werror and -Wunused-parameter
281 - Compatibility: Renames ntohll and htonll methods to avoid conflicts with
282 platform specific macros. #358 #381, #382 Thank you logotype, unphased,
284 - Cleanup: Removes unused functions, fixes variable shadow warnings, normalizes
285 all whitespace in library, examples, and tests to 4 spaces. #376
288 - Feature: Adds `start_perpetual` and `stop_perpetual` methods to asio transport
289 These may be used to replace manually managed `asio::io_service::work` objects
290 - Feature: Allow setting pong and handshake timeouts at runtime.
291 - Feature: Allows changing the listen backlog queue length.
292 - Feature: Split tcp init into pre and post init.
293 - Feature: Adds URI method to extract query string from URI. Thank you Banaan
295 - Feature: Adds a compile time switch to asio transport config to disable
296 certain multithreading features (some locks, asio strands)
297 - Feature: Adds the ability to pause reading on a connection. Paused connections
298 will not read more data from their socket, allowing TCP flow control to work
299 without blocking the main thread.
300 - Feature: Adds the ability to specify whether or not to use the `SO_REUSEADDR`
301 TCP socket option. The default for this value has been changed from `true` to
303 - Feature: Adds the ability to specify a maximum message size.
304 - Feature: Adds `close::status::get_string(...)` method to look up a human
305 readable string given a close code value.
306 - Feature: Adds `connection::read_all(...)` method to iostream transport as a
307 convenience method for reading all data into the connection buffer without the
308 end user needing to manually loop on `read_some`.
309 - Improvement: Open, close, and pong timeouts can be disabled entirely by
310 setting their duration to 0.
311 - Improvement: Numerous performance improvements. Including: tuned default
312 buffer sizes based on profiling, caching of handler binding for async
313 reads/writes, non-malloc allocators for read/write handlers, disabling of a
314 number of questionably useful range sanity checks in tight inner loops.
315 - Improvement: Cleaned up the handling of TLS related errors. TLS errors will
316 now be reported with more detail on the info channel rather than all being
317 `tls_short_read` or `pass_through`. In addition, many cases where a TLS short
318 read was in fact expected are no longer classified as errors. Expected TLS
319 short reads and quasi-expected socket shutdown related errors will no longer
320 be reported as unclean WebSocket shutdowns to the application. Information
321 about them will remain in the info error channel for debugging purposes.
322 - Improvement: `start_accept` and `listen` errors are now reported to the caller
323 either via an exception or an ec parameter.
324 - Improvement: Outgoing writes are now batched for improved message throughput
325 and reduced system call and TCP frame overhead.
326 - Bug: Fix some cases of calls to empty lib::function objects.
327 - Bug: Fix memory leak of connection objects due to cached handlers holding on to
328 reference counted pointers. #310 Thank you otaras for reporting.
329 - Bug: Fix issue with const endpoint accessors (such as `get_user_agent`) not
330 compiling due to non-const mutex use. #292 Thank you logofive for reporting.
331 - Bug: Fix handler allocation crash with multithreaded `io_service`.
332 - Bug: Fixes incorrect whitespace handling in header parsing. #301 Thank you
333 Wolfram Schroers for reporting
334 - Bug: Fix a crash when parsing empty HTTP headers. Thank you Thingol for
336 - Bug: Fix a crash following use of the `stop_listening` function. Thank you
337 Thingol for reporting.
338 - Bug: Fix use of variable names that shadow function parameters. The library
339 should compile cleanly with -Wshadow now. Thank you giszo for reporting. #318
340 - Bug: Fix an issue where `set_open_handshake_timeout` was ignored by server
341 code. Thank you Robin Rowe for reporting.
342 - Bug: Fix an issue where custom timeout values weren't being propagated from
343 endpoints to new connections.
344 - Bug: Fix a number of memory leaks related to server connection failures. #323
345 #333 #334 #335 Thank you droppy and aydany for reporting and patches.
347 - Compatibility: Fix compile time conflict with Visual Studio's MIN/MAX macros.
348 Thank you Robin Rowe for reporting.
349 - Documentation: Examples and test suite build system now defaults to clang on
352 0.3.0-alpha4 - 2013-10-11
353 - HTTP requests ending normally are no longer logged as errors. Thank you Banaan
355 - Eliminates spurious expired timers in certain error conditions. Thank you
356 Banaan for reporting. #295
357 - Consolidates all bundled library licenses into the COPYING file. #294
358 - Updates bundled sha1 library to one with a cleaner interface and more
359 straight-forward license. Thank you lotodore for reporting and Evgeni Golov
361 - Re-introduces strands to asio transport, allowing `io_service` thread pools to
362 be used (with some limitations).
363 - Removes endpoint code that kept track of a connection list that was never used
364 anywhere. Removes a lock and reduces connection creation/deletion complexity
365 from O(log n) to O(1) in the number of connections.
366 - A number of internal changes to transport APIs
367 - Deprecates iostream transport `readsome` in favor of `read_some` which is more
368 consistent with the naming of the rest of the library.
369 - Adds preliminary signaling to iostream transport of eof and fatal transport
371 - Updates transport code to use shared pointers rather than raw pointers to
372 prevent asio from retaining pointers to connection methods after the
373 connection goes out of scope. #293 Thank you otaras for reporting.
374 - Fixes an issue where custom headers couldn't be set for client connections
375 Thank you Jerry Win and Wolfram Schroers for reporting.
376 - Fixes a compile error on visual studio when using interrupts. Thank you Javier
377 Rey Neira for reporting this.
378 - Adds new 1012 and 1013 close codes per IANA registry
379 - Add `set_remote_endpoint` method to iostream transport.
380 - Add `set_secure` method to iostream transport.
381 - Fix typo in .gitattributes file. Thank you jstarasov for reporting this. #280
382 - Add missing locale include. Thank you Toninoso for reporting this. #281
383 - Refactors `asio_transport` endpoint and adds full documentation and exception
384 free varients of all methods.
385 - Removes `asio_transport` endpoint method cancel(). Use `stop_listen()` instead
386 - Wrap internal `io_service` `run_one()` method
387 - Suppress error when trying to shut down a connection that was already closed
389 0.3.0-alpha3 - 2013-07-16
390 - Minor refactor to bundled sha1 library
391 - HTTP header comparisons are now case insensitive. #220, #275
392 - Refactors URI to be exception free and not use regular expressions. This
393 eliminates the dependency on boost or C++11 regex libraries allowing native
394 C++11 usage on GCC 4.4 and higher and significantly reduces staticly built
396 - Updates handling of Server and User-Agent headers to better handle custom
397 settings and allow suppression of these headers for security purposes.
398 - Fix issue where pong timeout handler always fired. Thank you Steven Klassen
399 for reporting this bug.
400 - Add ping and pong endpoint wrapper methods
401 - Add `get_request()` pass through method to connection to allow calling methods
402 specific to the HTTP policy in use.
403 - Fix issue compile error with `WEBSOCKETPP_STRICT_MASKING` enabled and another
404 issue where `WEBSOCKETPP_STRICT_MASKING` was not applied to incoming messages.
405 Thank you Petter Norby for reporting and testing these bugs. #264
406 - Add additional macro guards for use with boost_config. Thank you breyed
407 for testing and code. #261
409 0.3.0-alpha2 - 2013-06-09
410 - Fix a regression that caused servers being sent two close frames in a row
411 to end a connection uncleanly. #259
412 - Fix a regression that caused spurious frames following a legitimate close
413 frames to erroneously trigger handlers. #258
414 - Change default HTTP response error code when no http_handler is defined from
415 500/Internal Server Error to 426/Upgrade Required
416 - Remove timezone from logger timestamp to work around issues with the Windows
417 implementation of strftime. Thank you breyed for testing and code. #257
418 - Switch integer literals to char literals to improve VCPP compatibility.
419 Thank you breyed for testing and code. #257
420 - Add MSVCPP warning suppression for the bundled SHA1 library. Thank you breyed
421 for testing and code. #257
423 0.3.0-alpha1 - 2013-06-09