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

SAM:

Browse Source 
- Document v1/v2 datagram modes in v3 (ticket #1334)
- Clarify DESTINATION parameter in v1/v2 modes
- Document minimum and recommended maximum datagram sizes (ticket #1335)
This commit is contained in:
zzz
2014-07-19 15:57:32 +00:00
parent 3421d20a2f
commit 1d56d1a21e
3 changed files with 67 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,6 +1,6 @@
{% extends "global/layout.html" %}
{% block title %}SAM V3{% endblock %}
{% block lastupdated %}June 2014{% endblock %}
{% block lastupdated %}July 2014{% endblock %}
{% block accuratefor %}0.9.14{% endblock %}
{% block content %}
<p>Specified below is a simple client protocol for interacting with I2P.
@ -46,6 +46,7 @@ Version 3.1 was introduced in I2P release 0.9.14.
<li>DEST GENERATE and SESSION CREATE now support a SIGNATURE_TYPE parameter.
<li>The MIN and MAX parameters in HELLO VERSION are now optional.
<li>The MIN and MAX parameters in HELLO VERSION now support single-digit versions such as "3".
<li>RAW SEND is now supported on the bridge socket.
</ul>
</p>
@ -352,11 +353,14 @@ SAM repliable datagrams : sending a datagram
----------------------------------------------------------------------
While I2P doesn't inherently contain a FROM address, for ease of use
an additional layer is provided as repliable datagrams - unordered
and unreliable messages of up to 31KB in size that include a FROM
and unreliable messages of up to 31744 bytes that include a FROM
address (leaving up to 1KB for header material). This FROM address
is authenticated internally by SAM (making use of the destination's
signing key to verify the source) and includes replay prevention.
Minimum size is 1. For best delivery reliability, recommended maximum
size is approximately 11 KB.
After establishing a SAM session with STYLE=DATAGRAM, the client can
send datagrams through SAM's UDP port (7655).
@ -427,7 +431,10 @@ SAM anonymous datagrams
Squeezing the most out of I2P's bandwidth, SAM allows clients to send
and receive anonymous datagrams, leaving authentication and reply
information up to the client themselves. These datagrams are
unreliable and unordered, and may be up to 32KB in size.
unreliable and unordered, and may be up to 32768 bytes.
Minimum size is 1. For best delivery reliability, recommended maximum
size is approximately 11 KB.
After establishing a SAM session with STYLE=RAW, the client can
send anonymous datagrams through the SAM bridge exactly the same way
@ -449,6 +456,25 @@ the following data :
{$datagram_payload}
----------------------------------------------------------------------
V1/V2 Compatible Datagram Handling
----------------------------------------------------------------------
In SAM V3, the preferred way to send datagrams is via the datagram socket
at port 7655 as documented above. However, repliable datagrams may be sent
directly via the SAM bridge socket using the DATAGRAM SEND command,
as documented in <a href="sam>SAM V1</a> and <a href="samv2>SAM V2</a>.
As of release 0.9.14 (version 3.1), anonymous datagrams may be sent
directly via the SAM bridge socket using the RAW SEND command,
as documented in <a href="sam>SAM V1</a> and <a href="samv2>SAM V2</a>.
These commands do <i>not</i> support the ID parameter. The datagrams are
sent to the most recently created DATAGRAM- or RAW-style session,
as appropriate. Support for the ID parameter may be added in a future release.
----------------------------------------------------------------------
SAM utility functionality
----------------------------------------------------------------------