From 54b5f4c5eaf4aeca4f85eb7fcb08ec6c42b95e79 Mon Sep 17 00:00:00 2001 From: zzz Date: Wed, 6 May 2020 11:59:30 +0000 Subject: [PATCH] streaming clarification --- i2p2www/pages/site/docs/api/streaming.html | 12 ++++++++---- i2p2www/spec/streaming.rst | 4 ++-- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/i2p2www/pages/site/docs/api/streaming.html b/i2p2www/pages/site/docs/api/streaming.html index 87b103bb..176edf68 100644 --- a/i2p2www/pages/site/docs/api/streaming.html +++ b/i2p2www/pages/site/docs/api/streaming.html @@ -1,7 +1,7 @@ {% extends "global/layout.html" %} {% block title %}{% trans %}Streaming Library{% endtrans %}{% endblock %} -{% block lastupdated %}{% trans %}July 2018{% endtrans %}{% endblock %} -{% block accuratefor %}0.9.36{% endblock %} +{% block lastupdated %}2020-04{% endblock %} +{% block accuratefor %}0.9.46{% endblock %} {% block content %}

{% trans %}Overview{% endtrans %}

@@ -300,7 +300,8 @@ As of release {{ release }}. {%- endtrans %} i2p.streaming.maxMessageSize1730{% trans -%} -The MTU in bytes. +The maximum size of the payload, +i.e. the MTU in bytes. {%- endtrans %} i2p.streaming.maxResends8{% trans -%} @@ -403,7 +404,10 @@ a large amount of overhead. The MTU is specified by the option i2p.streaming.maxMessageSize. The current default MTU of 1730 was chosen to fit precisely into two 1K I2NP tunnel messages, including overhead for the typical case. -{%- endtrans %}

+{%- endtrans %} +Note: This is the maximum size of the payload only, not including the header. +

+

{% trans -%} The first message in a connection includes a 387 byte (typical) Destination added by the streaming layer, diff --git a/i2p2www/spec/streaming.rst b/i2p2www/spec/streaming.rst index 2b15b4b0..4eb12dc8 100644 --- a/i2p2www/spec/streaming.rst +++ b/i2p2www/spec/streaming.rst @@ -184,8 +184,8 @@ Bit order: 15....0 (15 is MSB) [Integer]_ wants the recipient to wait before sending any more data. A value greater than 60000 indicates choking. - 7 MAX_PACKET_SIZE_INCLUDED 3 2 byte Currently sent with SYNCHRONIZE only. Was also sent in - [Integer]_ retransmitted packets until release 0.9.1. + 7 MAX_PACKET_SIZE_INCLUDED 3 2 byte The maximum length of the payload. Send with SYNCHRONIZE. + [Integer]_ 8 PROFILE_INTERACTIVE -- -- Unused or ignored; the interactive profile is unimplemented.