1DBUS-TEST-TOOL(1) User Commands DBUS-TEST-TOOL(1)
2
3
4
6 dbus-test-tool - D-Bus traffic generator and test tool
7
9 dbus-test-tool black-hole [--session | --system] [--name=NAME]
10 [--no-read]
11
12 dbus-test-tool echo [--session | --system] [--name=NAME]
13 [--sleep-ms=MS]
14
15 dbus-test-tool spam [--session | --system] [--dest=NAME] [--count=N]
16 [--flood] [--ignore-errors] [--messages-per-conn=N]
17 [--no-reply] [--queue=N] [--seed=SEED] [--string |
18 --bytes | --empty] [--payload=S | --stdin |
19 --message-stdin | --random-size]
20
22 dbus-test-tool is a multi-purpose tool for debugging and profiling
23 D-Bus.
24
25 dbus-test-tool black-hole connects to D-Bus, optionally requests a
26 name, then does not reply to messages. It normally reads and discards
27 messages from its D-Bus socket, but can be configured to sleep forever
28 without reading.
29
30 dbus-test-tool echo connects to D-Bus, optionally requests a name, then
31 sends back an empty reply to every method call, after an optional
32 delay.
33
34 dbus-test-tool spam connects to D-Bus and makes repeated method calls,
35 normally named com.example.Spam.
36
38 Common options
39 --session
40 Connect to the session bus. This is the default.
41
42 --system
43 Connect to the system bus.
44
45 black-hole mode
46 --name=NAME
47 Before proceeding, request ownership of the well-known bus name
48 NAME, for example com.example.NoReply. By default, no name is
49 requested, and the tool can only be addressed by a unique bus name
50 such as :1.23.
51
52 --no-read
53 Do not read from the D-Bus socket.
54
55 echo mode
56 --name=NAME
57 Before proceeding, request ownership of the well-known bus name
58 NAME, for example com.example.Echo. By default, no name is
59 requested, and the tool can only be addressed by a unique bus name
60 such as :1.23.
61
62 --sleep-ms=MS
63 Block for MS milliseconds before replying to a method call.
64
65 spam mode
66 --dest=NAME
67 Send method calls to the well-known or unique bus name NAME. The
68 default is the dbus-daemon, org.freedesktop.DBus.
69
70 --count=N
71 Send N method calls in total. The default is 1.
72
73 --queue=N
74 Send N method calls before waiting for any replies, then send one
75 new call per reply received, keeping N method calls "in flight" at
76 all times until the number of messages specified with the --count
77 option have been sent. The default is 1, unless --flood is used.
78
79 --flood
80 Send all messages without waiting for a reply, equivalent to
81 --queue with an arbitrarily large N.
82
83 --no-reply
84 Set the "no reply desired" flag on the messages. This implies
85 --flood, since it disables the replies that would be used for a
86 finite --queue length.
87
88 --messages-per-conn=N
89 If given, send N method calls on the same connection, then
90 disconnect and reconnect. The default is to use the same connection
91 for all method calls.
92
93 --string
94 The payload of each message is a UTF-8 string. This is the default.
95 The actual string used is given by the --payload or --stdin option,
96 defaulting to "hello, world!".
97
98 --bytes
99 The payload of each message is a byte-array. The actual bytes used
100 are given by the --payload or --stdin option, defaulting to the
101 ASCII encoding of "hello, world!".
102
103 --empty
104 The messages have no payload.
105
106 --payload=S
107 Use S as the --string or --bytes in the messages. The default is
108 "hello, world!".
109
110 --stdin
111 Read from standard input until end-of-file is reached, and use that
112 as the --string or --bytes in the messages.
113
114 --message-stdin
115 Read a complete binary D-Bus method call message from standard
116 input, and use that for each method call.
117
118 --random-size
119 Read whitespace-separated ASCII decimal numbers from standard
120 input, choose one at random for each message, and send a message
121 whose payload is a string of that length.
122
123 --seed=SEED
124 Use SEED as the seed for the pseudorandom number generator, to have
125 somewhat repeatable sequences of random messages.
126
128 Please send bug reports to the D-Bus bug tracker or mailing list. See
129 http://www.freedesktop.org/software/dbus/.
130
132 dbus-send(1)
133
135 Copyright © 2015 Collabora Ltd.
136
137 This man page is distributed under the same terms as dbus-test-tool
138 (GPL-2+). There is NO WARRANTY, to the extent permitted by law.
139
140
141
142
143D-Bus 1.14.0 03/10/2022 DBUS-TEST-TOOL(1)