[pytango] 09/26: Add important message to asynch calls regarding push model usage

[Sandor Bodo-Merle]

This is an automated email from the git hooks/post-receive script.

sbodomerle-guest pushed a commit to annotated tag v8.1.8
in repository pytango.

commit 92e3eca27faefbfc5e63fe0a2d7e22634e083b9e
Author: coutinho <coutinho at esrf.fr>
Date:   Tue Sep 15 15:27:53 2015 +0200

    Add important message to asynch calls regarding push model usage
---
 src/boost/python/connection.py   |  6 ++++++
 src/boost/python/device_proxy.py | 14 +++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/src/boost/python/connection.py b/src/boost/python/connection.py
index 5850b1c..0c7418e 100644
--- a/src/boost/python/connection.py
+++ b/src/boost/python/connection.py
@@ -170,6 +170,12 @@ def __Connection__command_inout_asynch(self, cmd_name, *args):
         Return     : None
 
         Throws     : ConnectionFailed, TypeError, anything thrown by command_query
+
+    .. important::
+        by default, TANGO is initialized with the **polling** model. If you want
+        to use the **push** model (the one with the callback parameter), you
+        need to change the global TANGO model to PUSH_CALLBACK.
+        You can do this with the :meth:`PyTango.ApiUtil.set_asynch_cb_sub_model`
     """
     if len(args) == 0: # command_inout_asynch()
         argin = DeviceData()
diff --git a/src/boost/python/device_proxy.py b/src/boost/python/device_proxy.py
index 19ecf9c..8b8206d 100644
--- a/src/boost/python/device_proxy.py
+++ b/src/boost/python/device_proxy.py
@@ -272,7 +272,7 @@ def __DeviceProxy__read_attributes_asynch(self, attr_names, cb=None, extract_as=
 
     read_attributes_asynch( self, attr_names, callback, extract_as=Numpy) -> None
 
-            Read asynchronously (callback model) an attribute list.
+            Read asynchronously (push model) an attribute list.
 
         Parameters :
                 - attr_names : (sequence<str>) A list of attributes to read. See read_attributes.
@@ -285,6 +285,12 @@ def __DeviceProxy__read_attributes_asynch(self, attr_names, cb=None, extract_as=
         Throws     : ConnectionFailed
 
         New in PyTango 7.0.0
+
+    .. important::
+        by default, TANGO is initialized with the **polling** model. If you want
+        to use the **push** model (the one with the callback parameter), you
+        need to change the global TANGO model to PUSH_CALLBACK.
+        You can do this with the :meth:`PyTango.ApiUtil.set_asynch_cb_sub_model`
     """
     if cb is None:
         return self.__read_attributes_asynch(attr_names)
@@ -347,6 +353,12 @@ def __DeviceProxy__write_attributes_asynch(self, attr_values, cb=None):
         Throws     : ConnectionFailed
 
         New in PyTango 7.0.0
+
+    .. important::
+        by default, TANGO is initialized with the **polling** model. If you want
+        to use the **push** model (the one with the callback parameter), you
+        need to change the global TANGO model to PUSH_CALLBACK.
+        You can do this with the :meth:`PyTango.ApiUtil.set_asynch_cb_sub_model`
     """
     if cb is None:
         return self.__write_attributes_asynch(attr_values)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pytango.git