mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
100 lines
2.2 KiB
Python
100 lines
2.2 KiB
Python
from abc import (
|
|
ABC,
|
|
abstractmethod,
|
|
)
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Dict,
|
|
Sequence,
|
|
)
|
|
|
|
from multiaddr import (
|
|
Multiaddr,
|
|
)
|
|
|
|
from libp2p.network.connection.net_connection_interface import (
|
|
INetConn,
|
|
)
|
|
from libp2p.peer.id import (
|
|
ID,
|
|
)
|
|
from libp2p.peer.peerstore_interface import (
|
|
IPeerStore,
|
|
)
|
|
from libp2p.tools.async_service import (
|
|
ServiceAPI,
|
|
)
|
|
from libp2p.transport.listener_interface import (
|
|
IListener,
|
|
)
|
|
from libp2p.typing import (
|
|
StreamHandlerFn,
|
|
)
|
|
|
|
from .stream.net_stream_interface import (
|
|
INetStream,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from .notifee_interface import INotifee # noqa: F401
|
|
|
|
|
|
class INetwork(ABC):
|
|
peerstore: IPeerStore
|
|
connections: Dict[ID, INetConn]
|
|
listeners: Dict[str, IListener]
|
|
|
|
@abstractmethod
|
|
def get_peer_id(self) -> ID:
|
|
"""
|
|
:return: the peer id
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def dial_peer(self, peer_id: ID) -> INetConn:
|
|
"""
|
|
dial_peer try to create a connection to peer_id.
|
|
|
|
:param peer_id: peer if we want to dial
|
|
:raises SwarmException: raised when an error occurs
|
|
:return: muxed connection
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def new_stream(self, peer_id: ID) -> INetStream:
|
|
"""
|
|
:param peer_id: peer_id of destination
|
|
:param protocol_ids: available protocol ids to use for stream
|
|
:return: net stream instance
|
|
"""
|
|
|
|
@abstractmethod
|
|
def set_stream_handler(self, stream_handler: StreamHandlerFn) -> None:
|
|
"""Set the stream handler for all incoming streams."""
|
|
|
|
@abstractmethod
|
|
async def listen(self, *multiaddrs: Sequence[Multiaddr]) -> bool:
|
|
"""
|
|
:param multiaddrs: one or many multiaddrs to start listening on
|
|
:return: True if at least one success
|
|
"""
|
|
|
|
@abstractmethod
|
|
def register_notifee(self, notifee: "INotifee") -> None:
|
|
"""
|
|
:param notifee: object implementing Notifee interface
|
|
:return: true if notifee registered successfully, false otherwise
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def close(self) -> None:
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def close_peer(self, peer_id: ID) -> None:
|
|
pass
|
|
|
|
|
|
class INetworkService(INetwork, ServiceAPI):
|
|
pass
|