From 9489894b2ccb93ec880f8a2512349689e4cda278 Mon Sep 17 00:00:00 2001 From: Otto Moerbeek Date: Fri, 1 May 2026 09:53:21 +0200 Subject: [PATCH] rec docs: fix description of (outgoing)ProtobufServer And remove obsolete variant. Fixes #17278 Signed-off-by: Otto Moerbeek --- .../recursordist/docs/lua-config/protobuf.rst | 23 ------------------- pdns/recursordist/rec-rust-lib/table.py | 8 +++---- 2 files changed, 4 insertions(+), 27 deletions(-) diff --git a/pdns/recursordist/docs/lua-config/protobuf.rst b/pdns/recursordist/docs/lua-config/protobuf.rst index d70a869ab5..ec3bf0f184 100644 --- a/pdns/recursordist/docs/lua-config/protobuf.rst +++ b/pdns/recursordist/docs/lua-config/protobuf.rst @@ -59,19 +59,6 @@ Protobuf export to a server is enabled using the ``protobufServer()`` directive: - ``'FirstAvailable'`` send to first server that has room in its queue. - ``'Hashed'`` send to a single server, indexed by a hash of the qname and client address. -.. function:: protobufServer(server [[[[[[[, timeout=2], maxQueuedEntries=100], reconnectWaitTime=1], maskV4=32], maskV6=128], asyncConnect=false], taggedOnly=false]) - - .. deprecated:: 4.2.0 - - :param string server: The IP and port to connect to - :param int timeout: Time in seconds to wait when sending a message - :param int maxQueuedEntries: How many entries will be kept in memory if the server becomes unreachable - :param int reconnectWaitTime: How long to wait, in seconds, between two reconnection attempts - :param int maskV4: network mask to apply to the client IPv4 addresses, for anonymization purposes. The default of 32 means no anonymization. - :param int maskV6: Same as maskV4, but for IPv6. Defaults to 128. - :param bool taggedOnly: Only entries with a policy or a policy tag set will be sent. - :param bool asyncConnect: When set to false (default) the first connection to the server during startup will block up to ``timeout`` seconds; otherwise, the connection is done in a separate thread, after the first message has been queued.. - .. function:: setProtobufMasks(maskv4, maskV6) .. versionadded:: 4.2.0 @@ -114,16 +101,6 @@ While :func:`protobufServer` only exports the queries sent to the recursor from Added support for the HTTPS, SVCB and NAPTR records types. -.. function:: outgoingProtobufServer(server [[[[, timeout=2], maxQueuedEntries=100], reconnectWaitTime=1], asyncConnect=false]) - - .. deprecated:: 4.2.0 - - :param string server: The IP and port to connect to - :param int timeout: Time in seconds to wait when sending a message - :param int maxQueuedEntries: How many entries will be kept in memory if the server becomes unreachable - :param int reconnectWaitTime: How long to wait, in seconds, between two reconnection attempts - :param bool asyncConnect: When set to false (default) the first connection to the server during startup will block up to ``timeout`` seconds; otherwise, the connection is done in a separate thread, after the first message has been queued.. - Protocol Buffers Definition --------------------------- diff --git a/pdns/recursordist/rec-rust-lib/table.py b/pdns/recursordist/rec-rust-lib/table.py index c66bebee13..135166ebf2 100644 --- a/pdns/recursordist/rec-rust-lib/table.py +++ b/pdns/recursordist/rec-rust-lib/table.py @@ -3458,9 +3458,9 @@ Interval (in hours) to re-read the ``trustanchorfile``. Zero disables periodic "default": "", "help": "Sequence of protobuf servers", "doc": """ -Sequence of outgoing protobuf servers. Currently the maximum size of this list is one. +Sequence of protobuf servers receiving protobuf messages on client requests and/or answers. Currently the maximum size of this list is one. """, - "skip-old": "Equivalent Lua config in :doc:`lua-config/protobuf`", + "skip-old": "Equivalent Lua config in :func:`protobufServer`", "versionadded": "5.1.0", "runtime": ["reload-lua-config", "reload-yaml"], }, @@ -3471,9 +3471,9 @@ Sequence of outgoing protobuf servers. Currently the maximum size of this list i "default": "", "help": "List of outgoing protobuf servers", "doc": """ -Sequence of outgoing protobuf servers. Currently the maximum size of this list is one. +Sequence of protobuf servers receiving protobuf messages on outgoing requests and/or answers. Currently the maximum size of this list is one. """, - "skip-old": "Equivalent Lua config in :doc:`lua-config/protobuf`", + "skip-old": "Equivalent Lua config in :func:`outgoingProtobufServer`", "versionadded": "5.1.0", "runtime": ["reload-lua-config", "reload-yaml"], }, -- 2.47.3