← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/bluez/intrepid

« back to all changes in this revision

Viewing changes to doc/network-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:
doc/network-api.txt
 
1
BlueZ D-Bus Network API description
 
2
***********************************
 
3
 
 
4
Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
 
5
 
 
6
 
 
7
Network hierarchy
 
8
=================
 
9
 
 
10
Service         org.bluez
 
11
Interface       org.bluez.Network
 
12
Object path     [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
 
13
 
 
14
Methods         string Connect(string uuid)
 
15
 
 
16
                        Connect to the network device and return the network
 
17
                        device name. Examples of the device name are bnep0,
 
18
                        bnep1 etc.
 
19
 
 
20
                        Possible errors: org.bluez.Error.AlreadyConnected
 
21
                                         org.bluez.Error.ConnectionAttemptFailed
 
22
 
 
23
                void Disconnect()
 
24
 
 
25
                        Disconnect from the network device.
 
26
 
 
27
                        To abort a connection attempt in case of errors or
 
28
                        timeouts in the client it is fine to call this method.
 
29
 
 
30
                        Possible errors: org.bluez.Error.Failed
 
31
 
 
32
                bool IsConnected() {deprecated}
 
33
 
 
34
                        Returns the connection status.
 
35
 
 
36
                dict GetProperties()
 
37
 
 
38
                        Returns all properties for the interface. See the
 
39
                        properties section for available properties.
 
40
 
 
41
Signals         void Connected(string device, string uuid) {deprecated}
 
42
 
 
43
                void Disconnected(string device) {deprecated}
 
44
 
 
45
                PropertyChanged(string name, variant value)
 
46
 
 
47
                        This signal indicates a changed value of the given
 
48
                        property.
 
49
 
 
50
Properties      boolean Connected [readonly]
 
51
 
 
52
                        Indicates if the device is connected.
 
53
 
 
54
                string Device [readonly]
 
55
 
 
56
                        Indicates the network interface name when available.
 
57
 
 
58
                string UUID [readonly]
 
59
 
 
60
                        Indicates the connection role when available.
 
61
 
 
62
 
 
63
Network Hub/Peer/Router hierarchy
 
64
=================
 
65
 
 
66
Service         org.bluez
 
67
Interface       org.bluez.network.{Hub, Peer, Router}
 
68
Object path     /org/bluez/{hci0,hci1,...}
 
69
 
 
70
Methods         dict GetProperties()
 
71
 
 
72
                        Returns all properties for the GN/PANU/NAP server. See the
 
73
                        properties section for available properties.
 
74
 
 
75
                void SetProperty(string name, variant value)
 
76
 
 
77
                        Changes the value of the specified property. Only
 
78
                        properties that are listed a read-write are changeable.
 
79
                        On success this will emit a PropertyChanged signal.
 
80
 
 
81
                        Possible Errors: org.bluez.Error.DoesNotExist
 
82
                                         org.bluez.Error.InvalidArguments
 
83
 
 
84
Properties      string Name[readwrite]
 
85
 
 
86
                        The Bluetooth network server name.
 
87
 
 
88
                boolean Enable[readwrite]
 
89
 
 
90
                        Indicates if the server is Enabled/Disabled.
 
91
 
 
92
                string Uuid[readonly]
 
93
 
 
94
                        The Bluetooth network server UUID 128 identification.