File 2083-Add-documentation-for-the-erl_uds_dist-exa... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2083-Add-documentation-for-the-erl_uds_dist-example.patch of Package erlang

From b8420dcd650cab127d2e136c4a5a171f67e252a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20de=20Bretagne?=
 <jerome.debretagne@gmail.com>
Date: Wed, 3 Jun 2020 23:59:49 +0200
Subject: [PATCH 3/4] Add documentation for the erl_uds_dist example

---
 erts/doc/src/alt_dist.xml | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/erts/doc/src/alt_dist.xml b/erts/doc/src/alt_dist.xml
index 09424cedb2..d8d8765b91 100644
--- a/erts/doc/src/alt_dist.xml
+++ b/erts/doc/src/alt_dist.xml
@@ -63,9 +63,9 @@
 	Erlang code will of course have to take care of retransmissions,
 	etc in this example). That is, depending on what you want
 	to do you perhaps do not need to implement a driver at all
-	and can then skip the driver related sections below.
-	The <c>gen_tcp_dist</c> example described in the
-	<seeguide marker="#distribution_module">Distribution
+	and can then skip the driver related sections below. The
+	<c>gen_tcp_dist</c> and <c>erl_uds_dist</c> examples described
+	in the <seeguide marker="#distribution_module">Distribution
 	Module</seeguide> section utilize distribution controller
 	processes and can be worth having a look at if you want to
 	use distribution controller processes.
@@ -187,14 +187,21 @@
 then voluntarily terminate when an exit signal is received.
 
 
- An example implementation of a distribution module can be found
- in
+ An example implementation of a distribution module can be found in
 <url href="gen_tcp_dist.erl">$ERL_TOP/lib/kernel/examples/gen_tcp_dist/src/gen_tcp_dist.erl</url>.
 It implements the distribution over TCP/IP using the <c>gen_tcp</c>
 API with distribution controllers implemented by processes. This
 instead of using port distribution controllers as the ordinary TCP/IP
 distribution uses.
 
+ 
+ Another example implementation of a distribution module can be found in
+ <url href="erl_uds_dist.erl">$ERL_TOP/lib/kernel/examples/erl_uds_dist/src/erl_uds_dist.erl</url>.
+ It implements the distribution over Unix domain sockets using the
+ <c>gen_tcp</c> API with distribution controllers implemented by processes.
+ Compared to the original <c>uds_dist</c> example using a port driver
+ written in C, <c>erl_uds_dist</c> is written entirely in Erlang.
+ 
 
 <section>
 <marker id="distribution_module_exported_callback_functions"/>
-- 
2.26.2

Places

File 2083-Add-documentation-for-the-erl_uds_dist-example.patch of Package erlang

Places