[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 07/08: doc/cadet: Simplify cadet address documentation w
From: |
gnunet |
Subject: |
[gnunet-scheme] 07/08: doc/cadet: Simplify cadet address documentation with a reference to cisw. |
Date: |
Thu, 02 Feb 2023 18:49:09 +0100 |
This is an automated email from the git hooks/post-receive script.
maxime-devos pushed a commit to branch master
in repository gnunet-scheme.
commit ab3795c4363b28d3cb5bd2d8c31080edfe214dd7
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Wed Feb 1 15:43:21 2023 +0100
doc/cadet: Simplify cadet address documentation with a reference to cisw.
While there are now more lines in the .tm, it also documents more and
in fewer words.
* doc/cadet.tm (Addresses): Simplify it.
---
doc/cadet.tm | 27 ++++++++++++++++-----------
1 file changed, 16 insertions(+), 11 deletions(-)
diff --git a/doc/cadet.tm b/doc/cadet.tm
index 6d7eaa3..e42985b 100644
--- a/doc/cadet.tm
+++ b/doc/cadet.tm
@@ -52,24 +52,29 @@
To contact a peer over CADET, the remote peer must have an <dfn|open
port><index|port> and the local peer needs to contact this port. The remote
peer\Uport identifier pair is called a <dfn|CADET address><index|CADET
- address> in Scheme-GNUnet. A <dfn|CADET address> can be made with the
- <scm|make-cadet-address> procedure:
+ address> in Scheme-GNUnet. A <dfn|CADET address> is represented by the
+ <acronym|cisw> (<reference|cisw>) type cadet-address:
<\explain>
- <scm|(make-cadet-address <var|peer> <var|port>)>
+ <scm|(make-cadet-address <var|peer> <var|port>)><index|make-cadeet-address>
+
+ <scm|(make-cadet-address/share <var|peer>
+ <var|port>)><index|make-cadet-address/share>
<|explain>
Make a CADET address for the peer <var|peer> (a readable bytevector slice
containing a <scm|/peer-identity>) at the port <var|port> (a readable
- bytevector slice containing a <scm|/hashcode:512>). The slices <var|peer>
- and <var|port> are copied, so future changes to them do not have any
- impact on the CADET address.
-
- The predicate for CADET addresses is <scm|cadet-address?>. The peer and
- port can be extracted with the accessors <scm|cadet-address-peer> and
- <scm|cadet-address-port>. CADET addresses can be compared with
- <scm|equal?>.
+ bytevector slice containing a <scm|/hashcode:512>), subject to the
+ <acronym|cisw> restrictions.
</explain>
+ <\explain>
+ <scm|cadet-address-peer><index|cadet-address-peer>,
+ <scm|cadet-address-port><index|cadet-address-port>,
+ <scm|cadet-address=?><index|cadet-address=?>,
+ <scm|cadet-address?><index|cadet-address?>
+ </explain|Standard <acronym|cisw> procedures. CADET addresses cannot be
+ compared with <scm|equal?>.>
+
Guile has a generic interface for network addresses, see (guile)Network
Socket Address. If BSD socket integration is activated (see <todo|todo>),
this interface is extended to support CADET addresses. In particular,
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet-scheme] branch master updated (44061e6 -> 86e6038), gnunet, 2023/02/02
- [gnunet-scheme] 01/08: fs/struct: Add missing field 'signature' of /:msg:fs:response-loc-signature., gnunet, 2023/02/02
- [gnunet-scheme] 06/08: doc/typeclasses: Document cisw types., gnunet, 2023/02/02
- [gnunet-scheme] 07/08: doc/cadet: Simplify cadet address documentation with a reference to cisw.,
gnunet <=
- [gnunet-scheme] 08/08: utils/records: Raise &missing-capabilities exceptions., gnunet, 2023/02/02
- [gnunet-scheme] 05/08: hashcode: Define equality procedures., gnunet, 2023/02/02
- [gnunet-scheme] 04/08: records: New API for record types, specialised to bytevector slices., gnunet, 2023/02/02
- [gnunet-scheme] 02/08: bv-slice: Add procedure for comparing slices., gnunet, 2023/02/02
- [gnunet-scheme] 03/08: tests/util: Ignore location of slices., gnunet, 2023/02/02