Skip to content

Commit c102ae5

Browse files
darrachequesnedarrachequesne
committed
update site
- version 2.1.1
1 parent 7aa516d commit c102ae5

File tree

129 files changed

+9565
-14753
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+9565
-14753
lines changed

‎android.html‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!DOCTYPE html>
22
<!--
3-
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2022-07-10
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2024-07-10
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,9 +32,9 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-10<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2024-07-10<span class="divider">|</span>
3636
</li>
37-
<li id="projectVersion">Version: 2.1.0</li>
37+
<li id="projectVersion">Version: 2.1.1</li>
3838
</ul>
3939
</div>
4040
</header>
@@ -73,7 +73,8 @@
7373
<h1>Android</h1>
7474
<ul>
7575
<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>
76-
<li><a href="#How_to_reach_an_HTTP_server.3F">How to reach an HTTP server?</a></li></ul>
76+
<li><a href="#How_to_reach_an_HTTP_server.3F">How to reach an HTTP server?</a></li>
77+
<li><a href="#How_to_run_unit_tests_in_Android_Studio.3F">How to run unit tests in Android Studio?</a></li></ul>
7778
<section>
7879
<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>
7980
<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
127128
&lt;/network-security-config&gt;
128129
</pre></div></div>
129130

130-
<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>
131+
<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>
132+
<h2><a name="How_to_run_unit_tests_in_Android_Studio.3F"></a>How to run unit tests in Android Studio?</h2>
133+
<p>Local unit tests are tests that run on your machine&#x2019;s local Java Virtual Machine.</p>
134+
<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>
135+
<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>
136+
<p><code>build.gradle</code></p>
137+
138+
<div class="source">
139+
<div class="source"><pre class="prettyprint">dependencies {
140+
implementation ('io.socket:socket.io-client:2.0.1') {
141+
exclude group: 'org.json', module: 'json'
142+
}
143+
144+
testImplementation 'org.json:json:20090211'
145+
146+
...
147+
}
148+
</pre></div></div>
149+
150+
<p>Note: we use this ancient version of <code>org.json</code> because it is compatible with the one bundled in Android.</p></section>
131151
</main>
132152
</div>
133153
</div>
134154
<hr/>
135155
<footer>
136156
<div class="container-fluid">
137157
<div class="row-fluid">
138-
<p>&#169; 2022
158+
<p>&#169; 2024
139159
</p>
140160
</div>
141161
</div>

