aboutsummaryrefslogtreecommitdiffstats
path: root/libmproxy/protocol/base.py
diff options
context:
space:
mode:
Diffstat (limited to 'libmproxy/protocol/base.py')
-rw-r--r--libmproxy/protocol/base.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/libmproxy/protocol/base.py b/libmproxy/protocol/base.py
index d984cadb..4eb034c0 100644
--- a/libmproxy/protocol/base.py
+++ b/libmproxy/protocol/base.py
@@ -3,13 +3,13 @@ import sys
import six
-from netlib import tcp
from ..models import ServerConnection
from ..exceptions import ProtocolException
from netlib.exceptions import TcpException
class _LayerCodeCompletion(object):
+
"""
Dummy class that provides type hinting in PyCharm, which simplifies development a lot.
"""
@@ -31,6 +31,7 @@ class _LayerCodeCompletion(object):
class Layer(_LayerCodeCompletion):
+
"""
Base class for all layers. All other protocol layers should inherit from this class.
"""
@@ -91,6 +92,7 @@ class Layer(_LayerCodeCompletion):
class ServerConnectionMixin(object):
+
"""
Mixin that provides a layer with the capabilities to manage a server connection.
The server address can be passed in the constructor or set by calling :py:meth:`set_server`.
@@ -190,6 +192,7 @@ class ServerConnectionMixin(object):
class Kill(Exception):
+
"""
Signal that both client and server connection(s) should be killed immediately.
"""