Merge pull request #85 from gramaziokohler/set_rosapi_timeout

added set_rosapi_timeout

Author: gonzalocasas

CHANGELOG.rst

@@ -12,6 +12,8 @@ Unreleased
 
 **Added**
 
+* Added function to set the default timeout value.
+
 **Changed**
 
 **Fixed**
@@ -29,7 +31,7 @@ Unreleased
 
 **Fixed**
 
-* Fixed blocking issues on the Twisted/Autobahn-based implementation of websockets
+* Fixed blocking issues on the Twisted/Autobahn-based implementation of websockets.
 
 **Deprecated**
 
@@ -61,24 +63,24 @@ Unreleased
 
 **Changed**
 
-* Changed behavior: Topics automatically reconnect when websockets is reconnected
+* Changed behavior: Topics automatically reconnect when websockets is reconnected.
 
 **Added**
 
 * Added blocking behavior to more ROS API methods: ``ros.get_nodes`` and ``ros.get_node_details``.
-* Added reconnection support to IronPython implementation of websockets
-* Added automatic topic reconnection support for both subscribers and publishers
+* Added reconnection support to IronPython implementation of websockets.
+* Added automatic topic reconnection support for both subscribers and publishers.
 
 **Fixed**
 
-* Fixed reconnection issues on the Twisted/Autobahn-based implementation of websockets
+* Fixed reconnection issues on the Twisted/Autobahn-based implementation of websockets.
 
 0.7.1
 ----------
 
 **Fixed**
 
-* Fixed blocking service calls for Mac OS
+* Fixed blocking service calls for Mac OS.
 
 0.7.0
 ----------
@@ -141,7 +143,7 @@ Unreleased
 
 **Added**
 
-* Add a non-blocking event loop runner
+* Add a non-blocking event loop runner.
 
 0.3.0
 ----------
@@ -155,33 +157,33 @@ Unreleased
 
 **Fixed**
 
-* Fix JSON serialization error on TF Client (on Python 3.x)
+* Fix JSON serialization error on TF Client (on Python 3.x).
 
 0.2.0
 ----------
 
 **Added**
 
-* Add support for IronPython 2.7
+* Add support for IronPython 2.7.
 
 **Changed**
 
-* Handler ``on_ready`` now defaults to run the callback in thread
+* Handler ``on_ready`` now defaults to run the callback in thread.
 
 **Deprecated**
 
-* Rename ``run_event_loop`` to the more fitting ``run_forever``
+* Rename ``run_event_loop`` to the more fitting ``run_forever``.
 
 0.1.1
 ----------
 
 **Fixed**
 
-* Minimal documentation fixes
+* Minimal documentation fixes.
 
 0.1.0
 ----------
 
 **Added**
 
-* Initial version
+* Initial version.

src/roslibpy/__init__.py

@@ -36,6 +36,7 @@
 
 .. autoclass:: Ros
    :members:
+.. autofunction:: set_rosapi_timeout
 
 Main ROS concepts
 =================
@@ -106,6 +107,7 @@ class and are passed around via :class:`Topics <Topic>` using a **publish/subscr
 from .core import Time
 from .core import Topic
 from .ros import Ros
+from .ros import set_rosapi_timeout
 
-__all__ = ['Ros', 'Message', 'Header', 'Time', 'Param', 'Service', 'ServiceRequest', 'ServiceResponse', 'Topic', '__author__',
+__all__ = ['Ros', 'set_rosapi_timeout', 'Message', 'Header', 'Time', 'Param', 'Service', 'ServiceRequest', 'ServiceResponse', 'Topic',
            '__author__', '__author_email__', '__copyright__', '__description__', '__license__', '__title__', '__url__', '__version__']

src/roslibpy/comm/comm_autobahn.py

@@ -206,7 +206,7 @@ def blocking_call_from_thread(self, callback, timeout):
 
         Args:
             callback: Callable function to be invoked from the thread.
-            timeout (:obj: int): Number of seconds to wait for the response before
+            timeout (:obj:`int`): Number of seconds to wait for the response before
                 raising an exception.
 
         Returns:
@@ -233,7 +233,7 @@ def get_inner_callback(self, result_placeholder):
         """Get the callback which, when called, provides result_placeholder with the result.
 
         Args:
-            result_placeholder: (:obj: Deferred): Object in which to store the result.
+            result_placeholder: (:class:`Deferred`): Object in which to store the result.
 
         Returns:
             A callable which provides result_placeholder with the result in the case of success.
@@ -246,7 +246,7 @@ def get_inner_errback(self, result_placeholder):
         """Get the errback which, when called, provides result_placeholder with the error.
 
         Args:
-            result_placeholder: (:obj: Deferred): Object in which to store the result.
+            result_placeholder: (:class:`Deferred`): Object in which to store the result.
 
         Returns:
             A callable which provides result_placeholder with the error in the case of failure.

src/roslibpy/comm/comm_cli.py

@@ -456,7 +456,7 @@ def blocking_call_from_thread(self, callback, timeout):
 
         Args:
             callback: Callable function to be invoked from the thread.
-            timeout (:obj: int): Number of seconds to wait for the response before
+            timeout (:obj:`int`): Number of seconds to wait for the response before
                 raising an exception.
 
         Returns:
@@ -493,7 +493,7 @@ def get_inner_callback(self, result_placeholder):
         """Get the callback which, when called, provides result_placeholder with the result.
 
         Args:
-            result_placeholder: (:obj: dict): Object in which to store the result.
+            result_placeholder: (:obj:`dict`): Object in which to store the result.
 
         Returns:
             A callable which provides result_placeholder with the result in the case of success.
@@ -507,7 +507,7 @@ def get_inner_errback(self, result_placeholder):
         """Get the errback which, when called, provides result_placeholder with the error.
 
         Args:
-            result_placeholder: (:obj: dict): Object in which to store the result.
+            result_placeholder: (:obj:`dict`): Object in which to store the result.
 
         Returns:
             A callable which provides result_placeholder with the error in the case of failure.

src/roslibpy/ros.py

@@ -10,13 +10,24 @@
 from . import Time
 from .comm import RosBridgeClientFactory
 
-__all__ = ['Ros']
+__all__ = ['Ros', 'set_rosapi_timeout']
 
 LOGGER = logging.getLogger('roslibpy')
 CONNECTION_TIMEOUT = 10
 ROSAPI_TIMEOUT = 3
 
 
+def set_rosapi_timeout(timeout):
+    """Set the default number of seconds to wait for a response before
+    raising an exception.
+
+    Args:
+         timeout (:obj:`int`): Duration in seconds.
+    """
+    global ROSAPI_TIMEOUT
+    ROSAPI_TIMEOUT = timeout
+
+
 class Ros(object):
     """Connection manager to ROS server.
 
@@ -194,7 +205,7 @@ def blocking_call_from_thread(self, callback, timeout):
 
         Args:
             callback: Callable function to be invoked from the thread.
-            timeout (:obj: int): Number of seconds to wait for the response before
+            timeout (:obj:`int`): Number of seconds to wait for the response before
                 raising an exception.
 
         Returns:
@@ -231,7 +242,7 @@ def call_sync_service(self, message, timeout):
 
         Args:
             message (:class:`.Message`): ROS Bridge Message containing the request.
-            timeout (:obj: int): Number of seconds to wait for the response before
+            timeout (:obj:`int`): Number of seconds to wait for the response before
                 raising an exception.
         Returns:
             Either returns the service request results or raises a timeout exception.