3.0.ipv8.REST.overlays_endpoint
===============================

.. py:module:: 3.0.ipv8.REST.overlays_endpoint


Classes
-------

.. autoapisummary::

   3.0.ipv8.REST.overlays_endpoint.OverlaysEndpoint


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

.. py:class:: OverlaysEndpoint

   Bases: :py:obj:`3.0.ipv8.REST.base_endpoint.BaseEndpoint`\ [\ :py:obj:`3.0.ipv8.types.IPv8`\ ]


   This endpoint is responsible for handing all requests regarding the status of overlays.


   .. py:attribute:: statistics_supported
      :type:  bool
      :value: False



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

      Register the names to make this endpoint callable.



   .. py:method:: initialize(session: 3.0.ipv8.types.IPv8) -> None

      Initialize this endpoint for the given session instance.



   .. py:method:: get_overlays(_: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Return information about all currently loaded overlays.



   .. py:method:: get_statistics(_: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Return statistics for all currently loaded overlays.



   .. py:method:: statistics_by_name(statistics: dict[int, 3.0.ipv8.messaging.interfaces.network_stats.NetworkStat], overlay: 3.0.ipv8.types.Community) -> dict[str, dict[str, int | float]]

      Convert the captured statistics to a human-readable dict.



   .. py:method:: enable_statistics(request: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Enable/disable statistics for a given overlay.



   .. py:method:: enable_overlay_statistics(enable: bool = False, class_name: str | None = None, all_overlays: bool = False) -> None

      Enable statistics for the specified overlays.