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

propagate from branch 'i2p.www' (head e5f805d2e620c89445cfe0bd86753119d187dc92)

Browse Source 
to branch 'i2p.www.revamp' (head 8181db5e7db56fa27ac7af59f1478ea7dd2bccc5)
This commit is contained in:
str4d
2013-12-08 21:00:35 +00:00
parent 782cb1c9ec 1d9428cf5d
commit 0243679747
31 changed files with 400 additions and 247 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
i2p2www/pages/site/docs/api/streaming.html
View File

@@ -1,7 +1,7 @@
{% extends "global/layout.html" %}
{% block title %}{% trans %}Streaming Library{% endtrans %}{% endblock %}
{% block lastupdated %}{% trans %}July 2013{% endtrans %}{% endblock %}
{% block accuratefor %}0.9.7{% endblock %}
{% block lastupdated %}{% trans %}December 2013{% endtrans %}{% endblock %}
{% block accuratefor %}0.9.9{% endblock %}
{% block content %}
<h2>{% trans %}Overview{% endtrans %}</h2>
@@ -413,6 +413,32 @@ CLOSE packets may contain data as well.
{%- endtrans %}</p>
<h3>Ping / Pong</h3>
<p>{% trans -%}
There is no ping function at the I2CP layer (equivalent to ICMP echo) or in datagrams.
This function is provided in streaming.
Pings and pongs may not be combined with a standard streaming packet;
if the ECHO option is set, then
most other flags, options, ackThrough, sequenceNum, NACKs, payload, etc. are ignored.
{%- endtrans %}</p>
<p>{% trans -%}
A ping packet must have the ECHO, SIGNATURE_INCLUDED, and FROM_INCLUDED flags set.
The sendStreamId must be greater than zero, and the receiveStreamId is ignored.
The sendStreamId may or may not correspond to an existing connection.
{%- endtrans %}</p>
<p>{% trans -%}
A pong packet must have the ECHO flag set.
The sendStreamId must be zero, and the receiveStreamId is the sendStreamId from the ping.
The pong packet does not include any payload that was contained in the ping.
{%- endtrans %}</p>
<p>{% trans -%}
Streaming may be configured to disable sending pongs with the configuration i2p.streaming.answerPings=false.
{%- endtrans %}</p>
<h3 id="sharing">{% trans %}Control Block Sharing{% endtrans %}</h3>
<p>{% trans -%}
The streaming lib supports "TCP" Control Block sharing.