kytv/I2P_Website
1
0
Fork 0
forked from I2P_Developers/i2p.www
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

I2CP Spec:

Browse Source 
Push new I2CP features to 0.9.11
Add Session ID to Host Lookup/Reply messages
This commit is contained in:
zzz
2014-01-10 13:19:35 +00:00
parent 929c0e5d50
commit ce4ae185ce
1 changed files with 16 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
i2p2www/pages/site/docs/spec/i2cp.html
View File

@@ -1,6 +1,6 @@
{% extends "global/layout.html" %} {% extends "global/layout.html" %}
{% block title %}I2CP Specification{% endblock %} {% block title %}I2CP Specification{% endblock %}
{% block lastupdated %}December 2013{% endblock %} {% block lastupdated %}January 2014{% endblock %}
{% block accuratefor %}0.9.9{% endblock %} {% block accuratefor %}0.9.9{% endblock %}
{% block content %} {% block content %}
<h2>Overview</h2> <h2>Overview</h2>
@@ -327,14 +327,14 @@ HostLookupMessage
</a> </a>
<td align="center">C-&gt;R <td align="center">C-&gt;R
<td align=right>38 <td align=right>38
<td align="center">0.9.10 <td align="center">0.9.11
<tr><td> <tr><td>
<a href="#msg_HostReply"> <a href="#msg_HostReply">
HostReplyMessage HostReplyMessage
</a> </a>
<td align="center">R-&gt;C <td align="center">R-&gt;C
<td align=right>39 <td align=right>39
<td align="center">0.9.10 <td align="center">0.9.11
<tr><td> <tr><td>
<a href="#msg_MessagePayload"> <a href="#msg_MessagePayload">
MessagePayloadMessage MessagePayloadMessage
@@ -549,7 +549,7 @@ The router responds with a <a href="#msg_DestReply">Dest Reply Message</a>.
As of release 0.7. As of release 0.7.
As of release 0.8.3, multiple outstanding lookups are supported, As of release 0.8.3, multiple outstanding lookups are supported,
and lookups are supported in both I2PSimpleSession and in standard sessions. and lookups are supported in both I2PSimpleSession and in standard sessions.
<a href="#msg_HostLookup">Host Lookup Message</a> is preferred as of release 0.9.10. <a href="#msg_HostLookup">Host Lookup Message</a> is preferred as of release 0.9.11.
</p> </p>
@@ -648,7 +648,7 @@ The router responds with a <a href="#msg_SetDate">Set Date Message</a>.
I2CP Version <a href="{{ site_url('docs/spec/common-structures') }}#struct_String">String</a> I2CP Version <a href="{{ site_url('docs/spec/common-structures') }}#struct_String">String</a>
</li><li> </li><li>
Authentication <a href="{{ site_url('docs/spec/common-structures') }}#type_Mapping">Mapping</a> Authentication <a href="{{ site_url('docs/spec/common-structures') }}#type_Mapping">Mapping</a>
(optional, as of release 0.9.10) (optional, as of release 0.9.11)
</li></ol> </li></ol>
<h4>Notes</h4> <h4>Notes</h4>
@@ -659,7 +659,7 @@ The version string is included as of release 0.8.7.
This is only useful if the client and router are not in the same JVM. This is only useful if the client and router are not in the same JVM.
If it is not present, the client is version 0.8.6 or earlier. If it is not present, the client is version 0.8.6 or earlier.
</li><li> </li><li>
Preliminary: As of release 0.9.10, the authentication Preliminary: As of release 0.9.11, the authentication
<a href="{{ site_url('docs/spec/common-structures') }}#type_Mapping">Mapping</a> <a href="{{ site_url('docs/spec/common-structures') }}#type_Mapping">Mapping</a>
may be included, with the keys i2cp.username and i2cp.password. may be included, with the keys i2cp.username and i2cp.password.
The Mapping need not be sorted as this message is not signed. The Mapping need not be sorted as this message is not signed.
@@ -691,6 +691,8 @@ which is much more efficient.
<h4>Contents</h4> <h4>Contents</h4>
<ol><li> <ol><li>
<a href="#struct_SessionId">Session ID</a>
</li><li>
4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> request ID 4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> request ID
</li><li> </li><li>
4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> timeout (ms) 4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> timeout (ms)
@@ -704,10 +706,11 @@ host name <a href="{{ site_url('docs/spec/common-structures') }}#struct_String">
<h4>Notes</h4> <h4>Notes</h4>
<ul><li> <ul><li>
Preliminary. As of release 0.9.10. Preliminary. As of release 0.9.11.
Use <a href="#msg_DestLookup">Dest Lookup Message</a> for older routers. Use <a href="#msg_DestLookup">Dest Lookup Message</a> for older routers.
</li><li> </li><li>
The request ID will be returned in the <a href="#msg_HostReply">Host Reply Message</a>. The session ID and request ID will be returned in the <a href="#msg_HostReply">Host Reply Message</a>.
Use 0xFFFF for the session ID if there is no session.
</li><li> </li><li>
Timeout is useful for Hash lookups. Recommended minimum 10,000 (10 sec.). Timeout is useful for Hash lookups. Recommended minimum 10,000 (10 sec.).
In the future it may also be useful for remote naming service lookups. In the future it may also be useful for remote naming service lookups.
@@ -729,6 +732,8 @@ Sent from Router to Client in response to a
</p> </p>
<h4>Contents</h4> <h4>Contents</h4>
<ol><li> <ol><li>
<a href="#struct_SessionId">Session ID</a>
</li><li>
4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> request ID 4 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> request ID
</li><li> </li><li>
1 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> result code 1 byte <a href="{{ site_url('docs/spec/common-structures') }}#type_Integer">Integer</a> result code
@@ -739,10 +744,10 @@ only present if result code is zero.
<h4>Notes</h4> <h4>Notes</h4>
<ul><li> <ul><li>
Preliminary. As of release 0.9.10. Preliminary. As of release 0.9.11.
See Host Lookup notes. See Host Lookup notes.
</li><li> </li><li>
The request ID is that from the Host Lookup. The session ID and request ID are those from the Host Lookup.
</li><li> </li><li>
The result code is 0 for success, 1-255 for failure. The result code is 0 for success, 1-255 for failure.
Only 1 is used for failure now, more specific failure codes may be defined in the future. Only 1 is used for failure now, more specific failure codes may be defined in the future.
@@ -1146,7 +1151,7 @@ Bit order: 15...0
</p><p> </p><p>
Bits 15-11: Unused, must be zero Bits 15-11: Unused, must be zero
</p><p> </p><p>
Bits 10-9: Message Reliability Override (scheduled for release 0.9.10) Bits 10-9: Message Reliability Override (scheduled for release 0.9.11)
<table border=1> <table border=1>
<tr><th>Field value<th>Description <tr><th>Field value<th>Description
<tr><td align="center">00<td>Use session setting i2cp.messageReliabiltiy (default) <tr><td align="center">00<td>Use session setting i2cp.messageReliabiltiy (default)