summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-05-29 09:07:06 +0000
committerMarcel Holtmann <marcel@holtmann.org>2008-05-29 09:07:06 +0000
commit74945e0c555beb42ffa5ca9d6c057cdfa2978802 (patch)
tree015db8d6b494aa75ca93565af7a86c0f56011acf
parentf0b4cc6f3b05f3ee1b963927acd5826ca99fa179 (diff)
Add first draft of new network API
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/network-api.txt40
2 files changed, 41 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index e060d254..82650503 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,5 @@
EXTRA_DIST = manager-api.txt adapter-api.txt device-api.txt agent-api.txt \
- serial-api.txt input-api.txt
+ serial-api.txt network-api.txt input-api.txt
MAINTAINERCLEANFILES = Makefile.in
diff --git a/doc/network-api.txt b/doc/network-api.txt
new file mode 100644
index 00000000..3aee9bac
--- /dev/null
+++ b/doc/network-api.txt
@@ -0,0 +1,40 @@
+BlueZ D-Bus Network API description
+***********************************
+
+Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org>
+
+
+Network hierarchy
+=================
+
+Service org.bluez
+Interface org.bluez.Network
+Object path /{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Methods void Connect()
+
+ Connect to the network device.
+
+ Possible errors: org.bluez.Error.AlreadyConnected
+ org.bluez.Error.ConnectionAttemptFailed
+
+ void CancelConnect()
+
+ Abort connection attempt in case of errors or
+ timeouts in the client.
+
+ Possible errors: org.bluez.Error.Failed
+
+ void Disconnect()
+
+ Disconnect from the network device.
+
+ Possible errors: org.bluez.Error.Failed
+
+ bool IsConnected()
+
+ Returns the connection status.
+
+Signals void Connected()
+
+ void Disconnected()