Define a channel interface

bombela · bombela · commit e62a705d464d · 2014-09-10T01:51:36.000-07:00
We are in python so it's merely a way to document the code.

 - requires a channel to accept timeouts on operations directly
 - expose few useful properties
diff --git a/zerorpc/channel_base.py b/zerorpc/channel_base.py
@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Open Source Initiative OSI - The MIT License (MIT):Licensing
+#
+# The MIT License (MIT)
+# Copyright (c) 2014 François-Xavier Bourlet (bombela@gmail.com)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+class ChannelBase(object):
+
+    @property
+    def context(self):
+        raise NotImplementedError()
+
+    @property
+    def recv_is_supported(self):
+        raise NotImplementedError()
+
+    @property
+    def emit_is_supported(self):
+        raise NotImplementedError()
+
+    def close(self):
+        raise NotImplementedError()
+
+    def new_event(self, name, args, xheader=None):
+        raise NotImplementedError()
+
+    def emit_event(self, event, timeout=None):
+        raise NotImplementedError()
+
+    def emit(self, name, args, xheader=None, timeout=None):
+        event = self.new_event(name, args, xheader)
+        return self.emit_event(event, timeout)
+
+    def recv(self, timeout=None):
+        raise NotImplementedError()
