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

streaming, api, roadmap

Browse Source
This commit is contained in:
zzz
2009-11-07 23:23:29 +00:00
parent d3c443e3c5
commit 2c39a37a2e
4 changed files with 96 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
www.i2p2/pages/api.html
View File

@ -6,6 +6,9 @@
development guide</a> for ideas about the four basic protocols for writing an development guide</a> for ideas about the four basic protocols for writing an
application to run over I2P:</p> application to run over I2P:</p>
<ul class="helplist"> <ul class="helplist">
<li><a href="http://docs.i2p2.de/core/">Core I2P API Javadoc</a>
(<a href="http://docs.i2p2.i2p/core/">internal link</a>)</li>
<li>BOB</li>
<li><a href="sam">SAM</a>, <a href="samv2.html">SAM V2</a> and <a href="samv3.html">SAM V3</a></li> <li><a href="sam">SAM</a>, <a href="samv2.html">SAM V2</a> and <a href="samv3.html">SAM V3</a></li>
<li><a href="ministreaming">ministreaming</a></li> <li><a href="ministreaming">ministreaming</a></li>
<li><a href="i2cp">I2CP</a></li> <li><a href="i2cp">I2CP</a></li>

3
www.i2p2/pages/api_de.html
View File

@ -6,6 +6,9 @@
Anwendungen</a> nach Ideen &uuml;ber die 4 Grundprotokolle durchlesen, um eine Idee zum Schreiben Anwendungen</a> nach Ideen &uuml;ber die 4 Grundprotokolle durchlesen, um eine Idee zum Schreiben
einer Anwendung auf I2P zu bekommen:</p> einer Anwendung auf I2P zu bekommen:</p>
<ul class="helplist> <ul class="helplist>
<li><a href="http://docs.i2p2.de/core/">Core I2P API Javadoc</a>
(<a href="http://docs.i2p2.i2p/core/">internal link</a>)</li>
<li>BOB</li>
<li><a href="sam_de">SAM</a> und <a href="samv2_de.html">SAM V2</a></li> <li><a href="sam_de">SAM</a> und <a href="samv2_de.html">SAM V2</a></li>
<li><a href="ministreaming_de">ministreaming</a></li> <li><a href="ministreaming_de">ministreaming</a></li>
<li><a href="i2cp_de">I2CP</a></li> <li><a href="i2cp_de">I2CP</a></li>

3
www.i2p2/pages/roadmap.html
View File

@ -3,10 +3,11 @@
{% block content %} {% block content %}
<h2 id="0.8">0.8</h2> <h2 id="0.8">0.8</h2>
Mid-2009 Early 2010
<ul> <ul>
<li>Further research and improve the <a href="i2np.html">Message Priority System</a></li> <li>Further research and improve the <a href="i2np.html">Message Priority System</a></li>
<li>Reduce <a href="how_peerselection.html">peer profile</a> size, implement better ejection strategy </li> <li>Reduce <a href="how_peerselection.html">peer profile</a> size, implement better ejection strategy </li>
<li>Expand and rework the floodfill pool, bring back simlified Kademlia searches and stores for the pool</li>
<li>Reachability Mapping / handle peers partially reachable / enhanced <a href="todo.html#fullRestrictedRoutes">restricted routes</a></li> <li>Reachability Mapping / handle peers partially reachable / enhanced <a href="todo.html#fullRestrictedRoutes">restricted routes</a></li>
<li>Include some seed data in the distribution so a central reseed location isn't required? <li>Include some seed data in the distribution so a central reseed location isn't required?
<li>Distributed / enhanced i2pupdate distribution, set default to download</li> <li>Distributed / enhanced i2pupdate distribution, set default to download</li>

121
www.i2p2/pages/streaming.html
View File

