summaryrefslogtreecommitdiffstats
path: root/src/knot/modules/noudp/noudp.rst
blob: e430395ac93eafec2252e71359343150e2c24ce8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.. _mod-noudp:

``noudp`` — No UDP response
===========================

The module sends empty truncated reply to a query over UDP. Replies over TCP
are not affected.

Example
-------

To enable this module for all configured zones and every UDP reply::

    template:
      - id: default
        global-module: mod-noudp

Or with specified UDP allow rate::

    mod-noudp:
      - id: sometimes
        udp-allow-rate: 1000  # Don't truncate every 1000th UDP reply

    template:
      - id: default
        module: mod-noudp/sometimes

Module reference
----------------

::

  mod-noudp:
   - id: STR
     udp-allow-rate: INT
     udp-truncate-rate: INT

.. NOTE::
   Both *udp-allow-rate* and *udp-truncate-rate* cannot be specified together.

.. _mod-noudp_udp-allow-rate:

udp-allow-rate
..............

Specifies frequency of UDP replies that are not truncated. A non-zero value means
that every N\ :sup:`th` UDP reply is not truncated.

.. NOTE::
   The rate value is associated with one UDP worker. If more UDP workers are
   configured, the specified value may not be obvious to clients.

*Default:* not set

.. _mod-noudp_udp-truncate-rate:

udp-truncate-rate
.................

Specifies frequency of UDP replies that are truncated (opposite of
:ref:`udp-allow-rate <mod-noudp_udp-allow-rate>`). A non-zero value means that
every N\ :sup:`th` UDP reply is truncated.

.. NOTE::
   The rate value is associated with one UDP worker. If more UDP workers are
   configured, the specified value may not be obvious to clients.

*Default:* ``1``