summaryrefslogtreecommitdiff
path: root/doc/connection-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-11-26 19:59:08 +0100
committerMarcel Holtmann <marcel@holtmann.org>2008-11-26 19:59:08 +0100
commit9a1f19ccb4b1511e7b59d2c7f90434520bbfa943 (patch)
tree426fa9278c9886e8435c2bbda2cf31c495c82d55 /doc/connection-api.txt
parentdedfd9fbeb5f437c51d3fa5ba7798f45415173e7 (diff)
downloadconnman-9a1f19ccb4b1511e7b59d2c7f90434520bbfa943.tar.gz
connman-9a1f19ccb4b1511e7b59d2c7f90434520bbfa943.tar.bz2
connman-9a1f19ccb4b1511e7b59d2c7f90434520bbfa943.zip
Add first draft of Connection interface API
Diffstat (limited to 'doc/connection-api.txt')
-rw-r--r--doc/connection-api.txt30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/connection-api.txt b/doc/connection-api.txt
new file mode 100644
index 00000000..9b6040db
--- /dev/null
+++ b/doc/connection-api.txt
@@ -0,0 +1,30 @@
+Connection hierarchy
+====================
+
+Service org.moblin.connman
+Interface org.moblin.connman.Connection
+Object path [variable prefix]/{connection0,connection1,...}
+
+Methods dict GetProperties()
+
+ Returns properties for the connection object. See
+ the properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.DoesNotExist
+
+Signals PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties string IPv4.Method [readonly]
+
+ Indicates the way how the IPv4 settings were
+ configured. Possible values here are "dhcp"
+ and "static".
+
+ string IPv4.Address [readonly]
+
+ Shows the current configured IPv4 address.
+ \ No newline at end of file