fdo-mirrors/dbus
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/dbus/dbus.git synced 2026-05-05 07:38:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

spec: introduce new value "const" for EmitsChangedSignal annotation

Browse source 
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=72958
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
This commit is contained in:
Lennart Poettering 2013-12-22 02:35:13 +01:00 • committed by Simon McVittie
parent 6e53e972ce
commit e26d35c641
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/dbus-specification.xml
View file

@ -3950,7 +3950,7 @@
</row>
<row>
<entry>org.freedesktop.DBus.Property.EmitsChangedSignal</entry>
<entry>true,invalidates,false</entry>
<entry>true,invalidates,const,false</entry>
<entry>
<para>
If set to <literal>false</literal>, the
@ -3959,6 +3959,12 @@
linkend="standard-interfaces-properties"/> is not
guaranteed to be emitted if the property changes.
</para>
<para>
If set to <literal>const</literal> the property never
changes value during the lifetime of the object it
belongs to, and hence the signal is never emitted for
it.
</para>
<para>
If set to <literal>invalidates</literal> the signal
is emitted but the value is not included in the
@ -3975,6 +3981,17 @@
defaults to the value specified in the enclosing
interface element.
</para>
<para>
This annotation is intended to be used by code
generators to implement client-side caching of
property values. For all properties for which the
annotation is set to <literal>const</literal>,
<literal>invalidates</literal> or
<literal>true</literal> the client may
unconditionally cache the values as the properties
don't change or notifications are generated for them
if they do.
</para>
</entry>
</row>
</tbody>