pdns/dnsdistdist/docs/reference/netmaskgroup.rst

   1 NetmaskGroup
   2 ============
   3
   4 .. function:: newNMG() -> NetmaskGroup
   5
   6   Returns a NetmaskGroup
   7
   8 .. class:: NetmaskGroup
   9
  10    Represents a group of netmasks that can be used to match :class:`ComboAddress`\ es against.
  11
  12   .. method:: NetmaskGroup:addMask(mask)
  13               NetmaskGroup:addMasks(masks)
  14
  15     Add one or more masks to the NMG.
  16
  17     :param string mask: Add this mask, prefix with `!` to exclude this mask from matching.
  18     :param table masks: Adds the keys of the table to the :class:`NetmaskGroup`. It should be a table whose keys are :class:`ComboAddress` objects and whose values are integers. The integer values of the table entries are ignored. The table is of the same type as the table returned by the `exceed*` functions.
  19
  20   .. method:: NetmaskGroup:match(address) -> bool
  21
  22     Checks if ``address`` is matched by this NetmaskGroup.
  23
  24     :param ComboAddress address: The address to match.
  25
  26   .. method:: NetmaskGroup:clear()
  27
  28     Clears the NetmaskGroup.
  29
  30   .. method:: NetmaskGroup:size() -> int
  31
  32     Returns number of netmasks in this NetmaskGroup.