Skip to content

Commit c8d5c6b

Browse files
committed
Improve comments
1 parent 7ed0901 commit c8d5c6b

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

unpythonic/net/msg.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"""A simplistic message protocol.
33
44
This adds rudimentary message framing and stream re-synchronization on top of a
5-
stream-based transport layer, such as TCP. This is a sans-IO implementation.
5+
stream-based transport layer, such as TCP. This is a pure sans-IO implementation.
66
77
The decoder uses a receive buffer to decode or receive messages. This is used
88
as a staging area for incoming data, since the decoder must hold on to data
@@ -39,10 +39,14 @@
3939
https://sans-io.readthedocs.io/
4040
"""
4141

42-
__all__ = ["encodemsg",
43-
"ReceiveBuffer",
42+
__all__ = [ # To send, you'll need:
43+
"encodemsg",
44+
# To receive, you'll need at least one of:
4445
"socketsource", "streamsource", "bytessource",
45-
"decodemsg"]
46+
# and either:
47+
"MessageDecoder",
48+
# or:
49+
"ReceiveBuffer", "decodemsg"]
4650

4751
import select
4852
import socket

0 commit comments

Comments
 (0)