py-libp2p/libp2p/stream_muxer/muxed_stream_interface.py
2019-07-30 17:31:08 +08:00

52 lines
985 B
Python

from abc import (
ABC,
abstractmethod,
)
from typing import (
TYPE_CHECKING,
)
if TYPE_CHECKING:
from libp2p.stream_muxer.mplex.mplex import Mplex
class IMuxedStream(ABC):
mplex_conn: 'Mplex'
@abstractmethod
def read(self):
"""
reads from the underlying muxed_conn
:return: bytes of input
"""
@abstractmethod
def write(self, _bytes):
"""
writes to the underlying muxed_conn
:return: number of bytes written
"""
@abstractmethod
def close(self):
"""
close the underlying muxed_conn
:return: true if successful
"""
@abstractmethod
def reset(self):
"""
closes both ends of the stream
tells this remote side to hang up
:return: error/exception
"""
@abstractmethod
def set_deadline(self, ttl):
"""
set deadline for muxed stream
:return: a new stream
"""