Deployed d1cd5e6 with MkDocs version: 1.1

design/index.html

@@ -117,6 +117,7 @@
 <p>The per message deflate compression option is supported. It can lead to very nice bandbwith savings (20x !) if your messages are similar, which is often the case for example for chat applications. All features of the spec should be supported.</p>
 <h3 id="tlsssl">TLS/SSL</h3>
 <p>Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, OpenSSL and mbedTLS can be used on Android, Linux and Windows.</p>
+<p>If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.</p>
 <h3 id="polling-and-background-thread-work">Polling and background thread work</h3>
 <p>No manual polling to fetch data is required. Data is sent and received instantly by using a background thread for receiving data and the select <a href="http://man7.org/linux/man-pages/man2/select.2.html">system</a> call to be notified by the OS of incoming data. No timeout is used for select so that the background thread is only woken up when data is available, to optimize battery life. This is also the recommended way of using select according to the select tutorial, section <a href="https://linux.die.net/man/2/select_tut">select law</a>. Read and Writes to the socket are non blocking. Data is sent right away and not enqueued by writing directly to the socket, which is <a href="https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid">possible</a> since system socket implementations allow concurrent read/writes. However concurrent writes need to be protected with mutex.</p>
 <h3 id="automatic-reconnection">Automatic reconnection</h3>
@@ -126,7 +127,14 @@
 <h3 id="testing">Testing</h3>
 <p>The library has an interactive tool which is handy for testing compatibility ith other libraries. We have tested our client against Python, Erlang, Node.js, and C++ websocket server libraries.</p>
 <p>The unittest tries to be comprehensive, and has been running on multiple platforms, with different sanitizers such as a thread sanitizer to catch data races or the undefined behavior sanitizer.</p>
-<p>The regression test is running after each commit on travis.</p>
+<p>The regression test is running after each commit on github actions for multiple configurations.</p>
+<ul>
+<li>Linux</li>
+<li>macOS with thread sanitizer</li>
+<li>macOS, with OpenSSL, with thread sanitizer</li>
+<li>macOS, with MbedTLS, with thread sanitizer</li>
+<li>Windows, with MbedTLS (the unittest is not run yet)</li>
+</ul>
 <h2 id="limitations">Limitations</h2>
 <ul>
 <li>On Windows and Android certificate validation needs to be setup so that SocketTLSOptions.caFile point to a pem file, such as the one distributed by Firefox. Unless that setup is done connecting to a wss endpoint will display an error. On Windows with mbedtls the message will contain <code>error in handshake : X509 - Certificate verification failed, e.g. CRL, CA or signature check failed</code>.</li>

index.html

@@ -263,5 +263,5 @@ webSocket.send("hello world");
 
 <!--
 MkDocs version : 1.1
-Build Date UTC : 2020-04-05 00:50:29
+Build Date UTC : 2020-04-05 00:54:48
 -->

usage/index.html

@@ -511,6 +511,7 @@ server.wait();
 
 <h2 id="tls-support-and-configuration">TLS support and configuration</h2>
 <p>To leverage TLS features, the library must be compiled with the option <code>USE_TLS=1</code>.</p>
+<p>If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.</p>
 <p>Then, secure sockets are automatically used when connecting to a <code>wss://*</code> url.</p>
 <p>Additional TLS options can be configured by passing a <code>ix::SocketTLSOptions</code> instance to the
 <code>setTLSOptions</code> on <code>ix::WebSocket</code> (or <code>ix::WebSocketServer</code> or <code>ix::HttpServer</code>)</p>