Skip to content

Commit 8a2f4f5

Browse files
darrachequesnedarrachequesne
committed
update site
- init Android documentation - add missing manager options - add note about the readTimeout value
1 parent c7183b8 commit 8a2f4f5

21 files changed

+277
-77
lines changed

‎android.html‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!DOCTYPE html>
2+
<!--
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2022-07-04
4+
| Rendered using Apache Maven Fluido Skin 1.9
5+
-->
6+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
7+
<head>
8+
<meta charset="UTF-8" />
9+
<meta name="viewport" content="width=device-width, initial-scale=1" />
10+
<meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
11+
<title>socket.io-client &#x2013; Android</title>
12+
<link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" />
13+
<link rel="stylesheet" href="./css/site.css" />
14+
<link rel="stylesheet" href="./css/print.css" media="print" />
15+
<script src="./js/apache-maven-fluido-1.9.min.js"></script>
16+
</head>
17+
<body class="topBarDisabled">
18+
<a href="https://github.com/socketio/socket.io-client-java">
19+
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
20+
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
21+
alt="Fork me on GitHub">
22+
</a>
23+
<div class="container-fluid">
24+
<header>
25+
<div id="banner">
26+
<div class="pull-left"><div id="bannerLeft"><h2>Socket.IO Java client</h2>
27+
</div>
28+
</div>
29+
<div class="pull-right"></div>
30+
<div class="clear"><hr/></div>
31+
</div>
32+
33+
<div id="breadcrumbs">
34+
<ul class="breadcrumb">
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
36+
</li>
37+
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
38+
</ul>
39+
</div>
40+
</header>
41+
<div class="row-fluid">
42+
<header id="leftColumn" class="span2">
43+
<nav class="well sidebar-nav">
44+
<ul class="nav nav-list">
45+
<li class="nav-header">Overview</li>
46+
<li><a href="installation.html" title="Installation"><span class="none"></span>Installation</a></li>
47+
<li><a href="initialization.html" title="Initialization"><span class="none"></span>Initialization</a></li>
48+
<li><a href="emitting_events.html" title="Emitting events"><span class="none"></span>Emitting events</a></li>
49+
<li><a href="listening_to_events.html" title="Listening to events"><span class="none"></span>Listening to events</a></li>
50+
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
51+
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
52+
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li class="active"><a href="#"><span class="none"></span>Android</a></li>
54+
<li class="nav-header">Miscellaneous</li>
55+
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
56+
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>
57+
<li class="nav-header">Project Documentation</li>
58+
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
59+
</ul>
60+
</nav>
61+
<div class="well sidebar-nav">
62+
<hr />
63+
<div id="poweredBy">
64+
<div class="clear"></div>
65+
<div class="clear"></div>
66+
<div class="clear"></div>
67+
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
68+
</div>
69+
</div>
70+
</header>
71+
<main id="bodyColumn" class="span10" >
72+
<h1>Android</h1>
73+
<ul>
74+
<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>
75+
<li><a href="#How_to_reach_an_HTTP_server.3F">How to reach an HTTP server?</a></li></ul>
76+
<section>
77+
<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>
78+
<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>
79+
<p>It is totally usable in the foreground though.</p>
80+
<p>See also: <a class="externalLink" href="https://developer.android.com/training/connectivity">https://developer.android.com/training/connectivity</a></p></section><section>
81+
<h2><a name="How_to_reach_an_HTTP_server.3F"></a>How to reach an HTTP server?</h2>
82+
<p>Starting with Android 9 (API level 28) you need to explicitly allow cleartext traffic to be able to reach an HTTP server (e.g. a local server at <code>http://192.168.0.10</code>):</p>
83+
<ul>
84+
85+
<li>either for all domains:</li>
86+
</ul>
87+
<p><code>app/src/main/AndroidManifest.xml</code></p>
88+
89+
<div class="source">
90+
<div class="source"><pre class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
91+
&lt;manifest&gt;
92+
&lt;uses-permission android:name=&quot;android.permission.INTERNET&quot; /&gt;
93+
94+
&lt;application android:usesCleartextTraffic=&quot;true&quot;&gt;
95+
...
96+
&lt;/application&gt;
97+
&lt;/manifest&gt;
98+
</pre></div></div>
99+
100+
<ul>
101+
102+
<li>or for a restricted list of domains:</li>
103+
</ul>
104+
<p><code>app/src/main/AndroidManifest.xml</code></p>
105+
106+
<div class="source">
107+
<div class="source"><pre class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
108+
&lt;manifest&gt;
109+
&lt;uses-permission android:name=&quot;android.permission.INTERNET&quot; /&gt;
110+
111+
&lt;application android:networkSecurityConfig=&quot;@xml/network_security_config&quot;&gt;
112+
...
113+
&lt;/application&gt;
114+
&lt;/manifest&gt;
115+
</pre></div></div>
116+
117+
<p><code>app/src/main/res/xml/network_security_config.xml</code></p>
118+
119+
<div class="source">
120+
<div class="source"><pre class="prettyprint">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
121+
&lt;network-security-config&gt;
122+
&lt;domain-config cleartextTrafficPermitted=&quot;true&quot;&gt;
123+
&lt;domain includeSubdomains=&quot;true&quot;&gt;localhost&lt;/domain&gt;
124+
&lt;domain includeSubdomains=&quot;true&quot;&gt;192.168.0.10&lt;/domain&gt;
125+
&lt;/domain-config&gt;
126+
&lt;/network-security-config&gt;
127+
</pre></div></div>
128+
129+
<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>
130+
</main>
131+
</div>
132+
</div>
133+
<hr/>
134+
<footer>
135+
<div class="container-fluid">
136+
<div class="row-fluid">
137+
<p>&#169; 2022
138+
</p>
139+
</div>
140+
</div>
141+
</footer>
142+
</body>
143+
</html>

‎changelog.html‎

Lines changed: 3 additions & 2 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/changelog.md at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/changelog.md at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li class="active"><a href="#"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎dependencies.html‎

Lines changed: 3 additions & 2 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 org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:dependencies at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:dependencies at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎dependency-info.html‎

Lines changed: 3 additions & 2 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 org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:dependency-info at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:dependency-info at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎distribution-management.html‎

Lines changed: 3 additions & 2 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 org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:distribution-management at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:distribution-management at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎emitting_events.html‎

Lines changed: 3 additions & 2 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/emitting_events.md at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/emitting_events.md at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎faq.html‎

Lines changed: 3 additions & 2 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/faq.md at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/faq.md at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li class="active"><a href="#"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

‎index.html‎

Lines changed: 3 additions & 2 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 org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:index at 2022-07-02
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.1.1:index at 2022-07-04
44
| Rendered using Apache Maven Fluido Skin 1.9
55
-->
66
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
@@ -32,7 +32,7 @@
3232

3333
<div id="breadcrumbs">
3434
<ul class="breadcrumb">
35-
<li id="publishDate">Last Published: 2022-07-02<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-04<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -50,6 +50,7 @@
5050
<li><a href="socket_instance.html" title="The Socket instance"><span class="none"></span>The Socket instance</a></li>
5151
<li><a href="migrating_from_1_x.html" title="Migrating from 1.x"><span class="none"></span>Migrating from 1.x</a></li>
5252
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li>
53+
<li><a href="android.html" title="Android"><span class="none"></span>Android</a></li>
5354
<li class="nav-header">Miscellaneous</li>
5455
<li><a href="changelog.html" title="Changelog"><span class="none"></span>Changelog</a></li>
5556
<li><a href="apidocs/index.html" title="Javadoc"><span class="none"></span>Javadoc</a></li>

0 commit comments

Comments
 (0)