diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-03-13 18:45:08 +0000 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-03-13 18:45:08 +0000 |
| commit | 07041f5a50955742a8cd160f466b75d5b9c2005c (patch) | |
| tree | 68950db2620dd80f00166436360fb445dde3b0bc | |
| parent | 8369d15ca8f1ceda30adb5c488c6c982a9f5c3f0 (diff) | |
Add documention for manager API
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/manager-api.txt | 51 |
2 files changed, 52 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 3b7bd904..8af862e8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = adapter-api.txt device-api.txt agent-api.txt +EXTRA_DIST = manager-api.txt adapter-api.txt device-api.txt agent-api.txt MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/manager-api.txt b/doc/manager-api.txt new file mode 100644 index 00000000..b62e6dfb --- /dev/null +++ b/doc/manager-api.txt @@ -0,0 +1,51 @@ +BlueZ D-Bus Manager API description +*********************************** + +Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com> +Copyright (C) 2005-2006 Claudio Takahasi <claudio.takahasi@indt.org.br> +Copyright (C) 2006-2007 Luiz von Dentz <luiz.dentz@indt.org.br> + + +Manager hierarchy +================= + +Service org.bluez +Interface org.bluez.Manager +Object path /org/bluez + +Methods string DefaultAdapter() + + Returns object path for the default adapter. + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.NoSuchAdapter + + string FindAdapter(string pattern) + + Returns object path for the specified adapter. Valid + patterns are "hci0" or "00:11:22:33:44:55". + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.NoSuchAdapter + + array{string} ListAdapters() + + Returns list of adapter object paths under /org/bluez + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.Failed + org.bluez.Error.OutOfMemory + +Signals void AdapterAdded(string path) + + Parameter is object path of added adapter. + + void AdapterRemoved(string path) + + Parameter is object path of removed adapter. + + void DefaultAdapterChanged(string path) + + Parameter is object path of the new default adapter, + or an empty string if there is no available adapters. |