[Emacs-diffs] /srv/bzr/emacs/trunk r102808: * dbus.texi (Receiving Method Calls): New function

[Michael Albinus]

------------------------------------------------------------
revno: 102808
committer: Michael Albinus <address@hidden>
branch nick: trunk
timestamp: Mon 2011-01-10 10:35:44 +0100
message:
  * dbus.texi (Receiving Method Calls): New function
  dbus-register-service.  Rearrange node.
modified:
  doc/misc/ChangeLog
  doc/misc/dbus.texi

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2011-01-07 19:49:15 +0000
+++ b/doc/misc/ChangeLog        2011-01-10 09:35:44 +0000
@@ -1,3 +1,8 @@
+2011-01-10  Jan Moringen  <address@hidden>
+
+       * dbus.texi (Receiving Method Calls): New function
+       dbus-register-service.  Rearrange node.
+
 2011-01-07  Paul Eggert  <address@hidden>
 
        * texinfo.tex: Update to version 2010-12-23.17 from gnulib,

=== modified file 'doc/misc/dbus.texi'
--- a/doc/misc/dbus.texi        2011-01-04 12:38:33 +0000
+++ b/doc/misc/dbus.texi        2011-01-10 09:35:44 +0000
@@ -1244,9 +1244,73 @@
 @cindex method calls, returning
 @cindex returning method calls
 
-Emacs can also offer own methods, which can be called by other
-applications.  These methods could be an implementation of an
-interface of a well known service, like @samp{org.freedesktop.TextEditor}.
+In order to register methods on the D-Bus, Emacs has to request a well
+known name on the D-Bus under which it will be available for other
+clients.  Names on the D-Bus can be registered and unregistered using
+the following functions:
+
address@hidden dbus-register-service bus service &rest flags
+Register the known name @var{service} on D-Bus @var{bus}.
+
address@hidden is either the symbol @code{:system} or the symbol
address@hidden:session}.
+
address@hidden is the service name to be registered on the D-Bus.  It
+must be a known name.
+
address@hidden is a subset of the following keywords:
+
address@hidden
address@hidden @code{:allow-replacement}: Allow another service to become the 
primary
+owner if requested.
+
address@hidden @code{:replace-existing}: Request to replace the current primary 
owner.
+
address@hidden @code{:do-not-queue}: If we can not become the primary owner do 
not
+place us in the queue.
address@hidden itemize
+
+One of the following keywords is returned:
+
address@hidden
+
address@hidden @code{:primary-owner}: We have become the primary owner of the 
name
address@hidden
+
address@hidden @code{:in-queue}: We could not become the primary owner and
+have been placed in the queue.
+
address@hidden @code{:exists}: We already are in the queue.
+
address@hidden @code{:already-owner}: We already are the primary
+owner.
address@hidden itemize
address@hidden defun
+
address@hidden dbus-unregister-service bus service
+Unregister all objects from D-Bus @var{bus}, registered by Emacs for
address@hidden
+
address@hidden is either the symbol @code{:system} or the symbol
address@hidden:session}.
+
address@hidden is the D-Bus service name of the D-Bus.  It must be a
+known name.  Emacs releases its association to @var{service} from
+D-Bus.
+
+One of the following keywords is returned:
+
address@hidden
address@hidden @code{:released}: We successfully released the name 
@var{service}.
address@hidden @code{:non-existent}: The name @var{service} does not exist on 
the bus.
address@hidden @code{:not-owner}: We are not an owner of the name @var{service}.
address@hidden itemize
address@hidden defun
+
+When a name has been chosen, Emacs can offer own methods, which can be
+called by other applications.  These methods could be an
+implementation of an interface of a well known service, like
address@hidden
 
 It could be also an implementation of an own interface.  In this case,
 the service name must be @samp{org.gnu.Emacs}.  The object path shall
@@ -1300,7 +1364,7 @@
 @var{service} is not registered.  This means that other D-Bus clients
 have no way of noticing the newly registered method.  When interfaces
 are constructed incrementally by adding single methods or properties
-at a time, @var{dont-register-service} can be use to prevent other
+at a time, @var{dont-register-service} can be used to prevent other
 clients from discovering the still incomplete interface.
 
 The default D-Bus timeout when waiting for a message reply is 25
@@ -1414,7 +1478,7 @@
 @var{service} is not registered.  This means that other D-Bus clients
 have no way of noticing the newly registered method.  When interfaces
 are constructed incrementally by adding single methods or properties
-at a time, @var{dont-register-service} can be use to prevent other
+at a time, @var{dont-register-service} can be used to prevent other
 clients from discovering the still incomplete interface.
 
 @noindent Example:
@@ -1491,18 +1555,6 @@
 to the service from D-Bus.
 @end defun
 
address@hidden dbus-unregister-service bus service
-Unregister all objects from D-Bus @var{bus}, registered by Emacs for
address@hidden
-
address@hidden is either the symbol @code{:system} or the symbol
address@hidden:session}.
-
address@hidden is the D-Bus service name of the D-Bus.  It must be a
-known name.  Emacs releases its association to @var{service} from
-D-Bus.
address@hidden defun
-
 
 @node Signals
 @chapter Sending and receiving signals.