ComboAddress
============
-IP addresses are moved around in a native format, called a ComboAddress.
+IP addresses are moved around in a native format, called a :class:`ComboAddress`.
ComboAddresses can be IPv4 or IPv6, and unless you want to know, you don't need to.
-.. function:: newCA(address) -> :class:`ComboAddress`
+.. function:: newCA(address) -> ComboAddress
Returns a :class:`ComboAddress` based on ``address``
.. method:: ComboAddress:mapToIPv4() -> ComboAddress
Convert an IPv4 address mapped in a v6 one into an IPv4.
- Returns a new ComboAddress
+ Returns a new :class:`ComboAddress`
.. method:: ComboAddress:tostring() -> string
ComboAddress:toString() -> string
.. method:: ComboAddress:truncate(bits)
- Truncate the ComboAddress to the specified number of bits.
+ Truncate the :class:`ComboAddress` to the specified number of bits.
This essentially zeroes all bits after ``bits``.
:param int bits: Amount of bits to truncate to
Adds the name to the set.
- :param DNSName name The name to add.
+ :param DNSName name: The name to add.
.. method:: DNSNameSet:empty() -> bool
.. method:: DNSNameSet:toString() -> string
- Returns a human-readable form of the DNSName.
+ Returns a human-readable form of the DNSNameSet.
.. method:: DNSNameSet:size() -> int
Removes the name from the set. Returns the number of deleted elements.
- :param DNSName name The name to remove.
+ :param DNSName name: The name to remove.
.. method:: DNSNameSet:check(name) -> bool
Returns true if the set contains the name.
- :param DNSname name The name.
+ :param DNSName name: The name to check.
the :func:`KeyValueStoreLookupAction` action, using the usual selectors to match the incoming
queries for which the lookup should be done.
-The first step is to get a :ref:`KeyValueStore` object via one of the following functions:
+The first step is to get a :class:`KeyValueStore` object via one of the following functions:
* :func:`newCDBKVStore` for a CDB database ;
* :func:`newLMDBKVStore` for a LMDB one.