summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
diff options
context:
space:
mode:
authorGustavo F. Padovan <padovan@profusion.mobi>2011-04-20 14:41:18 +0200
committerSamuel Ortiz <sameo@linux.intel.com>2011-04-20 15:18:56 +0200
commitabb0215152df00c6556cf6ba0b99686f895d2d9c (patch)
treecbb6e656199c2eebd9f512eddd3d7602ba71c368 /doc/manager-api.txt
parent2f57ae0efc03b1a752470de7e19f538d18e57469 (diff)
downloadconnman-abb0215152df00c6556cf6ba0b99686f895d2d9c.tar.gz
connman-abb0215152df00c6556cf6ba0b99686f895d2d9c.tar.bz2
connman-abb0215152df00c6556cf6ba0b99686f895d2d9c.zip
doc: Add PrivateNetwork interface.
By now PrivateNetwork interface will cover the DUN server case.
Diffstat (limited to 'doc/manager-api.txt')
-rw-r--r--doc/manager-api.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index c247d9f4..56fb832b 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -189,6 +189,31 @@ Methods dict GetProperties()
If an application exits unexpectatly the session
will be automatically destroyed.
+ fd, dict {settings} RequestPrivateNetwork(dict options)
+ [experimental]
+
+ Request a new Private Network, whick includes the
+ creation of a tun/tap interface, and IP
+ configuration, NAT and IP forwarding on that
+ interface.
+ A file descritor to the interface is returned together
+ with the IP, gateway and DNS settings for the
+ interface.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.NotSupported
+
+ void ReleasePrivateNetwork(fd) [experimental]
+
+ Releases a private network.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+Signals PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
StateChanged(string state)
This signal is similar to the PropertyChanged signal