luadoc/dbus.lua

   1 --- awesome D-Bus API
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008-2009 Julien Danjou
   4 module("dbus")
   5
   6 --- Register a D-Bus name to receive message from.
   7 -- @param bus A string indicating if we are using system or session bus.
   8 -- @param name A string with the name of the D-Bus name to register.
   9 -- @return True if everything worked fine, false otherwise.
  10 -- @name request_name
  11 -- @class function
  12
  13 --- Release a D-Bus name.
  14 -- @param bus A string indicating if we are using system or session bus.
  15 -- @param name A string with the name of the D-Bus name to unregister.
  16 -- @return True if everything worked fine, false otherwise.
  17 -- @name release_name
  18 -- @class function
  19
  20 --- Add a match rule to match messages going through the message bus.
  21 -- @param bus A string indicating if we are using system or session bus.
  22 -- @param name A string with the name of the match rule.
  23 -- @name add_match
  24 -- @class function
  25
  26 --- Remove a previously added match rule "by value"
  27 -- (the most recently-added identical rule gets removed).
  28 -- @param bus A string indicating if we are using system or session bus.
  29 -- @param name A string with the name of the match rule.
  30 -- @name remove_match
  31 -- @class function
  32
  33 --- Add a signal receiver on the D-Bus.
  34 -- @param interface A string with the interface name.
  35 -- @param func The function to call.
  36 -- @name connect_signal
  37 -- @class function
  38
  39 --- Remove a signal receiver on the D-Bus.
  40 -- @param interface A string with the interface name.
  41 -- @param func The function to call.
  42 -- @name disconnect_signal
  43 -- @class function