I2P_Developers/i2p.www
3
0
Fork 5
Code Issues 27 Pull Requests Packages Projects Releases Wiki Activity

cross-referencing I2CP and Streaming use in higher-level API's, changing language display to be pure-text

Browse Source
This commit is contained in:
hankhill19580
2019-06-27 18:36:24 +00:00
parent 3a5a7fa629
commit d8eb5e24ad
6 changed files with 38 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
i2p2www/pages/site/docs/api/samv3.html
View File

@@ -127,8 +127,8 @@ Version 3.3 was introduced in I2P release 0.9.25.
<h3>Simple Anonymous Messaging (SAM) Version 3.3 Specification Overview</h3>
<p>
The client application talks to the SAM bridge, which deals with
all of the I2P functionality (using the streaming
library for virtual streams, or I2CP directly for datagrams).
all of the I2P functionality (using the <a href="{{ site_url('docs/api/streaming') }}">streaming library</a>
for virtual streams, or <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> directly for datagrams).
</p><p>
By default, the client&lt;--&gt;SAM bridge communication is unencrypted and unauthenticated.
@@ -211,7 +211,7 @@ The protocol, as specified, is case-sensitive.
It is recommended but not required that the server map commands to upper case, for ease in testing via telnet.
This would allow, for example, "hello version" to work.
This is implementation-dependent.
Do not map keys or values to upper case, as this would corrupt I2CP options.
Do not map keys or values to upper case, as this would corrupt <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> options.
</p>
@@ -287,9 +287,9 @@ and then disconnects.
<h3>I2CP Ports and Protocol</h3>
<p>
As of SAM 3.2, the I2CP ports and protocol may be specified by the
SAM client sender to be passed through to I2CP, and
the SAM bridge will pass the received I2CP port and protocol
As of SAM 3.2, the <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> ports and protocol may be specified by the
SAM client sender to be passed through to <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a>, and
the SAM bridge will pass the received <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> port and protocol
information to the SAM client.
</p><p>
For FROM_PORT and TO_PORT, the valid range is 0-65535, and the default is 0.
@@ -298,9 +298,9 @@ For PROTOCOL, which may be specified only for RAW, the valid range is 0-255, and
</p><p>
For SESSION commands, the specified ports and protocol are the defaults for that session.
For individual streams or datagrams, the specified ports and protocol override the session defaults.
For received streams or datagrams, the indicated ports and protocol are as received from I2CP.
For received streams or datagrams, the indicated ports and protocol are as received from <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a>.
</p><p>
See the I2CP specification for more information.
See the <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> specification for more information.
</p><p>
@@ -795,7 +795,7 @@ This is all on one line (space separated), shown on multiple lines for clarity:
All options are per-datagram settings that override the defaults specified in the SESSION CREATE.
</li><li>
Version 3.3 options SEND_TAGS, TAG_THRESHOLD, EXPIRES, and SEND_LEASESET
will be passed to I2CP if supported. See <a href="../protocol/i2cp#msg_SendMessageExpire">the I2CP specification</a> for details.
will be passed to <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> if supported. See <a href="../protocol/i2cp#msg_SendMessageExpire">the I2CP specification</a> for details.
Support by the SAM server is optional, it will ignore these options if unsupported.
</li><li>
this line is '\n' terminated.
@@ -1061,7 +1061,7 @@ STREAM CONNECT, DATAGRAM SEND, etc. must use the subsession ID on a separate soc
</p><p>
The MASTER session connects to the router and builds tunnels. When the SAM bridge responds,
tunnels have been built and the session is ready for subsessions to be added.
All I2CP options pertaining to tunnel parameters such as length, quantity, and nickname must
All <a href="{{ site_url('docs/protocol/i2cp') }}">I2CP</a> options pertaining to tunnel parameters such as length, quantity, and nickname must
be provided in the master's SESSION CREATE.
</p><p>
All utility commands are supported on a master session.
@@ -1358,7 +1358,7 @@ SAM SESSION CREATE line.
</p><p>
All sessions may include <a href="{{ site_url('docs/protocol/i2cp') }}#options">I2CP options such as tunnel lengths</a>.
STREAM sessions may include <a href="{{ site_url('docs/api/streaming') }}#options">Streaming lib options</a>.
STREAM sessions may include <a href="{{ site_url('docs/api/streaming') }}#options">Streaming library options</a>.
See those references for option names and defaults.