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

SAM: Add section on accept errors

Browse Source 
ref: Gitlab i2p.i2p #399
This commit is contained in:
zzz
2023-10-01 07:10:44 -04:00
parent 58883084a8
commit 4d66666202
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,7 @@
{% extends "global/layout.html" %}
{% block title %}SAM V3{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block accuratefor %}API 0.9.57{% endblock %}
{% block lastupdated %}2023-10{% endblock %}
{% block accuratefor %}API 0.9.59{% endblock %}
{% block content %}
<p>SAM is a simple client protocol for interacting with I2P.
SAM is the recommended protocol for non-Java applications to connect to the I2P network,
@ -944,6 +944,26 @@ passing through the current socket is forwarded from and to the connected
I2P destination peer, until one of the peer closes the socket.
</p>
<h4>Errors After OK</h4>
<p>
In rare cases, the SAM bridge may encounter an error after sending RESULT=OK,
but before a connection comes in and sending the $destination line to the client.
These errors may include router shutdown, router restart, and session close.
In these cases, when SILENT=false, the SAM bridge may, but is not required to
(implementation-dependent), send the line:
<pre>
&lt;- STREAM STATUS
RESULT=I2P_ERROR
[MESSAGE=...]
</pre>
before immediately closing the socket. This line is not, of course, decodable as a
valid Base 64 destination.
</p>
<h3>SAM Virtual Streams : FORWARD</h3>
<p>
A client can use a regular socket server and wait for connection requests