Moved i2pcontrol and *streaming pages into docs/api

This commit is contained in:
str4d
2012-11-10 21:53:08 +00:00
parent 51648c7d38
commit 46d0d5c7d9
3 changed files with 11 additions and 11 deletions

View File

@@ -1,4 +1,4 @@
{% extends "_layout.html" %}
{% extends "global/layout.html" %}
{% block title %}I2PControl API{% endblock %}
{% block content %}
<h1>I2PControl - Remote Control Service</h1>

View File

@@ -1,10 +1,10 @@
{% extends "_layout.html" %}
{% extends "global/layout.html" %}
{% block title %}Ministreaming Library{% endblock %}
{% block content %}
<h2>Note</h2>
The ministreaming library has been enhanced and extended by the
"full" <a href="streaming.html">streaming library</a>.
"full" <a href="{{ site_url('docs/api/streaming') }}">streaming library</a>.
Ministreaming is deprecated and is incompatible with today's applications.
The following documentation is old.
Also note that streaming extends ministreaming in the same Java package (net.i2p.client.streaming),
@@ -25,7 +25,7 @@ off into its own library both to keep the TCP-esque complexities separate and to
allow alternative optimized implementations.</p>
<p>The ministreaming library was written by mihi as a part of his
<a href="i2ptunnel">I2PTunnel</a> application and then factored out and released
<a href="{{ site_url('docs/api/i2ptunnel') }}">I2PTunnel</a> application and then factored out and released
under the BSD license. It is called the "mini"streaming library because it makes
some simplifications in the implementation, while a more robust streaming library
could be further optimized for operation over I2P. The two main issues with
@@ -44,4 +44,4 @@ implementations are introduced. The library is deployed in its own
ministreaming.jar.
Developers in Java who would like to use it can
access the API directly, while developers in other languages can use it through
<a href="sam">SAM</a>'s streaming support.</p>{% endblock %}
<a href="{{ site_url('docs/api/samv3') }}">SAM</a>'s streaming support.</p>{% endblock %}

View File

@@ -1,4 +1,4 @@
{% extends "_layout.html" %}
{% extends "global/layout.html" %}
{% block title %}Streaming Library{% endblock %}
{% block content %}
Updated November 2012, current as of router version 0.9.3
@@ -102,9 +102,9 @@ Time values are in ms.
</p>
<p>
Note that higher-layer APIs, such as
<a href="samv3.html">SAM</a>,
<a href="bob.html">BOB</a>, and
<a href="i2ptunnel.html">I2PTunnel</a>,
<a href="{{ site_url('docs/api/samv3') }}">SAM</a>,
<a href="{{ site_url('docs/api/bob') }}">BOB</a>, and
<a href="{{ site_url('docs/api/i2ptunnel') }}">I2PTunnel</a>,
may override these defaults with their own defaults.
Also note that many options only apply to servers listening for incoming connections.
</p><p>
@@ -369,7 +369,7 @@ There is no checksum field in the streaming protocol.
<h3>Packet Encapsulation</h3>
Each packet is sent through I2P as a single message (or as an individual clove in a
<a href="how_garlicrouting.html">Garlic Message</a>).
<a href="{{ site_url('docs/how/garlicrouting') }}">Garlic Message</a>).
Message encapsulation is implemented in the underlying
<a href="i2cp.html">I2CP</a>,
<a href="i2np.html">I2NP</a>, and
@@ -453,7 +453,7 @@ Additional tuning of the streaming lib parameters may be necessary.
<li>
Another area for research is the interaction of the streaming lib with the
NTCP and SSU transport layers.
See <a href="ntcp_discussion.html">the NTCP discussion page</a> for details.
See <a href="{{ site_url('docs/transport/ntcp/discussion') }}">the NTCP discussion page</a> for details.
</li>
<li>
The interaction of the routing algorithms with the streaming lib strongly affects performance.