2018-10-27 04:16:24 +08:00
|
|
|
from abc import ABC, abstractmethod
|
2019-08-05 10:20:30 +08:00
|
|
|
from typing import List
|
2019-08-05 11:22:44 +08:00
|
|
|
|
2019-08-05 10:20:30 +08:00
|
|
|
from multiaddr import Multiaddr
|
2019-08-02 16:32:33 +08:00
|
|
|
|
2018-11-13 02:02:49 +08:00
|
|
|
|
2018-10-27 04:16:24 +08:00
|
|
|
class IListener(ABC):
|
2018-10-27 06:06:56 +08:00
|
|
|
@abstractmethod
|
2019-08-05 10:20:30 +08:00
|
|
|
async def listen(self, maddr: Multiaddr) -> bool:
|
2019-10-25 02:10:45 +08:00
|
|
|
"""
|
|
|
|
put listener in listening mode and wait for incoming connections.
|
2019-10-24 14:41:10 +08:00
|
|
|
|
2019-07-10 19:33:38 +08:00
|
|
|
:param maddr: multiaddr of peer
|
2018-10-27 04:16:24 +08:00
|
|
|
:return: return True if successful
|
|
|
|
"""
|
|
|
|
|
|
|
|
@abstractmethod
|
2019-08-05 10:20:30 +08:00
|
|
|
def get_addrs(self) -> List[Multiaddr]:
|
2019-10-25 02:10:45 +08:00
|
|
|
"""
|
|
|
|
retrieve list of addresses the listener is listening on.
|
2019-10-24 14:41:10 +08:00
|
|
|
|
2018-10-27 04:16:24 +08:00
|
|
|
:return: return list of addrs
|
|
|
|
"""
|
|
|
|
|
|
|
|
@abstractmethod
|
2019-08-29 21:38:06 +08:00
|
|
|
async def close(self) -> None:
|
2019-10-24 14:41:10 +08:00
|
|
|
"""close the listener such that no more connections can be open on this
|
|
|
|
transport instance."""
|