py-libp2p/libp2p/transport/transport_interface.py

25 lines
866 B
Python
Raw Normal View History

2018-10-27 04:09:39 +08:00
from abc import ABC, abstractmethod
2018-11-13 02:02:49 +08:00
2018-10-27 04:09:39 +08:00
class ITransport(ABC):
@abstractmethod
def dial(self, multiaddr, self_id, options=None):
2018-10-27 04:09:39 +08:00
"""
dial a transport to peer listening on multiaddr
:param multiaddr: multiaddr of peer
:param self_id: peer_id of the dialer (to send to receiver)
2018-10-27 04:09:39 +08:00
:param options: optional object
:return: list of multiaddrs
"""
@abstractmethod
def create_listener(self, handler_function, options=None):
"""
create listener on transport
:param options: optional object with properties the listener must have
:param handler_function: a function called when a new conntion is received
that takes a connection as argument which implements interface-connection
:return: a listener object that implements listener_interface.py
"""