From: Florian Forster <octo@collectd.org>
Date: Mon, 30 Jan 2012 13:47:04 +0000 (+0100)
Subject: network plugin: Document the standard buffer size with more detail.
X-Git-Tag: collectd-5.0.3~3
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=e6f09ba88ed8258e5bc3eb3834fb841eba77da39

network plugin: Document the standard buffer size with more detail.

Change-Id: I48e61fc2613ca50c477794167f180e3b4f4fc673
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 3d811105..1b0c2fd9 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2786,7 +2786,18 @@ operating systems.
 =item B<MaxPacketSize> I<1024-65535>
 
 Set the maximum size for datagrams received over the network. Packets larger
-than this will be truncated. Defaults to 1452E<nbsp>bytes.
+than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
+payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
+UDP.
+
+On the server side, this limit should be set to the largest value used on
+I<any> client. Likewise, the value on the client must not be larger than the
+value on the server, or data will be lost.
+
+B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
+buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
+value of 1024E<nbsp>bytes to avoid problems when sending data to an older
+server.
 
 =item B<Forward> I<true|false>
 
diff --git a/src/network.c b/src/network.c
index 840577f5..a19b586e 100644
--- a/src/network.c
+++ b/src/network.c
@@ -259,6 +259,7 @@ typedef struct receive_list_entry_s receive_list_entry_t;
  * Private variables
  */
 static int network_config_ttl = 0;
+/* Ethernet - (IPv6 + UDP) = 1500 - (40 + 8) = 1452 */
 static size_t network_config_packet_size = 1452;
 static int network_config_forward = 0;
 static int network_config_stats = 0;