update site

- version 2.1.1
socketio · Jul 10, 2024 · c102ae5 · c102ae5
1 parent 7aa516d
commit c102ae5
Show file tree

Hide file tree

Showing 129 changed files with 9,565 additions and 14,753 deletions.
diff --git a/android.html b/android.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2022-07-10
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2024-07-10
  | Rendered using Apache Maven Fluido Skin 1.9
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,9 +32,9 @@
 
         <div id="breadcrumbs">
           <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2022-07-10<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2024-07-10<span class="divider">|</span>
 </li>
-          <li id="projectVersion">Version: 2.1.0</li>
+          <li id="projectVersion">Version: 2.1.1</li>
           </ul>
         </div>
       </header>
@@ -73,7 +73,8 @@
 <h1>Android</h1>
 <ul>
 <li><a href="#How_to_keep_a_Socket.IO_client_running_in_the_background.3F">How to keep a Socket.IO client running in the background?</a></li>
-<li><a href="#How_to_reach_an_HTTP_server.3F">How to reach an HTTP server?</a></li></ul>
+<li><a href="#How_to_reach_an_HTTP_server.3F">How to reach an HTTP server?</a></li>
+<li><a href="#How_to_run_unit_tests_in_Android_Studio.3F">How to run unit tests in Android Studio?</a></li></ul>
 <section>
 <h2><a name="How_to_keep_a_Socket.IO_client_running_in_the_background.3F"></a>How to keep a Socket.IO client running in the background?</h2>
 <p>Long story short, you probably shouldn&#x2019;t. The Socket.IO client is not meant to be used in a <a class="externalLink" href="https://developer.android.com/guide/components/services?hl=en">background service</a>, as it will keep an open TCP connection to the server and quickly drain the battery of your users.</p>
@@ -127,15 +128,34 @@ <h2><a name="How_to_reach_an_HTTP_server.3F"></a>How to reach an HTTP server?</h
 &lt;/network-security-config&gt;
 </pre></div></div>
 
-<p>Reference: <a class="externalLink" href="https://developer.android.com/training/articles/security-config">https://developer.android.com/training/articles/security-config</a></p></section>
+<p>Reference: <a class="externalLink" href="https://developer.android.com/training/articles/security-config">https://developer.android.com/training/articles/security-config</a></p></section><section>
+<h2><a name="How_to_run_unit_tests_in_Android_Studio.3F"></a>How to run unit tests in Android Studio?</h2>
+<p>Local unit tests are tests that run on your machine&#x2019;s local Java Virtual Machine.</p>
+<p>Reference: <a class="externalLink" href="https://developer.android.com/studio/test/test-in-android-studio">https://developer.android.com/studio/test/test-in-android-studio</a></p>
+<p>Since they run on your machine, the JSON library must be manually included for the tests (because it is not provided by the Android runtime):</p>
+<p><code>build.gradle</code></p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">dependencies {
+    implementation ('io.socket:socket.io-client:2.0.1') {
+        exclude group: 'org.json', module: 'json'
+    }
+
+    testImplementation 'org.json:json:20090211'
+
+    ...
+}
+</pre></div></div>
+
+<p>Note: we use this ancient version of <code>org.json</code> because it is compatible with the one bundled in Android.</p></section>
         </main>
       </div>
     </div>
     <hr/>
     <footer>
       <div class="container-fluid">
         <div class="row-fluid">
-            <p>&#169;      2022
+            <p>&#169;      2024
 </p>
         </div>
       </div>

diff --git a/apidocs/allclasses-index.html b/apidocs/allclasses-index.html
@@ -0,0 +1,140 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) on Wed Jul 10 12:54:21 CEST 2024 -->
+<title>All Classes and Interfaces (socket.io-client 2.1.1 API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2024-07-10">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-classes-index-page">
+<script type="text/javascript">var evenRowColor = "even-row-color";
+var oddRowColor = "odd-row-color";
+var tableTab = "table-tab";
+var activeTableTab = "active-table-tab";
+var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-classes">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
+</div>
+<div id="all-classes-table">
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
+<div id="all-classes-table.tabpanel" role="tabpanel">
+<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
+<div class="table-header col-first">Class</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/client/Ack.html" title="interface in io.socket.client">Ack</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Acknowledgement.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/AckWithTimeout.html" title="class in io.socket.client">AckWithTimeout</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/backo/Backoff.html" title="class in io.socket.backo">Backoff</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Imported from https://github.com/mokesmokes/backo</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/Binary.html" title="class in io.socket.parser">Binary</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/Binary.DeconstructedPacket.html" title="class in io.socket.parser">Binary.DeconstructedPacket</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="io/socket/parser/DecodingException.html" title="class in io.socket.parser">DecodingException</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/hasbinary/HasBinary.html" title="class in io.socket.hasbinary">HasBinary</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/IO.html" title="class in io.socket.client">IO</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/IO.Options.html" title="class in io.socket.client">IO.Options</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/IOParser.html" title="class in io.socket.parser">IOParser</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/IOParser.Decoder.html" title="class in io.socket.parser">IOParser.Decoder</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/IOParser.Encoder.html" title="class in io.socket.parser">IOParser.Encoder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/Manager.html" title="class in io.socket.client">Manager</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Manager class represents a connection to a given Socket.IO server.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/client/Manager.OpenCallback.html" title="interface in io.socket.client">Manager.OpenCallback</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/Manager.Options.html" title="class in io.socket.client">Manager.Options</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/On.html" title="class in io.socket.client">On</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/client/On.Handle.html" title="interface in io.socket.client">On.Handle</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/parser/Packet.html" title="class in io.socket.parser">Packet</a>&lt;<a href="io/socket/parser/Packet.html" title="type parameter in Packet">T</a>&gt;</div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/parser/Parser.html" title="interface in io.socket.parser">Parser</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/parser/Parser.Decoder.html" title="interface in io.socket.parser">Parser.Decoder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/parser/Parser.Decoder.Callback.html" title="interface in io.socket.parser">Parser.Decoder.Callback</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/parser/Parser.Encoder.html" title="interface in io.socket.parser">Parser.Encoder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/socket/parser/Parser.Encoder.Callback.html" title="interface in io.socket.parser">Parser.Encoder.Callback</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/Socket.html" title="class in io.socket.client">Socket</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">The socket class for Socket.IO Client.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/socket/client/SocketIOException.html" title="class in io.socket.client">SocketIOException</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/SocketOptionBuilder.html" title="class in io.socket.client">SocketOptionBuilder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Convenient builder class that helps creating
+ <a href="io/socket/client/IO.Options.html" title="class in io.socket.client"><code>Client Option</code></a> object as builder pattern.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/socket/client/Url.html" title="class in io.socket.client">Url</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+</div>
+</div>
+</div>
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>
diff --git a/apidocs/allpackages-index.html b/apidocs/allpackages-index.html
@@ -0,0 +1,75 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<!-- Generated by javadoc (17) on Wed Jul 10 12:54:21 CEST 2024 -->
+<title>All Packages (socket.io-client 2.1.1 API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2024-07-10">
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/AllPackagesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-packages-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-packages">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="caption"><span>Package Summary</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><a href="io/socket/backo/package-summary.html">io.socket.backo</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="io/socket/client/package-summary.html">io.socket.client</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="io/socket/hasbinary/package-summary.html">io.socket.hasbinary</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="io/socket/parser/package-summary.html">io.socket.parser</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+</div>
+</main>
+<footer role="contentinfo">
+<hr>
+<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
+</footer>
+</div>
+</div>
+</body>
+</html>