‎apidocs/allclasses-index.html‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) on Wed Jul 10 12:54:21 CEST 2024 -->
5+
<title>All Classes and Interfaces (socket.io-client 2.1.1 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2024-07-10">
9+
<meta name="description" content="class index">
10+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
14+
<script type="text/javascript" src="script.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
16+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
17+
</head>
18+
<body class="all-classes-index-page">
19+
<script type="text/javascript">var evenRowColor = "even-row-color";
20+
var oddRowColor = "odd-row-color";
21+
var tableTab = "table-tab";
22+
var activeTableTab = "active-table-tab";
23+
var pathtoroot = "./";
24+
loadScripts(document, 'script');</script>
25+
<noscript>
26+
<div>JavaScript is disabled on your browser.</div>
27+
</noscript>
28+
<div class="flex-box">
29+
<header role="banner" class="flex-header">
30+
<nav role="navigation">
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<div class="top-nav" id="navbar-top">
33+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
34+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
35+
<li><a href="index.html">Overview</a></li>
36+
<li>Package</li>
37+
<li>Class</li>
38+
<li>Use</li>
39+
<li><a href="overview-tree.html">Tree</a></li>
40+
<li><a href="index-all.html">Index</a></li>
41+
<li><a href="help-doc.html#all-classes">Help</a></li>
42+
</ul>
43+
</div>
44+
<div class="sub-nav">
45+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
46+
<input type="text" id="search-input" value="search" disabled="disabled">
47+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
48+
</div>
49+
</div>
50+
<!-- ========= END OF TOP NAVBAR ========= -->
51+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
52+
</header>
53+
<div class="flex-content">
54+
<main role="main">
55+
<div class="header">
56+
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
57+
</div>
58+
<div id="all-classes-table">
59+
<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>
60+
<div id="all-classes-table.tabpanel" role="tabpanel">
61+
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
62+
<div class="table-header col-first">Class</div>
63+
<div class="table-header col-last">Description</div>
64+
<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>
65+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
66+
<div class="block">Acknowledgement.</div>
67+
</div>
68+
<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>
69+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
70+
<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>
71+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
72+
<div class="block">Imported from https://github.com/mokesmokes/backo</div>
73+
</div>
74+
<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>
75+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
76+
<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>
77+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
78+
<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>
79+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
80+
<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>
81+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
82+
<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>
83+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
84+
<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>
85+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
86+
<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>
87+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
88+
<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>
89+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
90+
<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>
91+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
92+
<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>
93+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
94+
<div class="block">Manager class represents a connection to a given Socket.IO server.</div>
95+
</div>
96+
<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>
97+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
98+
<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>
99+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
100+
<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>
101+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
102+
<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>
103+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
104+
<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>
105+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
106+
<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>
107+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
108+
<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>
109+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
110+
<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>
111+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
112+
<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>
113+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
114+
<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>
115+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
116+
<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>
117+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
118+
<div class="block">The socket class for Socket.IO Client.</div>
119+
</div>
120+
<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>
121+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
122+
<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>
123+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
124+
<div class="block">Convenient builder class that helps creating
125+
<a href="io/socket/client/IO.Options.html" title="class in io.socket.client"><code>Client Option</code></a> object as builder pattern.</div>
126+
</div>
127+
<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>
128+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
129+
</div>
130+
</div>
131+
</div>
132+
</main>
133+
<footer role="contentinfo">
134+
<hr>
135+
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
136+
</footer>
137+
</div>
138+
</div>
139+
</body>
140+
</html>

‎apidocs/allpackages-index.html‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) on Wed Jul 10 12:54:21 CEST 2024 -->
5+
<title>All Packages (socket.io-client 2.1.1 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2024-07-10">
9+
<meta name="description" content="package index">
10+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
14+
<script type="text/javascript" src="script.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
16+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
17+
</head>
18+
<body class="all-packages-index-page">
19+
<script type="text/javascript">var pathtoroot = "./";
20+
loadScripts(document, 'script');</script>
21+
<noscript>
22+
<div>JavaScript is disabled on your browser.</div>
23+
</noscript>
24+
<div class="flex-box">
25+
<header role="banner" class="flex-header">
26+
<nav role="navigation">
27+
<!-- ========= START OF TOP NAVBAR ======= -->
28+
<div class="top-nav" id="navbar-top">
29+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
30+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
31+
<li><a href="index.html">Overview</a></li>
32+
<li>Package</li>
33+
<li>Class</li>
34+
<li>Use</li>
35+
<li><a href="overview-tree.html">Tree</a></li>
36+
<li><a href="index-all.html">Index</a></li>
37+
<li><a href="help-doc.html#all-packages">Help</a></li>
38+
</ul>
39+
</div>
40+
<div class="sub-nav">
41+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
42+
<input type="text" id="search-input" value="search" disabled="disabled">
43+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
44+
</div>
45+
</div>
46+
<!-- ========= END OF TOP NAVBAR ========= -->
47+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
48+
</header>
49+
<div class="flex-content">
50+
<main role="main">
51+
<div class="header">
52+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
53+
</div>
54+
<div class="caption"><span>Package Summary</span></div>
55+
<div class="summary-table two-column-summary">
56+
<div class="table-header col-first">Package</div>
57+
<div class="table-header col-last">Description</div>
58+
<div class="col-first even-row-color"><a href="io/socket/backo/package-summary.html">io.socket.backo</a></div>
59+
<div class="col-last even-row-color">&nbsp;</div>
60+
<div class="col-first odd-row-color"><a href="io/socket/client/package-summary.html">io.socket.client</a></div>
61+
<div class="col-last odd-row-color">&nbsp;</div>
62+
<div class="col-first even-row-color"><a href="io/socket/hasbinary/package-summary.html">io.socket.hasbinary</a></div>
63+
<div class="col-last even-row-color">&nbsp;</div>
64+
<div class="col-first odd-row-color"><a href="io/socket/parser/package-summary.html">io.socket.parser</a></div>
65+
<div class="col-last odd-row-color">&nbsp;</div>
66+
</div>
67+
</main>
68+
<footer role="contentinfo">
69+
<hr>
70+
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
71+
</footer>
72+
</div>
73+
</div>
74+
</body>
75+
</html>

0 commit comments

Comments
 (0)