3.0.ipv8.REST.overlays_endpoint

Classes

Module Contents

class 3.0.ipv8.REST.overlays_endpoint.OverlaysEndpoint

Bases: 3.0.ipv8.REST.base_endpoint.BaseEndpoint[3.0.ipv8.types.IPv8]

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

statistics_supported: bool = False

setup_routes() → None

Register the names to make this endpoint callable.

initialize(session: 3.0.ipv8.types.IPv8) → None

Initialize this endpoint for the given session instance.

async get_overlays(_: aiohttp.abc.Request) → 3.0.ipv8.REST.base_endpoint.Response

Return information about all currently loaded overlays.

async get_statistics(_: aiohttp.abc.Request) → 3.0.ipv8.REST.base_endpoint.Response

Return statistics for all currently loaded overlays.

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.

async enable_statistics(request: aiohttp.abc.Request) → 3.0.ipv8.REST.base_endpoint.Response

Enable/disable statistics for a given overlay.

enable_overlay_statistics(enable: bool = False, class_name: str | None = None, all_overlays: bool = False) → None

Enable statistics for the specified overlays.