summaryrefslogtreecommitdiffstats
path: root/doc/network-api.txt
blob: 8517171175f72babdf2ed3fcf3d7b3694a2e1eba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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		string Connect(string uuid)

			Connect to the network device and return the network
			device name. Examples of the device name are bnep0,
			bnep1 etc.

			Possible errors: org.bluez.Error.AlreadyConnected
					 org.bluez.Error.ConnectionAttemptFailed

		void Disconnect()

			Disconnect from the network device.

			To abort a connection attempt in case of errors or
			timeouts in the client it is fine to call this method.

			Possible errors: org.bluez.Error.Failed

		bool IsConnected()

			Returns the connection status.

Signals		void Connected(string device, string uuid)

		void Disconnected(string device)


Network Hub/Peer/Router hierarchy
=================

Service		org.bluez
Interface	org.bluez.network.{Hub, Peer, Router}
Object path	/org/bluez/{hci0,hci1,...}

Methods		dict GetProperties()

			Returns all properties for the GN/PANU/NAP server. See the
			properties section for available properties.

		void SetProperty(string name, variant value)

			Changes the value of the specified property. Only
			properties that are listed a read-write are changeable.
			On success this will emit a PropertyChanged signal.

			Possible Errors: org.bluez.Error.DoesNotExist
					 org.bluez.Error.InvalidArguments

Properties	string Name[readwrite]

			The Bluetooth network server name.

		boolean Enable[readwrite]

			Indicates if the server is Enabled/Disabled.

		string Uuid[readonly]

			The Bluetooth network server UUID 128 identification.