varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-12 16:10:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enforce pre-summary newline in docstrings

Browse Source
This commit is contained in:
Dominik Muhs
2019-10-24 20:10:45 +02:00
parent 87ed98d7af
commit bafdd8512d
52 changed files with 349 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
libp2p/stream_muxer/abc.py
View File

@ -14,7 +14,8 @@ class IMuxedConn(ABC):
@abstractmethod
def __init__(self, conn: ISecureConn, peer_id: ID) -> None:
"""create a new muxed connection.
"""
create a new muxed connection.
:param conn: an instance of secured connection
for new muxed streams
@ -32,14 +33,16 @@ class IMuxedConn(ABC):
@abstractmethod
def is_closed(self) -> bool:
"""check connection is fully closed.
"""
check connection is fully closed.
:return: true if successful
"""
@abstractmethod
async def open_stream(self) -> "IMuxedStream":
"""creates a new muxed_stream.
"""
creates a new muxed_stream.
:return: a new ``IMuxedStream`` stream
"""
@ -59,7 +62,8 @@ class IMuxedStream(ReadWriteCloser):
@abstractmethod
def set_deadline(self, ttl: int) -> bool:
"""set deadline for muxed stream.
"""
set deadline for muxed stream.
:return: a new stream
"""