diff options
author | Ludovic Ferrandis <ludovic.ferrandis@intel.com> | 2013-08-22 16:07:55 +0200 |
---|---|---|
committer | Regis Merlino <regis.merlino@intel.com> | 2013-08-22 17:28:58 +0200 |
commit | 90a4218d79c23cfa03e0111d9e7173c4fd9b84eb (patch) | |
tree | 0e272940e28e30d39f1a95bafc6dc09f7e361ad4 /doc | |
parent | 3a225c3ee9df5a9ce49e1987f65715d2c9ee8438 (diff) | |
download | dleyna-renderer-90a4218d79c23cfa03e0111d9e7173c4fd9b84eb.tar.gz |
[Network Filtering] Add Network Filtering support
Add 2 new settings:
1 - netf_enabled (boolean): To activate or deactivate the network filtering
2 - netf_entries (str list): List of supported network
Add org.freedesktop.DBus.Properties DBUS Interface to
com.intel.dLeynaRenderer.Manager root object.
Add 4 new methodes to com.intel.dLeynaRenderer.Manager interface
1 - WhiteListEnable
2 - WhiteListAddEntries
3 - WhiteListRemoveEntries
4 - WhiteListClear
Signed-off-by: Ludovic Ferrandis <ludovic.ferrandis@intel.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/server/dbus/API.txt | 44 |
1 files changed, 41 insertions, 3 deletions
diff --git a/doc/server/dbus/API.txt b/doc/server/dbus/API.txt index c5e3fe2..bfd2721 100644 --- a/doc/server/dbus/API.txt +++ b/doc/server/dbus/API.txt @@ -27,8 +27,9 @@ The Manager Object: ------------------- There is only ever a single instance of this object. The manager -object exposes a single d-Bus interface, -com.intel.dLeynaRenderer.Manager. +object exposes two d-Bus interfaces: +1 - com.intel.dLeynaServer.Manager. +2 - org.freedesktop.DBus.Properties. com.intel.dLeynaRenderer.Manager @@ -37,7 +38,7 @@ com.intel.dLeynaRenderer.Manager Methods: ---------- -The interface com.intel.dLeynaRenderer.Manager contains 3 +The interface com.intel.dLeynaRenderer.Manager contains 8 methods. Descriptions of each of these methods along with their d-Bus signatures are given below. @@ -71,6 +72,43 @@ discover new DMRs which for some reason were not detected when either they, or the device on which dLeyna-renderer runs, was started or joined the network. New in version 0.0.2. +WhiteListEnable(b enabled) -> void + +Enable or disable the Network Filtering feature. +When enabled, only devices that are on allowed networks will be available. + +WhiteListAddEntries(as EntryList) -> void + +Add new entries to the list of allowed networks. An Entry could be an interface +name (eth0), an ip address (127.0.0.1) or a SSID (MyWiFi) + +WhiteListRemoveEntries(as EntryList) -> void + +Remove entries from the list of allowed networks. + +WhiteListClear() -> void + +Remove all entries from the list, but it doesn't change the 'enabled' flag. + + +Properties: +--------- + +The com.intel.dLeynaRenderer.Manager interface exposes information via a number +of d-Bus properties. These properties are described below: + +|------------------------------------------------------------------------------| +| Name | Type |m/o*| Description | +|------------------------------------------------------------------------------| +| WhiteListEntries | as | m | The list of entries that compose the | +| | | | white list used to filter the networks. | +|------------------------------------------------------------------------------| +| WhiteListEnabled | b | m | True if the Network Filtering is active.| +|------------------------------------------------------------------------------| + +A org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted when +these properties change. + Signals: --------- |