changeset 93422:d2f671c73132

* dbus.texi (Synchronous Methods): New parameter TIMEOUT for dbus-call-method. (Receiving Method Calls): The timeout can be set by the calling client.
author Michael Albinus <michael.albinus@gmx.de>
date Sun, 30 Mar 2008 12:52:00 +0000
parents ef82dfe47b36
children 23f00a60178d
files doc/misc/dbus.texi
diffstat 1 files changed, 9 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/misc/dbus.texi	Sun Mar 30 12:38:49 2008 +0000
+++ b/doc/misc/dbus.texi	Sun Mar 30 12:52:00 2008 +0000
@@ -425,7 +425,7 @@
 be called, and a reply message returning the resulting output
 parameters from the object.
 
-@defun dbus-call-method bus service path interface method &rest args
+@defun dbus-call-method bus service path interface method &optional :timeout timeout &rest args
 This function calls @var{method} on the D-Bus @var{bus}.  @var{bus} is
 either the symbol @code{:system} or the symbol @code{:session}.
 
@@ -433,6 +433,12 @@
 D-Bus object path, @var{service} is registered at.  @var{interface} is
 an interface offered by @var{service}.  It must provide @var{method}.
 
+If the parameter @code{:timeout} is given, the following integer
+@var{timeout} specifies the maximun number of milliseconds the method
+call must return.  The default value is 25.000.  If the method call
+doesn't return in time, a D-Bus error is raised (@pxref{Errors and
+Events}).
+
 All other arguments args are passed to @var{method} as arguments.
 They are converted into D-Bus types as described in @ref{Type
 Conversion}.
@@ -546,7 +552,8 @@
 can be composed like the input parameters in @ref{Type Conversion}.
 
 The default D-Bus timeout when waiting for a message reply is 25
-seconds.  Therefore, @var{handler} shall not last longer than
+seconds.  This value could be even smaller, depending on the calling
+client.  Therefore, @var{handler} shall not last longer than
 absolutely necessary.
 
 @code{dbus-register-method} returns a Lisp symbol, which can be used