py-libp2p/libp2p/network/network_interface.py

73 lines
2.1 KiB
Python
Raw Normal View History

2019-08-01 06:00:12 +08:00
from abc import ABC, abstractmethod
2019-08-08 14:22:06 +08:00
from typing import TYPE_CHECKING, Dict, Sequence
2019-07-28 14:06:29 +08:00
from multiaddr import Multiaddr
2019-07-28 22:30:51 +08:00
from libp2p.peer.id import ID
from libp2p.peer.peerstore_interface import IPeerStore
from libp2p.stream_muxer.abc import IMuxedConn
2019-07-30 15:31:02 +08:00
from libp2p.transport.listener_interface import IListener
from libp2p.typing import StreamHandlerFn, TProtocol
2019-07-28 22:30:51 +08:00
2019-07-30 15:31:02 +08:00
from .stream.net_stream_interface import INetStream
2018-10-15 01:47:06 +08:00
2019-07-29 12:42:13 +08:00
if TYPE_CHECKING:
2019-08-08 14:22:06 +08:00
from .notifee_interface import INotifee # noqa: F401
2019-07-29 12:42:13 +08:00
2018-10-15 13:52:25 +08:00
class INetwork(ABC):
2018-10-15 01:47:06 +08:00
peerstore: IPeerStore
2019-07-30 15:31:02 +08:00
connections: Dict[ID, IMuxedConn]
listeners: Dict[str, IListener]
2018-11-19 00:22:56 +08:00
@abstractmethod
2019-07-28 14:06:29 +08:00
def get_peer_id(self) -> ID:
2018-11-19 00:22:56 +08:00
"""
:return: the peer id
"""
@abstractmethod
2019-07-30 15:31:02 +08:00
async def dial_peer(self, peer_id: ID) -> IMuxedConn:
"""
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
"""
2018-10-15 13:52:25 +08:00
@abstractmethod
def set_stream_handler(
self, protocol_id: TProtocol, stream_handler: StreamHandlerFn
) -> bool:
2018-10-15 13:52:25 +08:00
"""
2018-11-12 09:29:17 +08:00
:param protocol_id: protocol id used on stream
2018-10-15 13:52:25 +08:00
:param stream_handler: a stream handler instance
:return: true if successful
"""
2018-10-15 01:47:06 +08:00
2018-10-15 13:52:25 +08:00
@abstractmethod
async def new_stream(
self, peer_id: ID, protocol_ids: Sequence[TProtocol]
) -> INetStream:
2018-10-15 13:52:25 +08:00
"""
:param peer_id: peer_id of destination
:param protocol_ids: available protocol ids to use for stream
:return: net stream instance
2018-10-15 13:52:25 +08:00
"""
2018-10-22 01:44:39 +08:00
@abstractmethod
2019-08-02 15:06:39 +08:00
async def listen(self, *multiaddrs: Sequence[Multiaddr]) -> bool:
2018-10-22 01:44:39 +08:00
"""
:param multiaddrs: one or many multiaddrs to start listening on
2018-10-27 04:16:24 +08:00
:return: True if at least one success
2018-10-22 01:44:39 +08:00
"""
@abstractmethod
2019-08-01 06:00:12 +08:00
def notify(self, notifee: "INotifee") -> bool:
"""
:param notifee: object implementing Notifee interface
2019-03-15 02:01:37 +08:00
:return: true if notifee registered successfully, false otherwise
"""