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

« back to all changes in this revision

Viewing changes to doc/network-api.txt

ImportĀ upstreamĀ versionĀ 4.81

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
BlueZ D-Bus Network API description
2
2
***********************************
3
3
 
4
 
Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
 
4
Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>
5
5
 
6
6
 
7
7
Network hierarchy
14
14
Methods         string Connect(string uuid)
15
15
 
16
16
                        Connect to the network device and return the network
17
 
                        device name. Examples of the device name are bnep0,
18
 
                        bnep1 etc.
 
17
                        interface name. Examples of the interface name are
 
18
                        bnep0, bnep1 etc.
 
19
 
 
20
                        uuid can be either one of "gn", "panu" or "nap" (case
 
21
                        insensitive) or a traditional string representation of
 
22
                        UUID or a hexadecimal number.
 
23
 
 
24
                        The connection will be closed and network device
 
25
                        released either upon calling Disconnect() or when
 
26
                        the client disappears from the message bus.
19
27
 
20
28
                        Possible errors: org.bluez.Error.AlreadyConnected
21
29
                                         org.bluez.Error.ConnectionAttemptFailed
43
51
 
44
52
                        Indicates if the device is connected.
45
53
 
46
 
                string Device [readonly]
 
54
                string Interface [readonly]
47
55
 
48
56
                        Indicates the network interface name when available.
49
57
 
52
60
                        Indicates the connection role when available.
53
61
 
54
62
 
55
 
Network Hub/Peer/Router hierarchy
56
 
=================
 
63
Network server hierarchy
 
64
========================
57
65
 
58
66
Service         org.bluez
59
 
Interface       org.bluez.network.{Hub, Peer, Router}
 
67
Interface       org.bluez.NetworkServer
60
68
Object path     /org/bluez/{hci0,hci1,...}
61
69
 
62
 
Methods         dict GetProperties()
63
 
 
64
 
                        Returns all properties for the GN/PANU/NAP server. See the
65
 
                        properties section for available properties.
66
 
 
67
 
                void SetProperty(string name, variant value)
68
 
 
69
 
                        Changes the value of the specified property. Only
70
 
                        properties that are listed a read-write are changeable.
71
 
                        On success this will emit a PropertyChanged signal.
72
 
 
73
 
                        Possible Errors: org.bluez.Error.DoesNotExist
74
 
                                         org.bluez.Error.InvalidArguments
75
 
 
76
 
Properties      string Name[readwrite]
77
 
 
78
 
                        The Bluetooth network server name.
79
 
 
80
 
                boolean Enable[readwrite]
81
 
 
82
 
                        Indicates if the server is Enabled/Disabled.
83
 
 
84
 
                string Uuid[readonly]
85
 
 
86
 
                        The Bluetooth network server UUID 128 identification.
 
70
Methods         void Register(string uuid, string bridge)
 
71
 
 
72
                        Register server for the provided UUID. Every new
 
73
                        connection to this server will be added the bridge
 
74
                        interface.
 
75
 
 
76
                        Valid UUIDs are "gn", "panu" or "nap".
 
77
 
 
78
                        Initially no network server SDP is provided. Only
 
79
                        after this method a SDP record will be available
 
80
                        and the BNEP server will be ready for incoming
 
81
                        connections.
 
82
 
 
83
                void Unregister(string uuid)
 
84
 
 
85
                        Unregister the server for provided UUID.
 
86
 
 
87
                        All servers will be automatically unregistered when
 
88
                        the calling application terminates.