Filled IListener documentation

This commit is contained in:
aratz-lasa 2020-02-27 16:40:34 +01:00
parent b53675e288
commit dbe0df2200
2 changed files with 4 additions and 2 deletions

View File

@ -11,7 +11,8 @@ class IListener(ABC):
self, maddr: Multiaddr, task_status: Any = trio.TASK_STATUS_IGNORED
) -> bool:
"""
put listener in listening mode and wait for incoming connections.
put listener in listening mode and wait for incoming connections. It
blocks until it stops to listen.
:param maddr: multiaddr of peer
:return: return True if successful

View File

@ -27,7 +27,8 @@ class TCPListener(IListener):
self, maddr: Multiaddr, task_status: TaskStatus[Any] = trio.TASK_STATUS_IGNORED
) -> None:
"""
put listener in listening mode and wait for incoming connections.
put listener in listening mode and wait for incoming connections. It
blocks until it stops to listen.
:param maddr: maddr of peer
:return: return True if successful