diff options
| author | Maxime Devos <maximedevos@telenet.be> | 2023-02-01 15:43:21 +0100 |
|---|---|---|
| committer | Maxime Devos <maximedevos@telenet.be> | 2023-02-02 18:48:40 +0100 |
| commit | ab3795c4363b28d3cb5bd2d8c31080edfe214dd7 (patch) | |
| tree | ae521c5496274d6f29e9c3bb05fd6345c981a552 | |
| parent | 3cb4d0007ad2c0a130348ab398c11965a02be8bb (diff) | |
| download | gnunet-scheme-ab3795c4363b28d3cb5bd2d8c31080edfe214dd7.tar.gz gnunet-scheme-ab3795c4363b28d3cb5bd2d8c31080edfe214dd7.zip | |
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.
| -rw-r--r-- | doc/cadet.tm | 27 |
1 files 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 @@ | |||
| 52 | To contact a peer over CADET, the remote peer must have an <dfn|open | 52 | To contact a peer over CADET, the remote peer must have an <dfn|open |
| 53 | port><index|port> and the local peer needs to contact this port. The remote | 53 | port><index|port> and the local peer needs to contact this port. The remote |
| 54 | peer\Uport identifier pair is called a <dfn|CADET address><index|CADET | 54 | peer\Uport identifier pair is called a <dfn|CADET address><index|CADET |
| 55 | address> in Scheme-GNUnet. A <dfn|CADET address> can be made with the | 55 | address> in Scheme-GNUnet. A <dfn|CADET address> is represented by the |
| 56 | <scm|make-cadet-address> procedure: | 56 | <acronym|cisw> (<reference|cisw>) type cadet-address: |
| 57 | 57 | ||
| 58 | <\explain> | 58 | <\explain> |
| 59 | <scm|(make-cadet-address <var|peer> <var|port>)> | 59 | <scm|(make-cadet-address <var|peer> <var|port>)><index|make-cadeet-address> |
| 60 | |||
| 61 | <scm|(make-cadet-address/share <var|peer> | ||
| 62 | <var|port>)><index|make-cadet-address/share> | ||
| 60 | <|explain> | 63 | <|explain> |
| 61 | Make a CADET address for the peer <var|peer> (a readable bytevector slice | 64 | Make a CADET address for the peer <var|peer> (a readable bytevector slice |
| 62 | containing a <scm|/peer-identity>) at the port <var|port> (a readable | 65 | containing a <scm|/peer-identity>) at the port <var|port> (a readable |
| 63 | bytevector slice containing a <scm|/hashcode:512>). The slices <var|peer> | 66 | bytevector slice containing a <scm|/hashcode:512>), subject to the |
| 64 | and <var|port> are copied, so future changes to them do not have any | 67 | <acronym|cisw> restrictions. |
| 65 | impact on the CADET address. | ||
| 66 | |||
| 67 | The predicate for CADET addresses is <scm|cadet-address?>. The peer and | ||
| 68 | port can be extracted with the accessors <scm|cadet-address-peer> and | ||
| 69 | <scm|cadet-address-port>. CADET addresses can be compared with | ||
| 70 | <scm|equal?>. | ||
| 71 | </explain> | 68 | </explain> |
| 72 | 69 | ||
| 70 | <\explain> | ||
| 71 | <scm|cadet-address-peer><index|cadet-address-peer>, | ||
| 72 | <scm|cadet-address-port><index|cadet-address-port>, | ||
| 73 | <scm|cadet-address=?><index|cadet-address=?>, | ||
| 74 | <scm|cadet-address?><index|cadet-address?> | ||
| 75 | </explain|Standard <acronym|cisw> procedures. CADET addresses cannot be | ||
| 76 | compared with <scm|equal?>.> | ||
| 77 | |||
| 73 | Guile has a generic interface for network addresses, see (guile)Network | 78 | Guile has a generic interface for network addresses, see (guile)Network |
| 74 | Socket Address. If BSD socket integration is activated (see <todo|todo>), | 79 | Socket Address. If BSD socket integration is activated (see <todo|todo>), |
| 75 | this interface is extended to support CADET addresses. In particular, | 80 | this interface is extended to support CADET addresses. In particular, |