@ -69,8 +69,8 @@ For a good example of usage, see the i2psnark code.
</p> </p>
<h2>Status</h2> <h2>Advantages</h2>
<p>The streaming lib has many advantages over the ministreaming library was written by mihi as a part of his <p>The streaming lib has many advantages over the ministreaming library written by mihi as a part of his
<a href="i2ptunnel">I2PTunnel</a> application. <a href="i2ptunnel">I2PTunnel</a> application.
The streaming library is The streaming library is
a more robust streaming library a more robust streaming library
@ -85,6 +85,8 @@ it contains a full windowing implementation.
Significant tuning of the streaming lib parameters, Significant tuning of the streaming lib parameters,
greatly increasing outbound performance, was implemented in 0.6.1.28. greatly increasing outbound performance, was implemented in 0.6.1.28.
Subsequent releases include additional tuning and bug fixes. Subsequent releases include additional tuning and bug fixes.
<h2>Default Parameters</h2>
The current default values are listed below. The current default values are listed below.
Lower case values are streaming lib parameters that can changed on a Lower case values are streaming lib parameters that can changed on a
per-connection basis. per-connection basis.
@ -164,43 +166,96 @@ See <a href="ntcp.html">the NTCP page</a> for a discussion.
<h2>Packet Format</h2> <h2>Packet Format</h2>
<p> <p>
Here is the format of a single packet transferred as part of a streaming connection. Here is the format of a single packet transferred as part of a streaming connection.
<ul> <table>
<li>sendStreamId [4 byte value] (random number selected by the connection recipient)</li> <tr><th>Field<th>Length<th>Contents
<li>receiveStreamId [4 byte value] (random number selected by the connection originator)</li> <tr><td>endStreamId <td>4 byte value<td>Random number selected by the connection recipient
<li>sequenceNum [4 byte unsigned integer]</li> and constant for the life of the connection.
<li>ackThrough [4 byte unsigned integer]</li> 0 in the SYN message sent by the originator.
<li>number of NACKs [1 byte unsigned integer]</li> <tr><td>receiveStreamId <td>4 byte value<td>Random number selected by the connection originator
<li>that many NACKs</li> and constant for the life of the connection.
<li>resendDelay [1 byte integer]</li>
<li>flags [2 byte value]</li> <tr><td>sequenceNum <td>4 byte unsigned integer<td>
<li>option data size [2 byte integer]</li> The sequence for this message, starting at 0 in the SYN message,
<li>option data specified by those flags [0 or more bytes]</li> and incremented by 1 in each message except for plain ACKs and retransmissions.
<li>payload [remaining packet size]</li> If the sequenceNum is 0 and the SYN is not set, this is a plain ACK
</ul> packet that should not be ACKed.
<tr><td>ackThrough <td>4 byte unsigned integer<td>
The highest packet sequence number that was received
on the receiveStreamId. This field is ignored on the initial
connection packet (where receiveStreamId is the unknown id) or
if FLAG_NO_ACK is set.
All packets up to and including this sequence number are acked,
EXCEPT for those listed in NACKs below.
<tr><td>number of NACKs <td>1 byte unsigned integer<td>
<tr><td>that many NACKs <td>n * 4 byte unsigned integers<td>
Sequence numbers less than ackThrough that are not yet received.
<tr><td>resendDelay <td>1 byte unsigned integer<td>
How long is the creator of this packet going to wait before
resending this packet (if it hasn't yet been ACKed). The
value is seconds since the packet was created.
Ignored on receive. Broken on send before release 0.7.8 (the sender did not divide by 1000,
and the default is 1000 ms, so the included value was 1000 &amp 0xff = 0xe8 = 232 seconds.
<tr><td>flags <td>2 byte value<td>
See below.
<tr><td>option data size <td>2 byte unsigned integer<td>
See below.
<tr><td>option data specified by those flags <td>0 or more bytes<td>
See below.
<tr><td>payload <td>remaining packet size<td>
</table>
<p>The flags field above specifies some metadata about the packet, and in <p>The flags field above specifies some metadata about the packet, and in
turn may require certain additional data to be included. The flags are turn may require certain additional data to be included. The flags are
as follows (with any data structures specified added to the options area as follows (with any data structures specified added to the options area
in the given order):</p><ol> in the given order):</p>
<li>FLAG_SYNCHRONIZE: no option data</li> <table>
<li>FLAG_CLOSE: no option data</li> <tr><th>Bit Number<th>Flag<th>Option Data<th>Function
<li>FLAG_RESET: no option data</li> <tr><td>0<td>FLAG_SYNCHRONIZE<td>no option data<td>
<li>FLAG_SIGNATURE_INCLUDED: net.i2p.data.Signature (40 bytes)</li> Similar to TCP SYN.
<li>FLAG_SIGNATURE_REQUESTED: no option data</li> <tr><td>1<td>FLAG_CLOSE<td>no option data<td>
<li>FLAG_FROM_INCLUDED net.i2p.data.Destination (typ. 387 bytes)</li> Similar to TCP FIN. If the response to a SYN fits in a single message, the response
<li>FLAG_DELAY_REQUESTED: 2 byte integer</li> will contain both FLAG_SYNCHRONIZE and FLAG_CLOSE.
<li>FLAG_MAX_PACKET_SIZE_INCLUDED: 2 byte integer</li> <tr><td>2<td>FLAG_RESET<td>no option data<td>
<li>FLAG_PROFILE_INTERACTIVE: no option data</li> Abnormal close.
<li>FLAG_ECHO: no option data</li> <tr><td>3<td>FLAG_SIGNATURE_INCLUDED<td>40 bytes<td>net.i2p.data.Signature
<li>FLAG_NO_ACK: no option data</li> Typically sent only with FLAG_SYNCHRONIZE.
</ol> If the signature is included, it uses the Destination's DSA key
<p>If the signature is included, it uses the Destination's DSA key
to sign the entire header and payload with the space in the options to sign the entire header and payload with the space in the options
for the signature being set to all zeroes.</p> for the signature being set to all zeroes.
<td>
<tr><td>4<td>FLAG_SIGNATURE_REQUESTED<td>no option data<td>
Unused. Requests every packet in the other direction to have FLAG_SIGNATURE_INCLUDED
<td>
<tr><td>5<td>FLAG_FROM_INCLUDED<td>typ. 387 bytes<td>net.i2p.data.Destination
Typically sent only with FLAG_SYNCHRONIZE.
<tr><td>6<td>FLAG_DELAY_REQUESTED<td>2 byte integer<td>
Optional delay.
How many milliseconds the sender of this packet wants the recipient
to wait before sending any more data
<td>
<tr><td>7<td>FLAG_MAX_PACKET_SIZE_INCLUDED<td>2 byte integer<td>
Apparently always included, could be optimized to only send with a SYN
<td>
<tr><td>8<td>FLAG_PROFILE_INTERACTIVE<td>no option data<td>
Apparently unused or ignored
<td>
<tr><td>9<td>FLAG_ECHO<td>no option data<td>
Unused except by ping programs
<tr><td>10<td>FLAG_NO_ACK<td>no option data<td>
Apparently unused, an ack is always included.
This flag simply tells the recipient to ignore the ackThrough field in the header.
<tr><td>11-15<td>unused<td><td>
</table>
<p>If the sequenceNum is 0 and the SYN is not set, this is a plain ACK
packet that should not be ACKed</p>
<h2>Control Block Sharing</h2> <h2>Control Block Sharing</h2>
<p> <p>