3.0.ipv8.REST.tunnel_endpoint
=============================

.. py:module:: 3.0.ipv8.REST.tunnel_endpoint


Attributes
----------

.. autoapisummary::

   3.0.ipv8.REST.tunnel_endpoint.SpeedTestResponseSchema


Classes
-------

.. autoapisummary::

   3.0.ipv8.REST.tunnel_endpoint.TunnelEndpoint


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

.. py:data:: SpeedTestResponseSchema

.. py:class:: TunnelEndpoint

   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:: tunnels
      :type:  3.0.ipv8.messaging.anonymization.community.TunnelCommunity | None
      :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_settings(_: aiohttp.abc.Request) -> 3.0.ipv8.REST.base_endpoint.Response

      Return a dictionary of all tunnel settings.



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


      Return a list of all current circuits.



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


      Test the upload or download speed of a circuit.



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


      Test the upload or download speed of a newly created circuit.
      The circuit is destroyed after the test has completed.



   .. py:method:: run_speed_test(circuit: 3.0.ipv8.messaging.anonymization.tunnel.Circuit, params: dict) -> 3.0.ipv8.REST.base_endpoint.Response
      :async:


      Run a speed test on the given circuit and form an HTTP response.



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


      Return a list of all current relays.



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


      Return a list of all current exits.



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


      Return a list of all current hidden swarms.



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


      Estimate the hidden swarm size for a given infohash.



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


      Return a list of all peers currently part of the tunnel community.



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


      Return a list of all hidden services peers that are in the local DHT store.



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


      Return a list of all hidden services peers that are in the local PEX store.