Skip to content

Commit c599d4a

Browse files
darrachequesnedarrachequesne
committed
update site
- how to properly close a client - multiplexing
1 parent e4f9507 commit c599d4a

22 files changed

+131
-49
lines changed

‎android.html‎

Lines changed: 2 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/android.md at 2022-07-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/android.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎changelog.html‎

Lines changed: 2 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-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/changelog.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎dependencies.html‎

Lines changed: 2 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-07
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-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎dependency-info.html‎

Lines changed: 2 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-07
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-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎distribution-management.html‎

Lines changed: 2 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-07
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-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎emitting_events.html‎

Lines changed: 2 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-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/emitting_events.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎faq.html‎

Lines changed: 31 additions & 5 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-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/faq.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -75,7 +75,8 @@ <h1>Frequently asked questions</h1>
7575
<li><a href="#How_to_deal_with_cookies">How to deal with cookies</a></li>
7676
<li><a href="#How_to_use_with_AWS_Load_Balancing">How to use with AWS Load Balancing</a></li>
7777
<li><a href="#How_to_force_TLS_v1.2_and_above">How to force TLS v1.2 and above</a></li>
78-
<li><a href="#How_to_create_a_lot_of_clients">How to create a lot of clients</a></li></ul>
78+
<li><a href="#How_to_create_a_lot_of_clients">How to create a lot of clients</a></li>
79+
<li><a href="#How_to_properly_close_a_client">How to properly close a client</a></li></ul>
7980
<section>
8081
<h2><a name="How_to_deal_with_cookies"></a>How to deal with cookies</h2>
8182
<p>In order to store the cookies sent by the server and include them in all subsequent requests, you need to create an OkHttpClient with a custom <a class="externalLink" href="https://square.github.io/okhttp/4.x/okhttp/okhttp3/-cookie-jar/">cookie jar</a>.</p>
@@ -233,11 +234,36 @@ <h2><a name="How_to_create_a_lot_of_clients"></a>How to create a lot of clients<
233234
options.webSocketFactory = okHttpClient;
234235

235236
for (int i = 0; i &lt; MAX_CLIENTS; i++) {
236-
Socket socket=IO.socket(URI.create(&quot;https://example.com&quot;), options);
237+
Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;), options);
237238
}
238239
</pre></div></div>
239240

240-
<p>Note: we use <code>MAX_CLIENTS * 2</code> because a client in HTTP long-polling mode will have one long-running GET request for receiving data from the server, and will create a POST request for sending data to the server.</p></section>
241+
<p>Note: we use <code>MAX_CLIENTS * 2</code> because a client in HTTP long-polling mode will have one long-running GET request for receiving data from the server, and will create a POST request for sending data to the server.</p></section><section>
242+
<h2><a name="How_to_properly_close_a_client"></a>How to properly close a client</h2>
243+
<p>Calling <code>socket.disconnect()</code> may not be sufficient, because the underlying OkHttp client <a class="externalLink" href="https://github.com/square/okhttp/blob/06d38cb795d82d086f13c595a62ce0cbe60904ac/okhttp/src/main/java/okhttp3/Dispatcher.java#L65-L66">creates</a> a ThreadPoolExecutor that will prevent your Java program from quitting for 60 seconds.</p>
244+
<p>As a workaround, you can manually shut down this ThreadPoolExecutor:</p>
245+
246+
<div class="source">
247+
<div class="source"><pre class="prettyprint">Dispatcher dispatcher = new Dispatcher();
248+
249+
OkHttpClient okHttpClient = new OkHttpClient.Builder()
250+
.dispatcher(dispatcher)
251+
.readTimeout(1, TimeUnit.MINUTES) // important for HTTP long-polling
252+
.build();
253+
254+
IO.Options options = new IO.Options();
255+
options.callFactory = okHttpClient;
256+
options.webSocketFactory = okHttpClient;
257+
258+
Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;), options);
259+
260+
socket.connect();
261+
262+
// then later
263+
264+
socket.disconnect();
265+
dispatcher.executorService().shutdown();
266+
</pre></div></div></section>
241267
</main>
242268
</div>
243269
</div>

