]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Update docs for `connectionCount` parameter
authorEnsar Sarajčić <dev@ensarsarajcic.com>
Fri, 7 Feb 2025 11:45:16 +0000 (12:45 +0100)
committerEnsar Sarajčić <dev@ensarsarajcic.com>
Fri, 7 Feb 2025 11:45:16 +0000 (12:45 +0100)
pdns/dnsdistdist/docs/reference/dnstap.rst
pdns/dnsdistdist/docs/reference/protobuf.rst

index 0d5418b6186a73594ccaef2988c27101a78fca9f..d67fcf3977a4370440b8e09e7559b3ff5284505b 100644 (file)
@@ -13,6 +13,9 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
 
 .. function:: newFrameStreamUnixLogger(path [, options])
 
+  .. versionchanged:: 2.0.0
+    Added ``connectionCount`` option.
+
   .. versionchanged:: 1.5.0
     Added the optional parameter ``options``.
 
@@ -25,7 +28,8 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
   The following options apply to the settings of the `framestream library
   <https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default and
   allowed values for these options, as well as their exact descriptions. For all these options, absence or a
-  zero value has the effect of using the library-provided default value.
+  zero value has the effect of using the library-provided default value. ``connectionCount`` can be used to open
+  multiple connections to the socket, for potential throughput boost.
 
   * ``bufferHint=0``: unsigned
   * ``flushTimeout=0``: unsigned
@@ -33,9 +37,13 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
   * ``outputQueueSize=0``: unsigned
   * ``queueNotifyThreshold=0``: unsigned
   * ``reopenInterval=0``: unsigned
+  * ``connectionCount=1``: unsigned
 
 .. function:: newFrameStreamTcpLogger(address [, options])
 
+  .. versionchanged:: 2.0.0
+    Added ``connectionCount`` option.
+
   .. versionchanged:: 1.5.0
     Added the optional parameter ``options``.
 
@@ -49,7 +57,8 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
   The following options apply to the settings of the `framestream library
   <https://github.com/farsightsec/fstrm>`. Refer to the documentation of that library for the default and
   allowed values for these options, as well as their exact descriptions. For all these options, absence or a
-  zero value has the effect of using the library-provided default value.
+  zero value has the effect of using the library-provided default value. ``connectionCount`` can be used to open
+  multiple connections to the socket, for potential throughput boost.
 
   * ``bufferHint=0``: unsigned
   * ``flushTimeout=0``: unsigned
@@ -57,6 +66,7 @@ To use FrameStream transport, :program:`dnsdist` must have been built with `libf
   * ``outputQueueSize=0``: unsigned
   * ``queueNotifyThreshold=0``: unsigned
   * ``reopenInterval=0``: unsigned
+  * ``connectionCount=1``: unsigned
 
 .. class:: DnstapMessage
 
index d0e3699740564cb93f81f007be1f25b36d184dc8..27c0a7e5131cbcc4729828c759bad7b72a2522bb 100644 (file)
@@ -1,7 +1,10 @@
 Protobuf Logging Reference
 ==========================
 
-.. function:: newRemoteLogger(address [, timeout=2[, maxQueuedEntries=100[, reconnectWaitTime=1]]])
+.. function:: newRemoteLogger(address [, timeout=2[, maxQueuedEntries=100[, reconnectWaitTime=1[, connectionCount=1]]]])
+
+  .. versionchanged:: 2.0.0
+    Added the optional ``connectionCount`` parameter.
 
   Create a Remote Logger object, to use with :func:`RemoteLogAction` and :func:`RemoteLogResponseAction`.
 
@@ -9,6 +12,7 @@ Protobuf Logging Reference
   :param int timeout: TCP connect timeout in seconds
   :param int maxQueuedEntries: Queue this many messages before dropping new ones (e.g. when the remote listener closes the connection)
   :param int reconnectWaitTime: Time in seconds between reconnection attempts
+  :param int connectionCount: Number of connections to open to the socket
 
 .. class:: DNSDistProtoBufMessage