From: Florian Forster <octo@collectd.org>
Date: Tue, 2 May 2017 09:23:05 +0000 (+0200)
Subject: libcollectdclient: Improve documentation of lcc_listener_t.conn.
X-Git-Tag: collectd-5.8.0~102^2~9
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=0c593a0f20e5b149645dfdc53e235e8805431021;p=collectd.git

libcollectdclient: Improve documentation of lcc_listener_t.conn.
---

diff --git a/src/libcollectdclient/collectd/server.h b/src/libcollectdclient/collectd/server.h
index 38bc68f7..ef6b792b 100644
--- a/src/libcollectdclient/collectd/server.h
+++ b/src/libcollectdclient/collectd/server.h
@@ -48,7 +48,9 @@ typedef int (*lcc_network_parser_t)(void *payload, size_t payload_size,
 
 /* lcc_listener_t holds parameters for running a collectd server. */
 typedef struct {
-  /* conn is a UDP socket for the server to listen on. */
+  /* conn is a UDP socket for the server to listen on. If set to <0 node and
+   * service will be used to open a new UDP socket. If >=0, it is the caller's
+   * job to clean up the socket. */
   int conn;
 
   /* node is the local address to listen on if conn is <0. Defaults to "::" (any