‎index.html‎

Lines changed: 2 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-07
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-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

‎initialization.html‎

Lines changed: 60 additions & 4 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/initialization.md at 2022-07-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/initialization.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>
@@ -105,7 +105,8 @@ <h1>Initialization</h1>
105105
<li><a href="#SSL_connections">SSL connections</a>
106106
<ul>
107107
<li><a href="#With_a_keystore">With a keystore</a></li>
108-
<li><a href="#Trust_all_certificates">Trust all certificates</a></li></ul></li></ul>
108+
<li><a href="#Trust_all_certificates">Trust all certificates</a></li></ul></li>
109+
<li><a href="#Multiplexing">Multiplexing</a></li></ul>
109110
<section>
110111
<h2><a name="Creation_of_a_Socket_instance"></a>Creation of a Socket instance</h2>
111112

@@ -513,7 +514,62 @@ <h3><a name="Trust_all_certificates"></a>Trust all certificates</h3>
513514
options.webSocketFactory = okHttpClient;
514515

515516
Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;), options);
516-
</pre></div></div></section></section>
517+
</pre></div></div>
518+
</section></section><section>
519+
<h2><a name="Multiplexing"></a>Multiplexing</h2>
520+
<p>The Java client does support multiplexing: this allows to split the logic of your application into distinct modules, while using one single WebSocket connection to the server.</p>
521+
<p>Reference: <a class="externalLink" href="https://socket.io/docs/v4/namespaces/">https://socket.io/docs/v4/namespaces/</a></p>
522+
523+
<div class="source">
524+
<div class="source"><pre class="prettyprint">Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;)); // the main namespace
525+
Socket productSocket = IO.socket(URI.create(&quot;https://example.com/product&quot;)); // the &quot;product&quot; namespace
526+
Socket orderSocket = IO.socket(URI.create(&quot;https://example.com/order&quot;)); // the &quot;order&quot; namespace
527+
528+
// all 3 sockets share the same Manager
529+
System.out.println(socket.io() == productSocket.io()); // true
530+
System.out.println(socket.io() == orderSocket.io()); // true
531+
</pre></div></div>
532+
533+
<p>Please note that multiplexing will be disabled in the following cases:</p>
534+
<ul>
535+
536+
<li>multiple creation for the same namespace</li>
537+
</ul>
538+
539+
<div class="source">
540+
<div class="source"><pre class="prettyprint">Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;));
541+
Socket socket2 = IO.socket(URI.create(&quot;https://example.com&quot;));
542+
543+
System.out.println(socket.io() == socket2.io()); // false
544+
</pre></div></div>
545+
546+
<ul>
547+
548+
<li>different domains</li>
549+
</ul>
550+
551+
<div class="source">
552+
<div class="source"><pre class="prettyprint">Socket socket = IO.socket(URI.create(&quot;https://first.example.com&quot;));
553+
Socket socket2 = IO.socket(URI.create(&quot;https://second.example.com&quot;));
554+
555+
System.out.println(socket.io() == socket2.io()); // false
556+
</pre></div></div>
557+
558+
<ul>
559+
560+
<li>usage of the <a href="#forceNew">forceNew</a> option</li>
561+
</ul>
562+
563+
<div class="source">
564+
<div class="source"><pre class="prettyprint">IO.Options options = IO.Options.builder()
565+
.setForceNew(true)
566+
.build();
567+
568+
Socket socket = IO.socket(URI.create(&quot;https://example.com&quot;));
569+
Socket socket2 = IO.socket(URI.create(&quot;https://example.com/admin&quot;), options);
570+
571+
System.out.println(socket.io() == socket2.io()); // false
572+
</pre></div></div></section>
517573
</main>
518574
</div>
519575
</div>

‎installation.html‎

Lines changed: 2 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/installation.md at 2022-07-07
3+
| Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/installation.md at 2022-07-08
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-07<span class="divider">|</span>
35+
<li id="publishDate">Last Published: 2022-07-08<span class="divider">|</span>
3636
</li>
3737
<li id="projectVersion">Version: 2.0.2-SNAPSHOT</li>
3838
</ul>

0 commit comments

Comments
 (0)