Simple rate limiter

[nncp.git] / doc / cfg.texi

diff --git a/doc/cfg.texi b/doc/cfg.texi
index 5be0382bd69628ff5980d37b1abe971d548a36db..410bee884e2ef7305ccbff340a3846ab09f43471 100644 (file)
--- a/doc/cfg.texi
+++ b/doc/cfg.texi
@@ -57,6 +57,8 @@ neigh:
     freqchunked: 1024
     freqminsize: 2048
     via: [alice]
+    rxrate: 10
+    txrate: 20
 @end verbatim
 
 @strong{spool} field contains an absolute path to @ref{Spool, spool}
@@ -143,6 +145,13 @@ pairs pointing to @ref{nncp-daemon}'s listening instance. May be omitted
 if either no direct connection exists, or @ref{nncp-call} is used with
 forced address specifying.
 
+@anchor{CfgXxRate}
+@item rxrate/txrate
+If greater than zero, then at most *rate packets per second will be
+sent/received after the handshake. It could be used as crude bandwidth
+traffic shaper: each packet has at most 64 KiB payload size. Could be
+omitted at all -- no rate limits.
+
 @anchor{CfgOnlineDeadline}
 @item onlinedeadline
 Online connection deadline of node inactivity in seconds. It is the time