From: Ensar Sarajčić Date: Fri, 7 Feb 2025 11:45:16 +0000 (+0100) Subject: Update docs for `connectionCount` parameter X-Git-Tag: dnsdist-2.0.0-alpha1~111^2~8 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9de304d972bb929a99a7f902469da9fffce0951e;p=thirdparty%2Fpdns.git Update docs for `connectionCount` parameter --- diff --git a/pdns/dnsdistdist/docs/reference/dnstap.rst b/pdns/dnsdistdist/docs/reference/dnstap.rst index 0d5418b618..d67fcf3977 100644 --- a/pdns/dnsdistdist/docs/reference/dnstap.rst +++ b/pdns/dnsdistdist/docs/reference/dnstap.rst @@ -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 `. 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 `. 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 diff --git a/pdns/dnsdistdist/docs/reference/protobuf.rst b/pdns/dnsdistdist/docs/reference/protobuf.rst index d0e3699740..27c0a7e513 100644 --- a/pdns/dnsdistdist/docs/reference/protobuf.rst +++ b/pdns/dnsdistdist/docs/reference/protobuf.rst @@ -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