3.0.ipv8.messaging.interfaces.lan_addresses.addressprovider
===========================================================

.. py:module:: 3.0.ipv8.messaging.interfaces.lan_addresses.addressprovider


Classes
-------

.. autoapisummary::

   3.0.ipv8.messaging.interfaces.lan_addresses.addressprovider.AddressProvider


Module Contents
---------------

.. py:class:: AddressProvider(verbose: bool = False)

   Bases: :py:obj:`abc.ABC`


   Interface for OS-specific methods of finding local interfaces addresses.


   .. py:attribute:: verbose


   .. py:attribute:: addresses
      :type:  set[str]


   .. py:attribute:: addresses_ts
      :value: 0.0



   .. py:method:: on_exception() -> None

      Called by provider implementations that encounter an ``Exception``.



   .. py:method:: discover_addresses(min_interval: float = 10.0) -> None

      Discovers the LAN addresses using this provider. The addresses are only discovered if
      the previous call was more than ``min_interval`` seconds ago. The most recent results
      can be retrieved through ``get_addresses_buffered()``.

      :param min_interval: Minimum time in seconds between discoveries.



   .. py:method:: get_addresses() -> set[str]
      :abstractmethod:


      Get a set of LAN addresses using this provider.



   .. py:method:: get_addresses_buffered() -> set[str]

      Return the known addresses from when ``discover_addresses()`` was last successfully called.
      If discovery hasn't been performed yet, do so now.