py-libp2p/libp2p/network/connection/swarm_connection.py

import asyncio
from typing import TYPE_CHECKING, Any, Awaitable, List, Set, Tuple

from libp2p.network.connection.net_connection_interface import INetConn
from libp2p.network.stream.net_stream import NetStream
from libp2p.stream_muxer.abc import IMuxedConn, IMuxedStream
from libp2p.stream_muxer.exceptions import MuxedConnUnavailable

if TYPE_CHECKING:
    from libp2p.network.swarm import Swarm  # noqa: F401


"""
Reference: https://github.com/libp2p/go-libp2p-swarm/blob/04c86bbdafd390651cb2ee14e334f7caeedad722/swarm_conn.go  # noqa: E501
"""


class SwarmConn(INetConn):
    conn: IMuxedConn
    swarm: "Swarm"
    streams: Set[NetStream]
    event_closed: asyncio.Event

    _tasks: List["asyncio.Future[Any]"]

    def __init__(self, conn: IMuxedConn, swarm: "Swarm") -> None:
        self.conn = conn
        self.swarm = swarm
        self.streams = set()
        self.event_closed = asyncio.Event()

        self._tasks = []

    async def close(self) -> None:
        if self.event_closed.is_set():
            return
        self.event_closed.set()
        self.swarm.remove_conn(self)

        await self.conn.close()

        # This is just for cleaning up state. The connection has already been closed.
        # We *could* optimize this but it really isn't worth it.
        for stream in self.streams:
            await stream.reset()
        # Schedule `self._notify_disconnected` to make it execute after `close` is finished.
        asyncio.ensure_future(self._notify_disconnected())

        for task in self._tasks:
            task.cancel()

    async def _handle_new_streams(self) -> None:
        # TODO: Break the loop when anything wrong in the connection.
        while True:
            try:
                stream = await self.conn.accept_stream()
            except MuxedConnUnavailable:
                break
            # Asynchronously handle the accepted stream, to avoid blocking the next stream.
            await self.run_task(self._handle_muxed_stream(stream))

        await self.close()

    async def _handle_muxed_stream(self, muxed_stream: IMuxedStream) -> None:
        net_stream = await self._add_stream(muxed_stream)
        if self.swarm.common_stream_handler is not None:
            await self.run_task(self.swarm.common_stream_handler(net_stream))

    async def _add_stream(self, muxed_stream: IMuxedStream) -> NetStream:
        net_stream = NetStream(muxed_stream)
        self.streams.add(net_stream)
        # Call notifiers since event occurred
        for notifee in self.swarm.notifees:
            await notifee.opened_stream(self.swarm, net_stream)
        return net_stream

    async def _notify_disconnected(self) -> None:
        for notifee in self.swarm.notifees:
            await notifee.disconnected(self.swarm, self.conn)

    async def start(self) -> None:
        await self.run_task(self._handle_new_streams())

    async def run_task(self, coro: Awaitable[Any]) -> None:
        self._tasks.append(asyncio.ensure_future(coro))

    async def new_stream(self) -> NetStream:
        muxed_stream = await self.conn.open_stream()
        return await self._add_stream(muxed_stream)

    async def get_streams(self) -> Tuple[NetStream, ...]:
        return tuple(self.streams)