Mercurial > emacs
annotate doc/misc/dbus.texi @ 104078:2658bfb08516
Better docstring for `called-interactively-p'.
author | Bastien Guerry <bzg@altern.org> |
---|---|
date | Mon, 27 Jul 2009 02:02:49 +0000 |
parents | cbbd2a335c8c |
children | 5baa98667482 |
rev | line source |
---|---|
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1 \input texinfo @c -*-texinfo-*- |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
2 @setfilename ../../info/dbus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
3 @c %**start of header |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
4 @settitle Using of D-Bus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
5 @c @setchapternewpage odd |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
6 @c %**end of header |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
7 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
8 @copying |
100974 | 9 Copyright @copyright{} 2007, 2008, 2009 Free Software Foundation, Inc. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
10 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
11 @quotation |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
12 Permission is granted to copy, distribute and/or modify this document |
99709
6de181810d0f
Relicense all texi files under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents:
97253
diff
changeset
|
13 under the terms of the GNU Free Documentation License, Version 1.3 or |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
14 any later version published by the Free Software Foundation; with no |
95937
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
15 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', |
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
16 and with the Back-Cover Texts as in (a) below. A copy of the license |
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
17 is included in the section entitled ``GNU Free Documentation License''. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
18 |
95874
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
93422
diff
changeset
|
19 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
93422
diff
changeset
|
20 modify this GNU manual. Buying copies from the FSF supports it in |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
93422
diff
changeset
|
21 developing GNU and promoting software freedom.'' |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
22 @end quotation |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
23 @end copying |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
24 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
25 @dircategory Emacs |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
26 @direntry |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
27 * D-Bus: (dbus). Using D-Bus in Emacs. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
28 @end direntry |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
29 |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
101617
diff
changeset
|
30 @contents |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
31 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
32 @node Top, Overview, (dir), (dir) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
33 @top D-Bus integration in Emacs |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
34 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
35 This manual documents an API for usage of D-Bus in |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
36 Emacs.@footnote{D-Bus is not enabled by default. You must run |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
37 @command{./configure --with-dbus} in Emacs' top level directory, |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
38 before you compile Emacs.} D-Bus is a message bus system, a simple |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
39 way for applications to talk to one another. An overview of D-Bus can |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
40 be found at @uref{http://dbus.freedesktop.org/}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
41 |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
101617
diff
changeset
|
42 @ifnottex |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
43 @insertcopying |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
101617
diff
changeset
|
44 @end ifnottex |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
45 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
46 @menu |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
47 * Overview:: An overview of D-Bus. |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
48 * Inspection:: Inspection of D-Bus services. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
49 * Type Conversion:: Mapping Lisp types and D-Bus types. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
50 * Synchronous Methods:: Calling methods in a blocking way. |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
51 * Asynchronous Methods:: Calling methods non-blocking. |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
52 * Receiving Method Calls:: Offering own methods. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
53 * Signals:: Sending and receiving signals. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
54 * Errors and Events:: Errors and events. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
55 * GNU Free Documentation License:: The license for this documentation. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
56 @end menu |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
57 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
58 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
59 @node Overview |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
60 @chapter An overview of D-Bus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
61 @cindex overview |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
62 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
63 D-Bus is an inter-process communication mechanism for applications |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
64 residing on the same host. The communication is based on |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
65 @dfn{messages}. Data in the messages is carried in a structured way, |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
66 it is not just a byte stream. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
67 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
68 The communication is connection oriented to two kinds of message |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
69 buses: a so called @dfn{system bus}, and a @dfn{session bus}. On a |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
70 given machine, there is always one single system bus for miscellaneous |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
71 system-wide communication, like changing of hardware configuration. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
72 On the other hand, the session bus is always related to a single |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
73 user's session. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
74 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
75 Every client application, which is connected to a bus, registers under |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
76 a @dfn{unique name} at the bus. This name is used for identifying the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
77 client application. Such a unique name starts always with a colon, |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
78 and looks like @samp{:1.42}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
79 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
80 Additionally, a client application can register itself to a so called |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
81 @dfn{known name}, which is a series of identifiers separated by dots, |
86972
acea77e0ee56
(Overview): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents:
86944
diff
changeset
|
82 as in @samp{org.gnu.Emacs}. If several applications register to the |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
83 same known name, these registrations are queued, and only the first |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
84 application which has registered for the known name is reachable via |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
85 this name. If this application disconnects from the bus, the next |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
86 queued unique name becomes the owner of this known name. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
87 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
88 An application can install one or several objects under its name. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
89 Such objects are identified by an @dfn{object path}, which looks |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
90 similar to paths in a filesystem. An example of such an object path |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
91 could be @samp{/org/gnu/Emacs/}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
92 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
93 Applications might send a request to an object, that means sending a |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
94 message with some data as input parameters, and receiving a message |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
95 from that object with the result of this message, the output |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
96 parameters. Such a request is called @dfn{method} in D-Bus. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
97 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
98 The other form of communication are @dfn{signals}. The underlying |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
99 message is emitted from an object and will be received by all other |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
100 applications which have registered for such a signal. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
101 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
102 All methods and signals an object supports are called @dfn{interface} |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
103 of the object. Interfaces are specified under a hierarchical name in |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
104 D-Bus; an object can support several interfaces. Such an interface |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
105 name could be @samp{org.gnu.Emacs.TextEditor} or |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
106 @samp{org.gnu.Emacs.FileManager}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
107 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
108 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
109 @node Inspection |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
110 @chapter Inspection of D-Bus services. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
111 @cindex inspection |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
112 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
113 @menu |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
114 * Bus names:: Discovering D-Bus names. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
115 * Introspection:: Knowing the details of D-Bus services. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
116 * Nodes and Interfaces:: Detecting object paths and interfaces. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
117 * Methods and Signal:: Applying the functionality. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
118 * Properties and Annotations:: What else to know about interfaces. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
119 * Arguments and Signatures:: The final details. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
120 @end menu |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
121 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
122 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
123 @node Bus names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
124 @section Bus names. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
125 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
126 There are several basic functions which inspect the buses for |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
127 registered names. Internally they use the basic interface |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
128 @samp{org.freedesktop.DBus}, which is supported by all objects of a bus. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
129 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
130 @defun dbus-list-activatable-names |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
131 This function returns the D-Bus service names, which can be activated. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
132 An activatable service is described in a service registration file. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
133 Under GNU/Linux, such files are located at |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
134 @file{/usr/share/dbus-1/services/}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
135 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
136 The result is a list of strings, which is @code{nil} when there are no |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
137 activatable service names at all. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
138 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
139 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
140 @defun dbus-list-names bus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
141 All service names, which are registered at D-Bus @var{bus}, are |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
142 returned. The result is a list of strings, which is @code{nil} when |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
143 there are no registered service names at all. Well known names are |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
144 strings like @samp{org.freedesktop.DBus}. Names starting with |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
145 @samp{:} are unique names for services. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
146 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
147 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
148 @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
149 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
150 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
151 @defun dbus-list-known-names bus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
152 Retrieves all services which correspond to a known name in @var{bus}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
153 A service has a known name if it doesn't start with @samp{:}. The |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
154 result is a list of strings, which is @code{nil} when there are no |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
155 known names at all. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
156 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
157 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
158 @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
159 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
160 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
161 @defun dbus-list-queued-owners bus service |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
162 For a given service, registered at D-Bus @var{bus} under the name |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
163 @var{service}, all queued unique names are returned. The result is a |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
164 list of strings, or @code{nil} when there are no queued names for |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
165 @var{service} at all. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
166 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
167 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
168 @code{:session}. @var{service} must be a known service name as |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
169 string. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
170 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
171 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
172 @defun dbus-get-name-owner bus service |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
173 For a given service, registered at D-Bus @var{bus} under the name |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
174 @var{service}, the unique name of the name owner is returned. The |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
175 result is a string, or @code{nil} when there exist no name owner of |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
176 @var{service}. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
177 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
178 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
179 @code{:session}. @var{service} must be a known service name as |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
180 string. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
181 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
182 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
183 @defun dbus-ping bus service |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
184 Check whether the service name @var{service} is registered at D-Bus |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
185 @var{bus}. @var{service} might not have been started yet. The result |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
186 is either @code{t} or @code{nil}. |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
187 |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
188 @var{bus} must be either the symbol @code{:system} or the symbol |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
189 @code{:session}. @var{service} must be a string. Example: |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
190 |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
191 @lisp |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
192 (message |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
193 "%s screensaver on board." |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
194 (cond |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
195 ((dbus-ping :session "org.gnome.ScreenSaver") "Gnome") |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
196 ((dbus-ping :session "org.freedesktop.ScreenSaver") "KDE") |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
197 (t "No"))) |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
198 @end lisp |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
199 @end defun |
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
200 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
201 @defun dbus-get-unique-name bus |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
202 The unique name, under which Emacs is registered at D-Bus @var{bus}, |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
203 is returned as string. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
204 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
205 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
206 @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
207 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
208 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
209 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
210 @node Introspection |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
211 @section Knowing the details of D-Bus services. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
212 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
213 D-Bus services publish their interfaces. This can be retrieved and |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
214 analyzed during runtime, in order to understand the used |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
215 implementation. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
216 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
217 The resulting introspection data are in XML format. The root |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
218 introspection element is always a @code{node} element. It might have |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
219 a @code{name} attribute, which denotes the (absolute) object path an |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
220 interface is introspected. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
221 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
222 The root @code{node} element may have @code{node} and @code{interface} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
223 children. A child @code{node} element must have a @code{name} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
224 attribute, this case it is the relative object path to the root |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
225 @code{node} element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
226 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
227 An @code{interface} element has just one attribute, @code{name}, which |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
228 is the full name of that interface. The default interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
229 @samp{org.freedesktop.DBus.Introspectable} is always present. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
230 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
231 @example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
232 <node name="/org/bluez"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
233 <interface name="org.freedesktop.DBus.Introspectable"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
234 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
235 </interface> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
236 <interface name="org.bluez.Manager"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
237 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
238 </interface> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
239 <interface name="org.bluez.Database"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
240 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
241 </interface> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
242 <interface name="org.bluez.Security"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
243 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
244 </interface> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
245 <node name="service_audio"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
246 <node name="service_input"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
247 <node name="service_network"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
248 <node name="service_serial"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
249 </node> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
250 @end example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
251 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
252 Children of an @code{interface} element can be @code{method}, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
253 @code{signal} and @code{property} elements. A @code{method} element |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
254 stands for a D-Bus method of the surrounding interface. The element |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
255 itself has a @code{name} attribute, showing the method name. Children |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
256 elements @code{arg} stand for the arguments of a method. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
257 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
258 @example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
259 <method name="ResolveHostName"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
260 <arg name="interface" type="i" direction="in"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
261 <arg name="protocol" type="i" direction="in"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
262 <arg name="name" type="s" direction="in"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
263 <arg name="aprotocol" type="i" direction="in"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
264 <arg name="flags" type="u" direction="in"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
265 <arg name="interface" type="i" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
266 <arg name="protocol" type="i" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
267 <arg name="name" type="s" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
268 <arg name="aprotocol" type="i" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
269 <arg name="address" type="s" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
270 <arg name="flags" type="u" direction="out"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
271 </method> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
272 @end example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
273 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
274 @code{arg} elements can have the attributes @code{name}, @code{type} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
275 and @code{direction}. The @code{name} attribute is optional. The |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
276 @code{type} attribute stands for the @dfn{signature} of the argument |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
277 in D-Bus. For a discussion of D-Bus types and their Lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
278 representation see @ref{Type Conversion}.@footnote{D-Bus signatures |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
279 are explained in the D-Bus specification |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
280 @uref{http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-signatures}.} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
281 The @code{direction} attribute of an @code{arg} element can be only |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
282 @samp{in} or @samp{out}; in case it is omitted, it defaults to |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
283 @samp{in}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
284 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
285 A @code{signal} element of an @code{interface} has a similar |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
286 structure. The @code{direction} attribute of an @code{arg} child |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
287 element can be only @samp{out} here; which is also the default value. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
288 Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
289 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
290 @example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
291 <signal name="StateChanged"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
292 <arg name="state" type="i"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
293 <arg name="error" type="s"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
294 </signal> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
295 @end example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
296 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
297 A @code{property} element has no @code{arg} child |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
298 element. It just has the attributes @code{name}, @code{type} and |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
299 @code{access}, which are all mandatory. The @code{access} attribute |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
300 allows the values @samp{readwrite}, @samp{read}, and @samp{write}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
301 Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
302 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
303 @example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
304 <property name="Status" type="u" direction="read"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
305 @end example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
306 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
307 @code{annotation} elements can be children of @code{interface}, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
308 @code{method}, @code{signal}, and @code{property} elements. Unlike |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
309 properties, which can change their values during lifetime of a D-Bus |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
310 object, annotations are static. Often they are used for code |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
311 generators of D-Bus langugae bindings. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
312 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
313 @example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
314 <annotation name="de.berlios.Pinot.GetStatistics" value="pinotDBus"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
315 @end example |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
316 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
317 Annotations have just @code{name} and @code{value} attributes, both |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
318 must be strings. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
319 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
320 @defun dbus-introspect bus service path |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
321 This function returns all interfaces and sub-nodes of @var{service}, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
322 registered at object path @var{path} at bus @var{bus}. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
323 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
324 @var{bus} must be either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
325 @code{:session}. @var{service} must be a known service name, and |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
326 @var{path} must be a valid object path. The last two parameters are |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
327 strings. The result, the introspection data, is a string in XML |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
328 format. Example: |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
329 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
330 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
331 (dbus-introspect |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
332 :system "org.freedesktop.Hal" |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
333 "/org/freedesktop/Hal/devices/computer") |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
334 |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
335 @result{} "<!DOCTYPE node PUBLIC |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
336 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
337 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
338 <node> |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
339 <interface name="org.freedesktop.Hal.Device"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
340 <method name="GetAllProperties"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
341 <arg name="properties" direction="out" type="a@{sv@}"/> |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
342 </method> |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
343 @dots{} |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
344 <signal name="PropertyModified"> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
345 <arg name="num_updates" type="i"/> |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
346 <arg name="updates" type="a(sbb)"/> |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
347 </signal> |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
348 </interface> |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
349 @dots{} |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
350 </node>" |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
351 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
352 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
353 This example informs us, that the service @samp{org.freedesktop.Hal} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
354 at object path @samp{/org/freedesktop/Hal/devices/computer} offers the |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
355 interface @samp{org.freedesktop.Hal.Device} (and 2 other interfaces |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
356 not documented here). This interface contains the method |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
357 @samp{GetAllProperties}, which needs no input parameters, but returns |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
358 as output parameter an array of dictionary entries (key-value pairs). |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
359 Every dictionary entry has a string as key, and a variant as value. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
360 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
361 The interface offers also a signal, which returns 2 parameters: an |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
362 integer, and an array consisting of elements which are a struct of a |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
363 string and 2 boolean values.@footnote{ The interfaces of the service |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
364 @samp{org.freedesktop.Hal} are described at |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
365 @uref{http://people.freedesktop.org/~david/hal-spec/hal-spec.html#interfaces}.} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
366 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
367 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
368 @defun dbus-introspect-xml bus service path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
369 This function has the same intention as function |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
370 @code{dbus-introspect}. The returned value is a parsed XML tree, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
371 which can be used for further analysis. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
372 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
373 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
374 (dbus-introspect-xml |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
375 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
376 "/org/freedesktop/xesam/searcher/main") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
377 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
378 @result{} (node ((name . "/org/freedesktop/xesam/searcher/main")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
379 (interface ((name . "org.freedesktop.xesam.Search")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
380 (method ((name . "GetHitData")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
381 (arg ((name . "search") (type . "s") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
382 (arg ((name . "hit_ids") (type . "au") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
383 (arg ((name . "fields") (type . "as") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
384 (arg ((name . "hit_data") (type . "aav") (direction . "out"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
385 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
386 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
387 (signal ((name . "HitsAdded")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
388 (arg ((name . "search") (type . "s"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
389 (arg ((name . "count") (type . "u"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
390 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
391 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
392 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
393 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
394 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
395 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
396 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
397 @defun dbus-introspect-get-attribute object attribute |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
398 It returns the @var{attribute} value of a D-Bus introspection |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
399 @var{object}. @var{object} can be every subtree of a parsed XML tree |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
400 as retrieved with @code{dbus-introspect-xml}. @var{attribute} must be |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
401 a string according to the attribute names in the D-Bus specification. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
402 Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
403 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
404 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
405 (dbus-introspect-get-attribute |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
406 (dbus-introspect-xml :system "org.freedesktop.SystemToolsBackends" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
407 "/org/freedesktop/SystemToolsBackends/UsersConfig") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
408 "name") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
409 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
410 @result{} "/org/freedesktop/SystemToolsBackends/UsersConfig" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
411 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
412 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
413 If @var{object} has no @var{attribute}, the function returns nil. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
414 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
415 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
416 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
417 @node Nodes and Interfaces |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
418 @section Detecting object paths and interfaces. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
419 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
420 The first elements, to be introspected for a D-Bus object, are further |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
421 object paths and interfaces. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
422 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
423 @defun dbus-introspect-get-node-names bus service path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
424 All node names of @var{service} in D-Bus @var{bus} at object path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
425 @var{path} are returned as list of strings. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
426 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
427 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
428 (dbus-introspect-get-node-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
429 :session "org.gnome.seahorse" "/org/gnome/seahorse") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
430 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
431 @result{} ("crypto" "keys") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
432 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
433 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
434 The node names stand for further object paths of the D-Bus |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
435 @var{service}, relative to @var{path}. In the example, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
436 @samp{/org/gnome/seahorse/crypto} and @samp{/org/gnome/seahorse/keys} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
437 are also object paths of the D-Bus service @samp{org.gnome.seahorse}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
438 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
439 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
440 @defun dbus-introspect-get-all-nodes bus service path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
441 This function returns all node names of @var{service} in D-Bus |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
442 @var{bus} at object path @var{path}. It returns a list of strings |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
443 with all object paths of @var{service}, starting at @var{path}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
444 Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
445 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
446 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
447 (dbus-introspect-get-all-nodes :session "org.gnome.seahorse" "/") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
448 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
449 @result{} ("/" "/org" "/org/gnome" "/org/gnome/seahorse" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
450 "/org/gnome/seahorse/crypto" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
451 "/org/gnome/seahorse/keys" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
452 "/org/gnome/seahorse/keys/openpgp" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
453 "/org/gnome/seahorse/keys/openpgp/local" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
454 "/org/gnome/seahorse/keys/openssh" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
455 "/org/gnome/seahorse/keys/openssh/local") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
456 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
457 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
458 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
459 @defun dbus-introspect-get-interface-names bus service path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
460 There will be returned a list strings of all interface names of |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
461 @var{service} in D-Bus @var{bus} at object path @var{path}. This list |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
462 will contain the default interface @samp{org.freedesktop.DBus.Introspectable}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
463 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
464 Another default interface is @samp{org.freedesktop.DBus.Properties}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
465 If present, @code{interface} elements can also have @code{property} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
466 children. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
467 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
468 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
469 (dbus-introspect-get-interface-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
470 :system "org.freedesktop.Hal" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
471 "/org/freedesktop/Hal/devices/computer") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
472 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
473 @result{} ("org.freedesktop.DBus.Introspectable" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
474 "org.freedesktop.Hal.Device" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
475 "org.freedesktop.Hal.Device.SystemPowerManagement" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
476 "org.freedesktop.Hal.Device.CPUFreq") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
477 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
478 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
479 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
480 @defun dbus-introspect-get-interface bus service path interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
481 Return @var{interface} of @var{service} in D-Bus @var{bus} at object |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
482 path @var{path}. The return value is an XML element. @var{interface} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
483 must be a string, element of the list returned by |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
484 @code{dbus-introspect-get-interface-names}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
485 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
486 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
487 (dbus-introspect-get-interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
488 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
489 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
490 "org.freedesktop.xesam.Search") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
491 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
492 @result{} (interface ((name . "org.freedesktop.xesam.Search")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
493 (method ((name . "GetHitData")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
494 (arg ((name . "search") (type . "s") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
495 (arg ((name . "hit_ids") (type . "au") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
496 (arg ((name . "fields") (type . "as") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
497 (arg ((name . "hit_data") (type . "aav") (direction . "out"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
498 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
499 @dots{} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
500 (signal ((name . "HitsAdded")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
501 (arg ((name . "search") (type . "s"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
502 (arg ((name . "count") (type . "u"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
503 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
504 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
505 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
506 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
507 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
508 @noindent |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
509 With these functions, it is possible to retrieve all introspection |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
510 data from a running system: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
511 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
512 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
513 (with-current-buffer (switch-to-buffer "*introspect*") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
514 (erase-buffer) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
515 (dolist (service (dbus-list-known-names :session)) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
516 (dolist (path (dbus-introspect-get-all-nodes :session service "/")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
517 ;; We want to introspect only elements, which have more than |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
518 ;; the default interface "org.freedesktop.DBus.Introspectable". |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
519 (when (delete |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
520 "org.freedesktop.DBus.Introspectable" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
521 (dbus-introspect-get-interface-names :session service path)) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
522 (insert (message "\nservice: \"%s\" path: \"%s\"\n" service path) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
523 (dbus-introspect :session service path)) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
524 (redisplay t))))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
525 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
526 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
527 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
528 @node Methods and Signal |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
529 @section Applying the functionality. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
530 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
531 Methods and signals are the communicatione means to D-Bus. The |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
532 following functions return their specifications. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
533 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
534 @defun dbus-introspect-get-method-names bus service path interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
535 Return a list of strings of all method names of @var{interface} of |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
536 @var{service} in D-Bus @var{bus} at object path @var{path}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
537 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
538 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
539 (dbus-introspect-get-method-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
540 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
541 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
542 "org.freedesktop.xesam.Search") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
543 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
544 @result{} ("GetState" "StartSearch" "GetHitCount" "GetHits" "NewSession" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
545 "CloseSession" "GetHitData" "SetProperty" "NewSearch" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
546 "GetProperty" "CloseSearch") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
547 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
548 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
549 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
550 @defun dbus-introspect-get-method bus service path interface method |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
551 This function returns @var{method} of @var{interface} as XML element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
552 It must be located at @var{service} in D-Bus @var{bus} at object path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
553 @var{path}. @var{method} must be a string, element of the list |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
554 returned by @code{dbus-introspect-get-method-names}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
555 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
556 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
557 (dbus-introspect-get-method |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
558 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
559 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
560 "org.freedesktop.xesam.Search" "GetHitData") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
561 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
562 @result{} (method ((name . "GetHitData")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
563 (arg ((name . "search") (type . "s") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
564 (arg ((name . "hit_ids") (type . "au") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
565 (arg ((name . "fields") (type . "as") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
566 (arg ((name . "hit_data") (type . "aav") (direction . "out"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
567 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
568 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
569 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
570 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
571 @defun dbus-introspect-get-signal-names bus service path interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
572 Return a list of strings of all signal names of @var{interface} of |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
573 @var{service} in D-Bus @var{bus} at object path @var{path}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
574 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
575 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
576 (dbus-introspect-get-signal-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
577 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
578 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
579 "org.freedesktop.xesam.Search") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
580 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
581 @result{} ("StateChanged" "SearchDone" "HitsModified" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
582 "HitsRemoved" "HitsAdded") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
583 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
584 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
585 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
586 @defun dbus-introspect-get-signal bus service path interface signal |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
587 This function returns @var{signal} of @var{interface} as XML element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
588 It must be located at @var{service} in D-Bus @var{bus} at object path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
589 @var{path}. @var{signal} must be a string, element of the list |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
590 returned by @code{dbus-introspect-get-signal-names}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
591 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
592 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
593 (dbus-introspect-get-signal |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
594 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
595 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
596 "org.freedesktop.xesam.Search" "HitsAdded") |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
597 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
598 @result{} (signal ((name . "HitsAdded")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
599 (arg ((name . "search") (type . "s"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
600 (arg ((name . "count") (type . "u"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
601 ) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
602 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
603 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
604 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
605 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
606 @node Properties and Annotations |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
607 @section What else to know about interfaces. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
608 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
609 Interfaces can have properties. These can be exposed via the |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
610 @samp{org.freedesktop.DBus.Properties} interface@footnote{See |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
611 @uref{http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties}}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
612 That is, properties can be retrieved and changed during lifetime of an |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
613 element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
614 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
615 Annotations, on the other hand, are static values for an element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
616 Often, they are used to instruct generators, how to generate code from |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
617 the interface for a given language binding. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
618 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
619 @defun dbus-introspect-get-property-names bus service path interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
620 Return a list of strings with all property names of @var{interface} of |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
621 @var{service} in D-Bus @var{bus} at object path @var{path}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
622 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
623 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
624 (dbus-introspect-get-property-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
625 :session "org.kde.kded" "/modules/networkstatus" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
626 "org.kde.Solid.Networking.Client") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
627 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
628 @result{} ("Status") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
629 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
630 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
631 If an interface declares properties, the corresponding element supports |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
632 also the @samp{org.freedesktop.DBus.Properties} interface. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
633 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
634 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
635 @defun dbus-introspect-get-property bus service path interface property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
636 This function returns @var{property} of @var{interface} as XML element. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
637 It must be located at @var{service} in D-Bus @var{bus} at object path |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
638 @var{path}. @var{property} must be a string, element of the list |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
639 returned by @code{dbus-introspect-get-property-names}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
640 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
641 A @var{property} value can be retrieved by the function |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
642 @code{dbus-introspect-get-attribute}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
643 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
644 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
645 (dbus-introspect-get-property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
646 :session "org.kde.kded" "/modules/networkstatus" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
647 "org.kde.Solid.Networking.Client" "Status") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
648 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
649 @result{} (property ((access . "read") (type . "u") (name . "Status"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
650 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
651 (dbus-introspect-get-attribute |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
652 (dbus-introspect-get-property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
653 :session "org.kde.kded" "/modules/networkstatus" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
654 "org.kde.Solid.Networking.Client" "Status") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
655 "access") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
656 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
657 @result{} "read" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
658 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
659 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
660 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
661 @defun dbus-get-property bus service path interface property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
662 This function returns the value of @var{property} of @var{interface}. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
663 It will be checked at @var{bus}, @var{service}, @var{path}. The |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
664 result can be any valid D-Bus value, or nil if there is no |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
665 @var{property}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
666 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
667 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
668 (dbus-get-property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
669 :session "org.kde.kded" "/modules/networkstatus" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
670 "org.kde.Solid.Networking.Client" "Status") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
671 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
672 @result{} 4 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
673 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
674 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
675 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
676 @defun dbus-set-property bus service path interface property value |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
677 Set value of @var{property} of @var{interface} to @var{value}. It |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
678 will be checked at @var{bus}, @var{service}, @var{path}. When the |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
679 value has been set successful, the result is @var{value}. Otherwise, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
680 @code{nil} is returned. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
681 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
682 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
683 (dbus-set-property |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
684 :session "org.kde.kaccess" "/MainApplication" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
685 "com.trolltech.Qt.QApplication" "doubleClickInterval" 500) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
686 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
687 @result{} 500 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
688 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
689 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
690 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
691 @defun dbus-get-all-properties bus service path interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
692 This function returns all properties of @var{interface}. It will be |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
693 checked at @var{bus}, @var{service}, @var{path}. The result is a list |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
694 of cons. Every cons contains the name of the property, and its value. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
695 If there are no properties, @code{nil} is returned. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
696 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
697 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
698 (dbus-get-all-properties |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
699 :session "org.kde.kaccess" "/MainApplication" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
700 "com.trolltech.Qt.QApplication") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
701 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
702 @result{} (("cursorFlashTime" . 1000) ("doubleClickInterval" . 500) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
703 ("keyboardInputInterval" . 400) ("wheelScrollLines" . 3) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
704 ("globalStrut" 0 0) ("startDragTime" . 500) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
705 ("startDragDistance" . 4) ("quitOnLastWindowClosed" . t) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
706 ("styleSheet" . "")) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
707 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
708 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
709 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
710 @defun dbus-introspect-get-annotation-names bus service path interface &optional name |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
711 Return a list of all annotation names as list of strings. If |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
712 @var{name} is @code{nil}, the annotations are children of |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
713 @var{interface}, otherwise @var{name} must be a @code{method}, |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
714 @code{signal}, or @code{property} XML element, where the annotations |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
715 belong to. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
716 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
717 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
718 (dbus-introspect-get-annotation-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
719 :session "de.berlios.Pinot" "/de/berlios/Pinot" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
720 "de.berlios.Pinot" "GetStatistics") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
721 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
722 @result{} ("de.berlios.Pinot.GetStatistics") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
723 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
724 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
725 Default annotation names@footnote{See |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
726 @uref{http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format}} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
727 are |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
728 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
729 @table @samp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
730 @item org.freedesktop.DBus.Deprecated |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
731 Whether or not the entity is deprecated; defaults to @code{nil} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
732 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
733 @item org.freedesktop.DBus.GLib.CSymbol |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
734 The C symbol; may be used for @code{methods} and @code{interfaces} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
735 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
736 @item org.freedesktop.DBus.Method.NoReply |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
737 If set, don't expect a reply to the @code{method} call; defaults to @code{nil} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
738 @end table |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
739 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
740 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
741 @defun dbus-introspect-get-annotation bus service path interface name annotation |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
742 Return annotation @var{ANNOTATION} as XML object. If @var{name} is |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
743 @code{nil}, @var{ANNOTATION} is a child of @var{interface}, otherwise |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
744 @var{name} must be the name of a @code{method}, @code{signal}, or |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
745 @code{property} XML element, where the @var{ANNOTATION} belongs to. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
746 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
747 An attribute value can be retrieved by |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
748 @code{dbus-introspect-get-attribute}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
749 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
750 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
751 (dbus-introspect-get-annotation |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
752 :session "de.berlios.Pinot" "/de/berlios/Pinot" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
753 "de.berlios.Pinot" "GetStatistics" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
754 "de.berlios.Pinot.GetStatistics") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
755 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
756 @result{} (annotation ((name . "de.berlios.Pinot.GetStatistics") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
757 (value . "pinotDBus"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
758 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
759 (dbus-introspect-get-attribute |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
760 (dbus-introspect-get-annotation |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
761 :session "de.berlios.Pinot" "/de/berlios/Pinot" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
762 "de.berlios.Pinot" "GetStatistics" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
763 "de.berlios.Pinot.GetStatistics") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
764 "value") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
765 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
766 @result{} "pinotDBus" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
767 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
768 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
769 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
770 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
771 @node Arguments and Signatures |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
772 @section The final details. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
773 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
774 Methods and signals have arguments. They are described in the |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
775 @code{arg} XML elements. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
776 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
777 @defun dbus-introspect-get-argument-names bus service path interface name |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
778 Return a list of all argument names as list of strings. @var{name} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
779 must be a @code{method} or @code{signal} XML element. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
780 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
781 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
782 (dbus-introspect-get-argument-names |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
783 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
784 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
785 "org.freedesktop.xesam.Search" "GetHitData") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
786 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
787 @result{} ("search" "hit_ids" "fields" "hit_data") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
788 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
789 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
790 Argument names are optional; the function can return @code{nil} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
791 therefore, even if the method or signal has arguments. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
792 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
793 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
794 @defun dbus-introspect-get-argument bus service path interface name arg |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
795 Return argument @var{ARG} as XML object. @var{name} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
796 must be a @code{method} or @code{signal} XML element. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
797 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
798 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
799 (dbus-introspect-get-argument |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
800 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
801 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
802 "org.freedesktop.xesam.Search" "GetHitData" "search") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
803 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
804 @result{} (arg ((name . "search") (type . "s") (direction . "in"))) |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
805 @end lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
806 @end defun |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
807 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
808 @defun dbus-introspect-get-signature bus service path interface name &optional direction |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
809 Return signature of a @code{method} or @code{signal}, represented by |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
810 @var{name}, as string. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
811 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
812 If @var{name} is a @code{method}, @var{direction} can be either |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
813 @samp{in} or @samp{out}. If @var{direction} is @code{nil}, @samp{in} |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
814 is assumed. |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
815 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
816 If @var{name} is a @code{signal}, and @var{direction} is |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
817 non-@code{nil}, @var{direction} must be @samp{out}. Example: |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
818 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
819 @lisp |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
820 (dbus-introspect-get-signature |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
821 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
822 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
823 "org.freedesktop.xesam.Search" "GetHitData" "in") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
824 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
825 @result{} "sauas" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
826 |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
827 (dbus-introspect-get-signature |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
828 :session "org.freedesktop.xesam.searcher" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
829 "/org/freedesktop/xesam/searcher/main" |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
830 "org.freedesktop.xesam.Search" "HitsAdded") |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
831 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
832 @result{} "su" |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
833 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
834 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
835 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
836 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
837 @node Type Conversion |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
838 @chapter Mapping Lisp types and D-Bus types. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
839 @cindex type conversion |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
840 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
841 D-Bus method calls and signals accept usually several arguments as |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
842 parameters, either as input parameter, or as output parameter. Every |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
843 argument belongs to a D-Bus type. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
844 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
845 Such arguments must be mapped between the value encoded as a D-Bus |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
846 type, and the corresponding type of Lisp objects. The mapping is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
847 applied Lisp object @expansion{} D-Bus type for input parameters, and |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
848 D-Bus type @expansion{} Lisp object for output parameters. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
849 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
850 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
851 @section Input parameters. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
852 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
853 Input parameters for D-Bus methods and signals occur as arguments of a |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
854 Lisp function call. The following mapping to D-Bus types is |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
855 applied, when the corresponding D-Bus message is created: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
856 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
857 @example |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
858 @multitable {@code{t} and @code{nil}} {@expansion{}} {DBUS_TYPE_BOOLEAN} |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
859 @item Lisp type @tab @tab D-Bus type |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
860 @item |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
861 @item @code{t} and @code{nil} @tab @expansion{} @tab DBUS_TYPE_BOOLEAN |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
862 @item number @tab @expansion{} @tab DBUS_TYPE_UINT32 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
863 @item integer @tab @expansion{} @tab DBUS_TYPE_INT32 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
864 @item float @tab @expansion{} @tab DBUS_TYPE_DOUBLE |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
865 @item string @tab @expansion{} @tab DBUS_TYPE_STRING |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
866 @item list @tab @expansion{} @tab DBUS_TYPE_ARRAY |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
867 @end multitable |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
868 @end example |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
869 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
870 Other Lisp objects, like symbols or hash tables, are not accepted as |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
871 input parameter. |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
872 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
873 If it is necessary to use another D-Bus type, a corresponding type |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
874 symbol can be preceeded to the corresponding Lisp object. Basic D-Bus |
87365
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
875 types are represented by the type symbols @code{:byte}, |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
876 @code{:boolean}, @code{:int16}, @code{:uint16}, @code{:int32}, |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
877 @code{:uint32}, @code{:int64}, @code{:uint64}, @code{:double}, |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
878 @code{:string}, @code{:object-path} and @code{:signature}. |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
879 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
880 @noindent |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
881 Example: |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
882 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
883 @lisp |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
884 (dbus-call-method @dots{} @var{NUMBER} @var{STRING}) |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
885 @end lisp |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
886 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
887 is equivalent to |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
888 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
889 @lisp |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
890 (dbus-call-method @dots{} :uint32 @var{NUMBER} :string @var{STRING}) |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
891 @end lisp |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
892 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
893 but different to |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
894 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
895 @lisp |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
896 (dbus-call-method @dots{} :int32 @var{NUMBER} :signature @var{STRING}) |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
897 @end lisp |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
898 |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
899 The value for a byte D-Bus type can be any integer in the range 0 |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
900 through 255. If a character is used as argument, modifiers |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
901 represented outside this range are stripped of. For example, |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
902 @code{:byte ?x} is equal to @code{:byte ?\M-x}, but it is not equal to |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
903 @code{:byte ?\C-x} or @code{:byte ?\M-\C-x}. |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
904 |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
905 A D-Bus compound type is always represented as a list. The @sc{car} |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
906 of this list can be the type symbol @code{:array}, @code{:variant}, |
87365
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
907 @code{:struct} or @code{:dict-entry}, which would result in a |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
908 corresponding D-Bus container. @code{:array} is optional, because |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
909 this is the default compound D-Bus type for a list. |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
910 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
911 The objects being elements of the list are checked according to the |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
912 D-Bus compound type rules. |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
913 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
914 @itemize |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
915 @item An array must contain only elements of the same D-Bus type. It |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
916 can be empty. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
917 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
918 @item A variant must contain only one single element. |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
919 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
920 @item A dictionary entry must be element of an array, and it must |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
921 contain only a key-value pair of two elements, with a basic D-Bus type |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
922 key. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
923 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
924 @item There is no restriction for structs. |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
925 @end itemize |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
926 |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
927 If an empty array needs an element D-Bus type other than string, it |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
928 can contain exactly one element of D-Bus type @code{:signature}. The |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
929 value of this element (a string) is used as the signature of the |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
930 elements of this array. Example: |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
931 |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
932 @lisp |
87540
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
933 (dbus-call-method |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
934 :session "org.freedesktop.Notifications" |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
935 "/org/freedesktop/Notifications" |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
936 "org.freedesktop.Notifications" "Notify" |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
937 "GNU Emacs" ;; Application name. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
938 0 ;; No replacement of other notifications. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
939 "" ;; No icon. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
940 "Notification summary" ;; Summary. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
941 (format ;; Body. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
942 "This is a test notification, raised from %s" (emacs-version)) |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
943 '(:array) ;; No actions (empty array of strings). |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
944 '(:array :signature "@{sv@}") ;; No hints |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
945 ;; (empty array of dictionary entries). |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
946 ':int32 -1) ;; Default timeout. |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
947 |
084340c0bd27
* dbus.texi (Type Conversion): Explain the type specification for empty
Michael Albinus <michael.albinus@gmx.de>
parents:
87491
diff
changeset
|
948 @result{} 3 |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
949 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
950 |
99952
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
951 @defun dbus-string-to-byte-array string |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
952 Sometimes, D-Bus methods require as input parameter an array of bytes, |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
953 instead of a string. If it is guaranteed, that @var{string} is an |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
954 UTF8 string, this function performs the conversion. Example: |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
955 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
956 @lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
957 (dbus-string-to-byte-array "/etc/hosts") |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
958 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
959 @result{} (:array :byte 47 :byte 101 :byte 116 :byte 99 :byte 47 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
960 :byte 104 :byte 111 :byte 115 :byte 116 :byte 115) |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
961 @end lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
962 @end defun |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
963 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
964 @defun dbus-escape-as-identifier string |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
965 Escape an arbitrary @var{string} so it follows the rules for a C |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
966 identifier. The escaped string can be used as object path component, |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
967 interface element component, bus name component or member name in |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
968 D-Bus. |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
969 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
970 The escaping consists of replacing all non-alphanumerics, and the |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
971 first character if it's a digit, with an underscore and two |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
972 lower-case hex digits. As a special case, "" is escaped to |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
973 "_". Example: |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
974 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
975 @lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
976 (dbus-escape-as-identifier "0123abc_xyz\x01\xff") |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
977 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
978 @result{} "_30123abc_5fxyz_01_ff" |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
979 @end lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
980 @end defun |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
981 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
982 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
983 @section Output parameters. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
984 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
985 Output parameters of D-Bus methods and signals are mapped to Lisp |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
986 objects. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
987 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
988 @example |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
989 @multitable {DBUS_TYPE_OBJECT_PATH} {@expansion{}} {@code{t} or @code{nil}} |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
990 @item D-Bus type @tab @tab Lisp type |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
991 @item |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
992 @item DBUS_TYPE_BOOLEAN @tab @expansion{} @tab @code{t} or @code{nil} |
87365
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
993 @item DBUS_TYPE_BYTE @tab @expansion{} @tab number |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
994 @item DBUS_TYPE_UINT16 @tab @expansion{} @tab number |
87365
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
995 @item DBUS_TYPE_INT16 @tab @expansion{} @tab number |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
996 @item DBUS_TYPE_UINT32 @tab @expansion{} @tab number or float |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
997 @item DBUS_TYPE_INT32 @tab @expansion{} @tab number or float |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
998 @item DBUS_TYPE_UINT64 @tab @expansion{} @tab number or float |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
999 @item DBUS_TYPE_INT64 @tab @expansion{} @tab number or float |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1000 @item DBUS_TYPE_DOUBLE @tab @expansion{} @tab float |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1001 @item DBUS_TYPE_STRING @tab @expansion{} @tab string |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1002 @item DBUS_TYPE_OBJECT_PATH @tab @expansion{} @tab string |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
1003 @item DBUS_TYPE_SIGNATURE @tab @expansion{} @tab string |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1004 @item DBUS_TYPE_ARRAY @tab @expansion{} @tab list |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1005 @item DBUS_TYPE_VARIANT @tab @expansion{} @tab list |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1006 @item DBUS_TYPE_STRUCT @tab @expansion{} @tab list |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1007 @item DBUS_TYPE_DICT_ENTRY @tab @expansion{} @tab list |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1008 @end multitable |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1009 @end example |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1010 |
87365
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
1011 A float object in case of @code{DBUS_TYPE_UINT32}, |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
1012 @code{DBUS_TYPE_INT32}, @code{DBUS_TYPE_UINT64} and |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
1013 @code{DBUS_TYPE_INT6432} is returned, when the C value exceeds the |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
1014 Emacs number size range. |
7744259cbbc0
* dbus.texi (Type Conversion): Correct input parameters mapping.
Michael Albinus <michael.albinus@gmx.de>
parents:
87362
diff
changeset
|
1015 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1016 The resulting list of the last 4 D-Bus compound types contains as |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1017 elements the elements of the D-Bus container, mapped according to the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1018 same rules. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1019 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1020 The signal @code{PropertyModified}, discussed as example in |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1021 @ref{Inspection}, would offer as Lisp data the following object |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1022 (@var{BOOL} stands here for either @code{nil} or @code{t}): |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1023 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1024 @lisp |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1025 (@var{NUMBER} ((@var{STRING} @var{BOOL} @var{BOOL}) (@var{STRING} @var{BOOL} @var{BOOL}) @dots{})) |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1026 @end lisp |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1027 |
99952
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1028 @defun dbus-byte-array-to-string byte-array |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1029 If a D-Bus method or signal returns an array of bytes, which are known |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1030 to represent an UTF8 string, this function converts @var{byte-array} |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1031 to the corresponding string. Example: |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1032 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1033 @lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1034 (dbus-byte-array-to-string '(47 101 116 99 47 104 111 115 116 115)) |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1035 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1036 @result{} "/etc/hosts" |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1037 @end lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1038 @end defun |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1039 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1040 @defun dbus-unescape-from-identifier string |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1041 Retrieve the original string from the encoded @var{string}. |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1042 @var{string} must have been coded with |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1043 @code{dbus-escape-as-identifier}. Example: |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1044 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1045 @lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1046 (dbus-unescape-from-identifier "_30123abc_5fxyz_01_ff") |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1047 |
103670
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1048 @ifinfo |
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1049 @result{} "0123abc_xyz^Aÿ" |
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1050 @end ifinfo |
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1051 @ifnotinfo |
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1052 @result{} "0123abc_xyz^A@"y" |
cbbd2a335c8c
(Type Conversion): Don't use literal control character.
Andreas Schwab <schwab@linux-m68k.org>
parents:
102151
diff
changeset
|
1053 @end ifnotinfo |
99952
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1054 @end lisp |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1055 @end defun |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1056 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1057 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1058 @node Synchronous Methods |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1059 @chapter Calling methods in a blocking way. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1060 @cindex method calls, synchronous |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1061 @cindex synchronous method calls |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1062 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1063 Methods can be called synchronously (@dfn{blocking}) or asynchronously |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1064 (@dfn{non-blocking}). |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1065 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1066 At D-Bus level, a method call consist of two messages: one message |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1067 which carries the input parameters to the object owning the method to |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1068 be called, and a reply message returning the resulting output |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1069 parameters from the object. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1070 |
93422
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1071 @defun dbus-call-method bus service path interface method &optional :timeout timeout &rest args |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1072 This function calls @var{method} on the D-Bus @var{bus}. @var{bus} is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1073 either the symbol @code{:system} or the symbol @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1074 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1075 @var{service} is the D-Bus service name to be used. @var{path} is the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1076 D-Bus object path, @var{service} is registered at. @var{interface} is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1077 an interface offered by @var{service}. It must provide @var{method}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1078 |
93422
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1079 If the parameter @code{:timeout} is given, the following integer |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1080 @var{timeout} specifies the maximum number of milliseconds the method |
93422
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1081 call must return. The default value is 25.000. If the method call |
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1082 doesn't return in time, a D-Bus error is raised (@pxref{Errors and |
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1083 Events}). |
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1084 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1085 All other arguments args are passed to @var{method} as arguments. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1086 They are converted into D-Bus types as described in @ref{Type |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1087 Conversion}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1088 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1089 The function returns the resulting values of @var{method} as a list of |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1090 Lisp objects, according to the type conversion rules described in |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1091 @ref{Type Conversion}. Example: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1092 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1093 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1094 (dbus-call-method |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1095 :session "org.gnome.seahorse" "/org/gnome/seahorse/keys/openpgp" |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1096 "org.gnome.seahorse.Keys" "GetKeyField" |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1097 "openpgp:657984B8C7A966DD" "simple-name") |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1098 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1099 @result{} (t ("Philip R. Zimmermann")) |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1100 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1101 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1102 If the result of the method call is just one value, the converted Lisp |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1103 object is returned instead of a list containing this single Lisp |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1104 object. Example: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1105 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1106 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1107 (dbus-call-method |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1108 :system "org.freedesktop.Hal" |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1109 "/org/freedesktop/Hal/devices/computer" |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1110 "org.freedesktop.Hal.Device" "GetPropertyString" |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1111 "system.kernel.machine") |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1112 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1113 @result{} "i686" |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1114 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1115 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1116 With the @code{dbus-introspect} function it is possible to explore the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1117 interfaces of @samp{org.freedesktop.Hal} service. It offers the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1118 interfaces @samp{org.freedesktop.Hal.Manager} for the object at the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1119 path @samp{/org/freedesktop/Hal/Manager} as well as the interface |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1120 @samp{org.freedesktop.Hal.Device} for all objects prefixed with the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1121 path @samp{/org/freedesktop/Hal/devices}. With the methods |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1122 @samp{GetAllDevices} and @samp{GetAllProperties}, it is simple to |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1123 emulate the @code{lshal} command on GNU/Linux systems: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1124 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1125 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1126 (dolist (device |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1127 (dbus-call-method |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1128 :system "org.freedesktop.Hal" |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1129 "/org/freedesktop/Hal/Manager" |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1130 "org.freedesktop.Hal.Manager" "GetAllDevices")) |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1131 (message "\nudi = %s" device) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1132 (dolist (properties |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1133 (dbus-call-method |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1134 :system "org.freedesktop.Hal" device |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1135 "org.freedesktop.Hal.Device" "GetAllProperties")) |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1136 (message " %s = %S" |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1137 (car properties) (or (caar (cdr properties)) "")))) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1138 |
87004
0877a1d16074
* Makefile.in (INFO_TARGETS, DVI_TARGETS): Apply dbus and dbus.dvi
Michael Albinus <michael.albinus@gmx.de>
parents:
86972
diff
changeset
|
1139 @print{} "udi = /org/freedesktop/Hal/devices/computer |
86944
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1140 info.addons = (\"hald-addon-acpi\") |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1141 info.bus = \"unknown\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1142 info.product = \"Computer\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1143 info.subsystem = \"unknown\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1144 info.udi = \"/org/freedesktop/Hal/devices/computer\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1145 linux.sysfs_path_device = \"(none)\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1146 power_management.acpi.linux.version = \"20051216\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1147 power_management.can_suspend_to_disk = t |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1148 power_management.can_suspend_to_ram = \"\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1149 power_management.type = \"acpi\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1150 smbios.bios.release_date = \"11/07/2001\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1151 system.chassis.manufacturer = \"COMPAL\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1152 system.chassis.type = \"Notebook\" |
9ae2c39a9be6
* dbus.texi: Applying comments from RMS.
Michael Albinus <michael.albinus@gmx.de>
parents:
86942
diff
changeset
|
1153 system.firmware.release_date = \"03/19/2005\" |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1154 @dots{}" |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1155 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1156 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1157 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1158 @defun dbus-call-method-non-blocking bus service path interface method &optional :timeout timeout &rest args |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1159 Call @var{method} on the D-Bus @var{bus}, but don't block the event queue. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1160 This is necessary for communicating to registered D-Bus methods, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1161 which are running in the same Emacs process. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1162 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1163 The arguments are the same as in @code{dbus-call-method}. Example: |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1164 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1165 @lisp |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1166 (dbus-call-method-non-blocking |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1167 :system "org.freedesktop.Hal" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1168 "/org/freedesktop/Hal/devices/computer" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1169 "org.freedesktop.Hal.Device" "GetPropertyString" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1170 "system.kernel.machine") |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1171 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1172 @result{} "i686" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1173 @end lisp |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1174 @end defun |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1175 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1176 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1177 @node Asynchronous Methods |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1178 @chapter Calling methods non-blocking. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1179 @cindex method calls, asynchronous |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1180 @cindex asynchronous method calls |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1181 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1182 @defun dbus-call-method-asynchronously bus service path interface method handler &optional :timeout timeout &rest args |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1183 This function calls @var{method} on the D-Bus @var{bus} |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1184 asynchronously. @var{bus} is either the symbol @code{:system} or the |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1185 symbol @code{:session}. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1186 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1187 @var{service} is the D-Bus service name to be used. @var{path} is the |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1188 D-Bus object path, @var{service} is registered at. @var{interface} is |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1189 an interface offered by @var{service}. It must provide @var{method}. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1190 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1191 @var{handler} is a Lisp function, which is called when the |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1192 corresponding return message has arrived. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1193 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1194 If the parameter @code{:timeout} is given, the following integer |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1195 @var{timeout} specifies the maximum number of milliseconds a reply |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1196 message must arrive. The default value is 25.000. If there is no |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1197 reply message in time, a D-Bus error is raised (@pxref{Errors and |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1198 Events}). |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1199 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1200 All other arguments args are passed to @var{method} as arguments. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1201 They are converted into D-Bus types as described in @ref{Type |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1202 Conversion}. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1203 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1204 The function returns a key into the hash table |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1205 @code{dbus-registered-functions-table}. The corresponding entry in |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1206 the hash table is removed, when the return message has been arrived, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1207 and @var{handler} is called. Example: |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1208 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1209 @lisp |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1210 (dbus-call-method-asynchronously |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1211 :system "org.freedesktop.Hal" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1212 "/org/freedesktop/Hal/devices/computer" |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1213 "org.freedesktop.Hal.Device" "GetPropertyString" 'message |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1214 "system.kernel.machine") |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1215 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1216 @result{} (:system 2) |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1217 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1218 @print{} i686 |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1219 @end lisp |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1220 @end defun |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1221 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1222 |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1223 @node Receiving Method Calls |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1224 @chapter Offering own methods. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1225 @cindex method calls, returning |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1226 @cindex returning method calls |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1227 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1228 Emacs can also offer own methods, which can be called by other |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1229 applications. These methods could be an implementation of an |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1230 interface of a well known service, like @samp{org.freedesktop.TextEditor}. |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1231 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1232 It could be also an implementation of an own interface. In this case, |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1233 the service name must be @samp{org.gnu.Emacs}. The object path shall |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1234 begin with @samp{/org/gnu/Emacs/@strong{Application}/}, and the |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1235 interface name shall be @code{org.gnu.Emacs.@strong{Application}}. |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1236 @samp{@strong{Application}} is the name of the application which |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1237 provides the interface. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1238 |
99952
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1239 @deffn Constant dbus-service-emacs |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1240 The well known service name of Emacs. |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1241 @end deffn |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1242 |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1243 @deffn Constant dbus-path-emacs |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1244 The object path head "/org/gnu/Emacs" used by Emacs. All object |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1245 paths, used by offered methods or signals, shall start with this |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1246 string. |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1247 @end deffn |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1248 |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1249 @defun dbus-register-method bus service path interface method handler |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1250 With this function, an application registers @var{method} on the D-Bus |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1251 @var{bus}. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1252 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1253 @var{bus} is either the symbol @code{:system} or the symbol |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1254 @code{:session}. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1255 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1256 @var{service} is the D-Bus service name of the D-Bus object |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1257 @var{method} is registered for. It must be a known name. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1258 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1259 @var{path} is the D-Bus object path @var{service} is |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1260 registered. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1261 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1262 @var{interface} is the interface offered by @var{service}. It must |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1263 provide @var{method}. |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1264 |
100008
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1265 @var{handler} is a Lisp function to be called when a @var{method} call |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1266 is received. It must accept as arguments the input arguments of |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1267 @var{method}. @var{handler} should return a list, whose elements are |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1268 to be used as arguments for the reply message of @var{method}. This |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1269 list can be composed like the input parameters in @ref{Type |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1270 Conversion}. |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1271 |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1272 If @var{handler} wants to return just one Lisp object and it is not a |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1273 cons cell, @var{handler} can return this object directly, instead of |
caa9c8dbbeb0
(Receiving Method Calls): Clean up previous change.
Richard M. Stallman <rms@gnu.org>
parents:
99966
diff
changeset
|
1274 returning a list containing the object. |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1275 |
93130
83be756929f1
* dbus.texi (Receiving Method Calls): Mention default D-Bus timeout.
Michael Albinus <michael.albinus@gmx.de>
parents:
91590
diff
changeset
|
1276 The default D-Bus timeout when waiting for a message reply is 25 |
93422
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1277 seconds. This value could be even smaller, depending on the calling |
d2f671c73132
* dbus.texi (Synchronous Methods): New parameter TIMEOUT for
Michael Albinus <michael.albinus@gmx.de>
parents:
93130
diff
changeset
|
1278 client. Therefore, @var{handler} shall not last longer than |
93130
83be756929f1
* dbus.texi (Receiving Method Calls): Mention default D-Bus timeout.
Michael Albinus <michael.albinus@gmx.de>
parents:
91590
diff
changeset
|
1279 absolutely necessary. |
83be756929f1
* dbus.texi (Receiving Method Calls): Mention default D-Bus timeout.
Michael Albinus <michael.albinus@gmx.de>
parents:
91590
diff
changeset
|
1280 |
96646
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1281 @code{dbus-register-method} returns a Lisp object, which can be used |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1282 as argument in @code{dbus-unregister-object} for removing the |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1283 registration for @var{method}. Example: |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1284 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1285 @lisp |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1286 (defun my-dbus-method-handler (filename) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1287 (let (result) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1288 (if (find-file filename) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1289 (setq result '(:boolean t)) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1290 (setq result '(:boolean nil))) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1291 result)) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1292 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1293 @result{} my-dbus-method-handler |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1294 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1295 (dbus-register-method |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1296 :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor" |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1297 "org.freedesktop.TextEditor" "OpenFile" |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1298 'my-dbus-method-handler) |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1299 |
97253
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1300 @result{} ((:session "org.freedesktop.TextEditor" "OpenFile") |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1301 ("org.freedesktop.TextEditor" "/org/freedesktop/TextEditor" |
97253
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1302 my-dbus-method-handler)) |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1303 @end lisp |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1304 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1305 If you invoke the method @samp{org.freedesktop.TextEditor.OpenFile} |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1306 from another D-Bus application with a filename as parameter, the file |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1307 is opened in Emacs, and the method returns either @var{true} or |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1308 @var{false}, indicating the success if the method. As test tool one |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1309 could use the command line tool @code{dbus-send} in a shell: |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1310 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1311 @example |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1312 # dbus-send --session --print-reply \ |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1313 --dest="org.freedesktop.TextEditor" \ |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1314 "/org/freedesktop/TextEditor" \ |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1315 "org.freedesktop.TextEditor.OpenFile" string:"/etc/hosts" |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1316 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1317 @print{} method return sender=:1.22 -> dest=:1.23 reply_serial=2 |
97253
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1318 boolean true |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1319 @end example |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1320 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1321 You can indicate an error by raising the Emacs signal |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1322 @code{dbus-error}. The handler above could be changed like this: |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1323 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1324 @lisp |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1325 (defun my-dbus-method-handler (&rest args) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1326 (unless (and (= (length args) 1) (stringp (car args))) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1327 (signal 'dbus-error (list (format "Wrong argument list: %S" args)))) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1328 (condition-case err |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1329 (find-file (car args)) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1330 (error (signal 'dbus-error (cdr err)))) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1331 t) |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1332 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1333 @result{} my-dbus-method-handler |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1334 @end lisp |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1335 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1336 The test runs then |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1337 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1338 @example |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1339 # dbus-send --session --print-reply \ |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1340 --dest="org.freedesktop.TextEditor" \ |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1341 "/org/freedesktop/TextEditor" \ |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1342 "org.freedesktop.TextEditor.OpenFile" \ |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1343 string:"/etc/hosts" string:"/etc/passwd" |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1344 |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1345 @print{} Error org.freedesktop.DBus.Error.Failed: |
cd0a7b292982
* dbus.texi (Receiving Method Calls): Document error handling of own
Michael Albinus <michael.albinus@gmx.de>
parents:
97163
diff
changeset
|
1346 Wrong argument list: ("/etc/hosts" "/etc/passwd") |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1347 @end example |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1348 @end defun |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1349 |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1350 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1351 @node Signals |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1352 @chapter Sending and receiving signals. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1353 @cindex signals |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1354 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1355 Signals are broadcast messages. They carry input parameters, which |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1356 are received by all objects which have registered for such a signal. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1357 |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1358 @defun dbus-send-signal bus service path interface signal &rest args |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1359 This function is similar to @code{dbus-call-method}. The difference |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1360 is, that there are no returning output parameters. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1361 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1362 The function emits @var{signal} on the D-Bus @var{bus}. @var{bus} is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1363 either the symbol @code{:system} or the symbol @code{:session}. It |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1364 doesn't matter whether another object has registered for @var{signal}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1365 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1366 @var{service} is the D-Bus service name of the object the signal is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1367 emitted from. @var{path} is the corresponding D-Bus object path, |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1368 @var{service} is registered at. @var{interface} is an interface |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1369 offered by @var{service}. It must provide @var{signal}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1370 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1371 All other arguments args are passed to @var{signal} as arguments. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1372 They are converted into D-Bus types as described in @ref{Type |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1373 Conversion}. Example: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1374 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1375 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1376 (dbus-send-signal |
99952
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1377 :session dbus-service-emacs dbus-path-emacs |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1378 (concat dbus-service-emacs ".FileManager") "FileModified" |
f89674a00bdc
* dbus.texi (Type Conversion): New defuns `dbus-string-to-byte-array',
Michael Albinus <michael.albinus@gmx.de>
parents:
99709
diff
changeset
|
1379 "/home/albinus/.emacs") |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1380 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1381 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1382 |
96646
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1383 @defun dbus-register-signal bus service path interface signal handler &rest args |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1384 With this function, an application registers for @var{signal} on the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1385 D-Bus @var{bus}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1386 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1387 @var{bus} is either the symbol @code{:system} or the symbol |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1388 @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1389 |
87049
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1390 @var{service} is the D-Bus service name used by the sending D-Bus |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1391 object. It can be either a known name or the unique name of the D-Bus |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1392 object sending the signal. In case of a unique name, signals won't be |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1393 received any longer once the object owning this unique name has |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1394 disappeared, and a new queued object has replaced it. |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1395 |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1396 When @var{service} is @code{nil}, related signals from all D-Bus |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1397 objects shall be accepted. |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1398 |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1399 @var{path} is the corresponding D-Bus object path, @var{service} is |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1400 registered at. It can also be @code{nil} if the path name of incoming |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1401 signals shall not be checked. |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1402 |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1403 @var{interface} is an interface offered by @var{service}. It must |
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1404 provide @var{signal}. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1405 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1406 @var{handler} is a Lisp function to be called when the @var{signal} is |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1407 received. It must accept as arguments the output parameters |
96646
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1408 @var{signal} is sending. |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1409 |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1410 All other arguments @var{args}, if specified, must be strings. They |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1411 stand for the respective arguments of @var{signal} in their order, and |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1412 are used for filtering as well. A @code{nil} argument might be used |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1413 to preserve the order. |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1414 |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1415 @code{dbus-register-signal} returns a Lisp object, which can be used |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1416 as argument in @code{dbus-unregister-object} for removing the |
5e58654e97ff
* dbus.texi (Receiving Method Calls): Fix description of
Michael Albinus <michael.albinus@gmx.de>
parents:
95937
diff
changeset
|
1417 registration for @var{signal}. Example: |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1418 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1419 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1420 (defun my-dbus-signal-handler (device) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1421 (message "Device %s added" device)) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1422 |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1423 @result{} my-dbus-signal-handler |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1424 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1425 (dbus-register-signal |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1426 :system "org.freedesktop.Hal" "/org/freedesktop/Hal/Manager" |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1427 "org.freedesktop.Hal.Manager" "DeviceAdded" |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1428 'my-dbus-signal-handler) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1429 |
87309
44eebe469b1f
* dbus.texi (Signals): Fix example in dbus-register-signal.
Michael Albinus <michael.albinus@gmx.de>
parents:
87158
diff
changeset
|
1430 @result{} ((:system "org.freedesktop.Hal.Manager" "DeviceAdded") |
44eebe469b1f
* dbus.texi (Signals): Fix example in dbus-register-signal.
Michael Albinus <michael.albinus@gmx.de>
parents:
87158
diff
changeset
|
1431 ("org.freedesktop.Hal" "/org/freedesktop/Hal/Manager" |
44eebe469b1f
* dbus.texi (Signals): Fix example in dbus-register-signal.
Michael Albinus <michael.albinus@gmx.de>
parents:
87158
diff
changeset
|
1432 my-signal-handler)) |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1433 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1434 |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1435 As we know from the introspection data of interface |
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1436 @samp{org.freedesktop.Hal.Manager}, the signal @samp{DeviceAdded} |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1437 provides one single parameter, which is mapped into a Lisp string. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1438 The callback function @code{my-dbus-signal-handler} must define one |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1439 single string argument therefore. Plugging an USB device to your |
96802
de3f169b53eb
* dbus.texi (Inspection): Rework, introduce submenus.
Michael Albinus <michael.albinus@gmx.de>
parents:
96646
diff
changeset
|
1440 machine, when registered for signal @samp{DeviceAdded}, will show you |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1441 which objects the GNU/Linux @code{hal} daemon adds. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1442 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1443 |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1444 @defun dbus-unregister-object object |
102151
328f4b370b74
Remove duplicate words.
Juanma Barranquero <lekktu@gmail.com>
parents:
102059
diff
changeset
|
1445 Unregister @var{object} from the D-Bus. @var{object} must be the |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1446 result of a preceding @code{dbus-register-signal} or |
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1447 @code{dbus-register-method} call. It returns @code{t} if @var{object} |
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1448 has been unregistered, @code{nil} otherwise. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1449 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1450 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1451 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1452 @node Errors and Events |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1453 @chapter Errors and events. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1454 @cindex errors |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1455 @cindex events |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1456 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1457 Input parameters of @code{dbus-call-method}, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1458 @code{dbus-call-method-non-blocking}, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1459 @code{dbus-call-method-asynchronously}, and |
87362
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
1460 @code{dbus-register-signal} are checked for correct D-Bus types. If |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
1461 there is a type mismatch, the Lisp error @code{wrong-type-argument} |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
1462 @code{D-Bus ARG} is raised. |
85cef0528c37
* dbus.texi (Type Conversion): Extend for D-Bus compound types.
Michael Albinus <michael.albinus@gmx.de>
parents:
87309
diff
changeset
|
1463 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1464 All errors raised by D-Bus are signaled with the error symbol |
87883
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1465 @code{dbus-error}. If possible, error messages from D-Bus are |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1466 appended to the @code{dbus-error}. |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1467 |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1468 @defspec dbus-ignore-errors forms@dots{} |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1469 This executes @var{forms} exactly like a @code{progn}, except that |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1470 @code{dbus-error} errors are ignored during the @var{forms}. These |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1471 errors can be made visible when variable @code{dbus-debug} is set to |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1472 @code{t}. |
af599a62c634
* dbus.texi (Errors and Events): New macro dbus-ignore-errors.
Michael Albinus <michael.albinus@gmx.de>
parents:
87585
diff
changeset
|
1473 @end defspec |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1474 |
87049
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1475 Incoming D-Bus messages are handled as Emacs events (see @pxref{Misc |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1476 Events, , , elisp}). The generated event has this form: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1477 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1478 @lisp |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1479 (dbus-event @var{bus} @var{type} @var{serial} @var{service} @var{path} @var{interface} @var{member} @var{handler} |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1480 &rest @var{args}) |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1481 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1482 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1483 @var{bus} identifies the D-Bus the message is coming from. It is |
87049
cbcfa9b4201e
* dbus.texi (Signals): Precise `dbus-register-signal'.
Michael Albinus <michael.albinus@gmx.de>
parents:
87004
diff
changeset
|
1484 either the symbol @code{:system} or the symbol @code{:session}. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1485 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1486 @var{type} is the D-Bus message type which has caused the event. It |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1487 can be @code{dbus-message-type-invalid}, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1488 @code{dbus-message-type-method-call}, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1489 @code{dbus-message-type-method-return}, |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1490 @code{dbus-message-type-error}, or @code{dbus-message-type-signal}. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1491 @var{serial} is the serial number of the received D-Bus message. |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1492 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1493 @var{service} and @var{path} are the unique name and the object path |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1494 of the D-Bus object emitting the message. @var{interface} and |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1495 @var{member} denote the message which has been sent. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1496 |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1497 @var{handler} is the callback function which has been registered for |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1498 this message (see @pxref{Signals}). When a @code{dbus-event} event |
87158
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1499 arrives, @var{handler} is called with @var{args} as arguments. |
f10e4cb7d001
* dbus.texi (Synchronous Methods): Adapt dbus-call-method.
Michael Albinus <michael.albinus@gmx.de>
parents:
87053
diff
changeset
|
1500 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1501 In order to inspect the @code{dbus-event} data, you could extend the |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1502 definition of the callback function in @ref{Signals}: |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1503 |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1504 @lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1505 (defun my-dbus-signal-handler (&rest args) |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1506 (message "my-dbus-signal-handler: %S" last-input-event)) |
91590
6834ec860aff
* dbus.texi (all): Wrap Lisp code examples with @lisp ... @end lisp.
Michael Albinus <michael.albinus@gmx.de>
parents:
87883
diff
changeset
|
1507 @end lisp |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1508 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1509 There exist convenience functions which could be called inside a |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1510 callback function in order to retrieve the information from the event. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1511 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1512 @defun dbus-event-bus-name event |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1513 Returns the bus name @var{event} is coming from. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1514 The result is either the symbol @code{:system} or the symbol @code{:session}. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1515 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1516 |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1517 @defun dbus-event-message-type event |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1518 Returns the message type of the corresponding D-Bus message. The |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1519 result is a number. |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1520 @end defun |
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1521 |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1522 @defun dbus-event-serial-number event |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1523 Returns the serial number of the corresponding D-Bus message. |
97163
48b3629e41d1
* dbus.texi (Arguments and Signatures): Fix example.
Michael Albinus <michael.albinus@gmx.de>
parents:
96802
diff
changeset
|
1524 The result is a number. |
87585
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1525 @end defun |
072778cd2f17
* dbus.texi (Receiving Method Calls): New chapter.
Michael Albinus <michael.albinus@gmx.de>
parents:
87540
diff
changeset
|
1526 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1527 @defun dbus-event-service-name event |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1528 Returns the unique name of the D-Bus object @var{event} is coming from. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1529 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1530 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1531 @defun dbus-event-path-name event |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1532 Returns the object path of the D-Bus object @var{event} is coming from. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1533 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1534 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1535 @defun dbus-event-interface-name event |
101617
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1536 Returns the interface name of the D-Bus object @var{event} is coming from. |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1537 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1538 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1539 @defun dbus-event-member-name event |
101617
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1540 Returns the member name of the D-Bus object @var{event} is coming |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1541 from. It is either a signal name or a method name. |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1542 @end defun |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1543 |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1544 D-Bus errors are not propagated during event handling, because it is |
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1545 usually not desired. D-Bus errors in events can be made visible by |
101523
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1546 setting the variable @code{dbus-debug} to @code{t}. They can also be |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1547 handled by a hook function. |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1548 |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1549 @defvar dbus-event-error-hooks |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1550 This hook variable keeps a list of functions, which are called when a |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1551 D-Bus error happens in the event handler. Every function must accept |
101617
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1552 two arguments, the event and the error variable catched in |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1553 @code{condition-case} by @code{dbus-error}. |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1554 |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1555 Such functions can be used the adapt the error signal to be raised. |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1556 Example: |
101523
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1557 |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1558 @lisp |
101617
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1559 (defun my-dbus-event-error-handler (event error) |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1560 (when (string-equal (concat dbus-service-emacs ".FileManager") |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1561 (dbus-event-interface-name event)) |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1562 (message "my-dbus-event-error-handler: %S %S" event error) |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1563 (signal 'file-error (cdr error)))) |
101523
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1564 |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1565 (add-hook 'dbus-event-error-hooks 'my-dbus-event-error-handler) |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1566 @end lisp |
7b5ca0afd795
* dbus.texi (Errors and Events): New variable dbus-event-error-hooks.
Michael Albinus <michael.albinus@gmx.de>
parents:
100974
diff
changeset
|
1567 @end defvar |
87491
dd7c58c2342a
* dbus.texi (all): Replace "..." by @dots{}.
Michael Albinus <michael.albinus@gmx.de>
parents:
87365
diff
changeset
|
1568 |
101617
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1569 Hook functions shall take into account, that there might be other |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1570 D-Bus applications running. Therefore, they shall check carefully, |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1571 whether a given D-Bus error is related to them. |
bb28e4b4c12c
* dbus.texi (Errors and Events): Fix typos. Describe second parameter
Michael Albinus <michael.albinus@gmx.de>
parents:
101523
diff
changeset
|
1572 |
86942
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1573 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1574 @node GNU Free Documentation License |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1575 @appendix GNU Free Documentation License |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1576 @include doclicense.texi |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1577 |
2fa0494ae318
* dbus.texi: New file.
Michael Albinus <michael.albinus@gmx.de>
parents:
diff
changeset
|
1578 @bye |
87053 | 1579 |
1580 @ignore | |
1581 arch-tag: 2eeec19d-0caf-44e0-a193-329d7f9951d8 | |
1582 @end ignore |