3.0.ipv8.REST.dht_endpoint
==========================

.. py:module:: 3.0.ipv8.REST.dht_endpoint


Classes
-------

.. autoapisummary::

   3.0.ipv8.REST.dht_endpoint.DHTEndpoint


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

.. py:class:: DHTEndpoint

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


   This endpoint is responsible for handling requests for DHT data.


   .. py:attribute:: dht
      :type:  3.0.ipv8.dht.community.DHTCommunity | None
      :value: None



   .. py:attribute:: publisher
      :value: None



   .. 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_statistics(_: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Return DHT statistics.



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


      Connect to a peer using the DHT.



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


      Get a list of locally stored key-value pairs from the DHT.



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


      Lookup the values for a specific key on the DHT.



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


      Store a key-value pair on the DHT.



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


      Return a list of all buckets in the routing table of the DHT community.



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


      Prefix of the bucket which to refresh.