Skip to content

Commit

Permalink
docs: fixed random docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joamag committed Aug 22, 2021
1 parent 2568f6c commit eb00fa4
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/netius/base/stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down

0 comments on commit eb00fa4

Please sign in to comment.