aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib/dbus-menu.xml
diff options
context:
space:
mode:
authorCharles Kerr <charles.kerr@canonical.com>2012-04-04 14:16:32 -0500
committerCharles Kerr <charles.kerr@canonical.com>2012-04-04 14:16:32 -0500
commit1e1e26ee7c7e8f353f748ad3691de5a8f546ca23 (patch)
tree7c7d475a09b68dcd265bf9c47654a0b2a057c986 /libdbusmenu-glib/dbus-menu.xml
parent72c1f1c6b9f169dff5f70be3c7fcaac570254508 (diff)
parent70c8f8431d70481b8fcf90787f6987250ad84889 (diff)
downloadlibdbusmenu-1e1e26ee7c7e8f353f748ad3691de5a8f546ca23.tar.gz
libdbusmenu-1e1e26ee7c7e8f353f748ad3691de5a8f546ca23.tar.bz2
libdbusmenu-1e1e26ee7c7e8f353f748ad3691de5a8f546ca23.zip
Merge lp:~ted/dbusmenu/event-grouping to reduce the number of dbus messages that hud-service sends.
This change takes all of the events on a client and puts them into single dbus messages to be sent to the server. It also does the same thing for about-to-show messages. Both sets of messages are reserialized on either side to make callers unable to notice the difference.
Diffstat (limited to 'libdbusmenu-glib/dbus-menu.xml')
-rw-r--r--libdbusmenu-glib/dbus-menu.xml46
1 files changed, 46 insertions, 0 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml
index 4b5a5d8..de6868c 100644
--- a/libdbusmenu-glib/dbus-menu.xml
+++ b/libdbusmenu-glib/dbus-menu.xml
@@ -326,6 +326,26 @@ License version 3 and version 2.1 along with this program. If not, see
</arg>
</method>
+ <method name="EventGroup">
+ <dox:d>
+ Used to pass a set of events as a single message for possibily several
+ different menuitems. This is done to optimize DBus traffic.
+ </dox:d>
+ <arg type="a(isvu)" name="events" direction="in">
+ <dox:d>
+ An array of all the events that should be passed. This tuple should
+ match the parameters of the 'Event' signal. Which is roughly:
+ id, eventID, data and timestamp.
+ </dox:d>
+ </arg>
+ <arg type="ai" name="idErrors" direction="out">
+ <dox:d>
+ I list of menuitem IDs that couldn't be found. If none of the ones
+ in the list can be found, a DBus error is returned.
+ </dox:d>
+ </arg>
+ </method>
+
<method name="AboutToShow">
<dox:d>
This is called by the applet to notify the application that it is about
@@ -343,6 +363,32 @@ License version 3 and version 2.1 along with this program. If not, see
</arg>
</method>
+ <method name="AboutToShowGroup">
+ <dox:d>
+ A function to tell several menus being shown that they are about to
+ be shown to the user. This is likely only useful for programitc purposes
+ so while the return values are returned, in general, the singular function
+ should be used in most user interacation scenarios.
+ </dox:d>
+ <arg type="ai" name="ids" direction="in">
+ <dox:d>
+ The IDs of the menu items who's submenus are being shown.
+ </dox:d>
+ </arg>
+ <arg type="ai" name="updatesNeeded" direction="out">
+ <dox:d>
+ The IDs of the menus that need updates. Note: if no update information
+ is needed the DBus message should set the no reply flag.
+ </dox:d>
+ </arg>
+ <arg type="ai" name="idErrors" direction="out">
+ <dox:d>
+ I list of menuitem IDs that couldn't be found. If none of the ones
+ in the list can be found, a DBus error is returned.
+ </dox:d>
+ </arg>
+ </method>
+
<!-- Signals -->
<signal name="ItemsPropertiesUpdated">
<dox:d>