diff options
| author | Regis Merlino <regis.merlino@intel.com> | 2013-09-02 15:21:17 +0200 |
|---|---|---|
| committer | Mark Ryan <mark.d.ryan@intel.com> | 2013-09-06 12:17:40 +0200 |
| commit | 4d959b08882574b605b8dce48a1fb4d9bf2f7cee (patch) | |
| tree | d3c0388d03926c1f114d6b1815beaa78e41e6187 /doc | |
| parent | 8c460ff2e476eeb2b7e35471e97308652a0197f2 (diff) | |
| download | dleyna-server-4d959b08882574b605b8dce48a1fb4d9bf2f7cee.tar.gz | |
[Device] Deprecate LastChange in favor of Changed signal
Fix issue #109
* Remove LastChange signal
* Add Changed signal
* A Changed signal is emitted along with a ContainerUpdateID
signal when LastChange is not managed by the DLNA server.
Signed-off-by: Regis Merlino <regis.merlino@intel.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/server/dbus/API.txt | 82 |
1 files changed, 28 insertions, 54 deletions
diff --git a/doc/server/dbus/API.txt b/doc/server/dbus/API.txt index 9664ed9..378daf9 100644 --- a/doc/server/dbus/API.txt +++ b/doc/server/dbus/API.txt @@ -391,73 +391,47 @@ Signals: The com.intel.dLeynaServer.MediaDevice interface also exposes three signals. -LastChange (a(sv) StateEvent) +Changed (aa{sv} ChangedObjects) -The LastChange signal is generated by servers to provide precise information -of changes that have taken place to their content. LastChange is useful for +The Changed signal is generated by servers to provide precise information +of changes that have taken place to their content. Changed is useful for synchronisation controllers. It allows them to dynamically update their local -cache of the server's content. This signal contains an array of zero or more -elements, each of which represents a change to a specific object. -The value of each dictionary entry depends on the key value. +cache of the server's content. This signal contains an array of zero or more +dictionary elements, each of which represents a change to a specific object. +The dictionary is composed of the following keys: |------------------------------------------------------------------------------| -| Key values | R/O | Description | +| Key | Type | m/o | Description | |------------------------------------------------------------------------------| -| "ADD" | O | Indicates that an object has been added. | +| ChangeType | u | m | Contains the Type of the notification: | +| | | | 1 (ADD) an object has been added | +| | | | 2 (MOD) an object has been modified | +| | | | 3 (DEL) an object has been deleted | +| | | | 4 (DONE) an update to a sub-tree has | +| | | | completed | +| | | | 5 (CONTAINER) a container has been updated | |------------------------------------------------------------------------------| -| "MOD" | O | Indicates that an object has been modified. | +| Path | o | m | Contains the Object Path property of the | +| | | | object that was changed. | |------------------------------------------------------------------------------| -| "DEL" | O | Indicates that an object has been deleted | +| UpdateID | u | m | ContainerUpdateID or SystemUpdateID when the | +| | | | object was changed. | |------------------------------------------------------------------------------| -| "DONE" | O | Indicates that an update to a sub-tree has completed. | +| SubTreeUpdate | b | o | True if the object was added as part of a | +| | | | subtree update. | |------------------------------------------------------------------------------| - - -|------------------------------------------------------------------------------| -| Dictionary value for key "ADD": Format (oubos) | -|------------------------------------------------------------------------------| -| o | M | Contains the Object Path property of the object that was added. | -|------------------------------------------------------------------------------| -| u | M | Contains the value of the SystemUpdateID when the object was added. | -|------------------------------------------------------------------------------| -| b | M | True if the object was added as part of a subtree update | -|------------------------------------------------------------------------------| -| o | M | Contains the Object Path property of the parent container to which | -| | | this object was added. | -|------------------------------------------------------------------------------| -| s | M | Contains the value of the TypeEx (converted upnp:class property) | -| | | of the object that was added. | -|------------------------------------------------------------------------------| - -|------------------------------------------------------------------------------| -| Dictionary value for key "MOD": Format (oub) | -|------------------------------------------------------------------------------| -| o | M | Contains the Object Path property of the object that was modified. | +| Parent | o | o | Contains the Object Path property of the | +| | | | parent container of the changed object. | |------------------------------------------------------------------------------| -| u | M | Contains the value of the SystemUpdateID when the object was added. | +| TypeEx | s | o | Contains the value of the TypeEx property | +| | | | (converted upnp:class property) of the | +| | | | object that was changed. | |------------------------------------------------------------------------------| -| b | M | True if the object was modified as part of a subtree update | +| Type | s | o | Contains the value of the Type property | +| | | | (converted upnp:class property) of the object | +| | | | that was changed. | |------------------------------------------------------------------------------| -|------------------------------------------------------------------------------| -| Dictionary value for key "DEL": Format (oub) | -|------------------------------------------------------------------------------| -| o | M | Contains the Object Path property of the object that was deleted. | -|------------------------------------------------------------------------------| -| u | M | Contains the value of the SystemUpdateID when the object was added. | -|------------------------------------------------------------------------------| -| b | M | True if the object was deleted as part of a subtree update | -|------------------------------------------------------------------------------| - -|------------------------------------------------------------------------------| -| Dictionary value for key "DONE": Format (ou) | -|------------------------------------------------------------------------------| -| o | M | Contains the Object Path of the updated sub-tree | -|------------------------------------------------------------------------------| -| u | M | Contains the value of the SystemUpdateID when the object was added. | -|------------------------------------------------------------------------------| - - ContainerUpdateIDs(a(ou) ContainerPathsIDs) Is generated when the contents of one or more folders maintained by the |