diff options
| author | Lennart Poettering <lennart@poettering.net> | 2013-12-22 02:35:13 +0100 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2014-10-13 13:56:56 +0100 |
| commit | e26d35c641d9a14c488d104ea9ca514ed88b76a1 (patch) | |
| tree | 9be0095093a81be725dac71c4b27dadc7c2018ed /doc | |
| parent | 6e53e972cef404d0e2c01e9674ef6c15324c88ee (diff) | |
| download | dbus-e26d35c641d9a14c488d104ea9ca514ed88b76a1.tar.gz | |
spec: introduce new value "const" for EmitsChangedSignal annotation
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=72958
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dbus-specification.xml | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index 2b8d1f50..71a8987d 100644 --- a/doc/dbus-specification.xml +++ b/doc/dbus-specification.xml @@ -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 @@ -3960,6 +3960,12 @@ 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 signal. @@ -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> |