py-libp2p/libp2p/pubsub/pubsub_notifee.py

from typing import TYPE_CHECKING

from multiaddr import Multiaddr

from libp2p.network.network_interface import INetwork
from libp2p.network.notifee_interface import INotifee
from libp2p.network.stream.net_stream_interface import INetStream
from libp2p.stream_muxer.abc import IMuxedConn

if TYPE_CHECKING:
    import asyncio  # noqa: F401
    from libp2p.peer.id import ID  # noqa: F401


class PubsubNotifee(INotifee):

    initiator_peers_queue: "asyncio.Queue[ID]"

    def __init__(self, initiator_peers_queue: "asyncio.Queue[ID]") -> None:
        """
        :param initiator_peers_queue: queue to add new peers to so that pubsub
        can process new peers after we connect to them
        """
        self.initiator_peers_queue = initiator_peers_queue

    async def opened_stream(self, network: INetwork, stream: INetStream) -> None:
        pass

    async def closed_stream(self, network: INetwork, stream: INetStream) -> None:
        pass

    async def connected(self, network: INetwork, conn: IMuxedConn) -> None:
        """
        Add peer_id to initiator_peers_queue, so that this peer_id can be used to
        create a stream and we only want to have one pubsub stream with each peer.
        :param network: network the connection was opened on
        :param conn: connection that was opened
        """

        # Only add peer_id if we are initiator (otherwise we would end up
        # with two pubsub streams between us and the peer)
        if conn.initiator:
            await self.initiator_peers_queue.put(conn.peer_id)

    async def disconnected(self, network: INetwork, conn: IMuxedConn) -> None:
        pass

    async def listen(self, network: INetwork, multiaddr: Multiaddr) -> None:
        pass

    async def listen_close(self, network: INetwork, multiaddr: Multiaddr) -> None:
        pass