~ubuntu-branches/ubuntu/wily/bluez/wily

« back to all changes in this revision

Viewing changes to doc/service-api.txt

  • Committer: Bazaar Package Importer
  • Author(s): Mario Limonciello
  • Date: 2008-10-07 12:10:29 UTC
  • Revision ID: james.westby@ubuntu.com-20081007121029-4gup4fmmh2vfo5nh
Tags: upstream-4.12
ImportĀ upstreamĀ versionĀ 4.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
BlueZ D-Bus Adapter API description
 
2
***********************************
 
3
 
 
4
Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
 
5
Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>
 
6
Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br>
 
7
Copyright (C) 2006-2007  Luiz von Dentz <luiz.dentz@indt.org.br>
 
8
 
 
9
 
 
10
Service hierarchy
 
11
=================
 
12
 
 
13
Service         org.bluez
 
14
Interface       org.bluez.Service
 
15
Object path     [variable prefix]/{hci0,hci1,...}
 
16
 
 
17
Methods         uint32 AddRecord(string record)
 
18
 
 
19
                        Adds a new service record from the XML description
 
20
                        and returns the assigned record handle.
 
21
 
 
22
                        Possible errors: org.bluez.Error.InvalidArguments
 
23
                                         org.bluez.Error.Failed
 
24
 
 
25
                void UpdateRecord(uint32 handle, string record)
 
26
 
 
27
                        Updates a given service record provided in the
 
28
                        XML format.
 
29
 
 
30
                        Possible errors: org.bluez.Error.InvalidArguments
 
31
                                         org.bluez.Error.NotAvailable
 
32
                                         org.bluez.Error.Failed
 
33
 
 
34
                void RemoveRecord(uint32 handle)
 
35
 
 
36
                        Remove a service record identified by its handle.
 
37
 
 
38
                        It is only possible to remove service records that
 
39
                        where added by the current connection.
 
40
 
 
41
                        Possible errors: org.bluez.Error.InvalidArguments
 
42
                                         org.bluez.Error.NotAuthorized
 
43
                                         org.bluez.Error.DoesNotExist
 
44
                                         org.bluez.Error.Failed
 
45
 
 
46
                void RequestAuthorization(string address, uint32 handle)
 
47
 
 
48
                        Request an authorization for an incoming connection
 
49
                        for a specific service record. The service record
 
50
                        needs to be registered via AddRecord first.
 
51
 
 
52
                        Possible errors: org.bluez.Error.InvalidArguments
 
53
                                         org.bluez.Error.NotAuthorized
 
54
                                         org.bluez.Error.DoesNotExist
 
55
                                         org.bluez.Error.Failed
 
56
 
 
57
                void CancelAuthorization()
 
58
 
 
59
                        Possible errors: org.bluez.Error.InvalidArguments
 
60
                                         org.bluez.Error.NotAuthorized
 
61
                                         org.bluez.Error.DoesNotExist
 
62
                                         org.bluez.Error.Failed