From eb00fa4be6d9753b936ac6b1c7437bb0473b1752 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Magalh=C3=A3es?= Date: Sun, 22 Aug 2021 18:40:25 +0100 Subject: [PATCH] docs: fixed random docs --- src/netius/base/stream.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/netius/base/stream.py b/src/netius/base/stream.py index dbaffd59..48ae3e84 100644 --- a/src/netius/base/stream.py +++ b/src/netius/base/stream.py @@ -41,27 +41,28 @@ OPEN = 1 """ The open status value, meant to be used in situations -where the status of the entity is open (opposite of d) """ +where the status of the entity is open (opposite of closed) """ CLOSED = 2 """ Closed status value to be used in entities which have no pending structured opened and operations are limited """ PENDING = 3 -""" The pending status used for transient states (eg created) +""" The pending status used for transient states (eg: created) connections under this state must be used carefully """ class Stream(observer.Observable): """ Abstract stream class responsible for the representation of a "virtual" connection state for situation where multiplexing - of single connection exists. + of single connection exists (connections within connections) Most of the interface for a stream should be "logically" similar to the one defined by a connection. - This implementation takes inspiration from the asyncio stream and - should be very compatible in terms of API. + A good example of the stream usage is the HTTP2 protocol where + multiple parallel streams co-exist within a single TCP connection + allowing huge performance improvements. """ def __init__(self, owner = None):