summaryrefslogtreecommitdiffstats
path: root/network/network-api.txt
blob: 278ba8eb7efd0a7c837047a3dda2f3e498a26de1 (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
Bluetooth network service API description
*****************************************

Copyright (C) 2006-2007  Marcel Holtmann <marcel@holtmann.org>


Network Manager hierarchy
=========================

Interface	org.bluez.network.Manager
Object path	/org/bluez/network

Methods		string CreateServer(string uuid)

			Creates a network server object (GN or NAP).

			Possible errors: org.bluez.network.Error.AlreadyExists
			                 org.bluez.network.Error.NotSupported
			                 org.bluez.network.Error.ConnectionAttemptFailed
			                 org.bluez.network.Error.Failed

		void RemoveServer(string path)
			Removes the network server object for given path.

			Possible errors: org.bluez.network.Error.DoesNotExist
			                 org.bluez.network.Error.Failed

		array{string} ListServers()

			Returns an array of available network devices paths.
			Currently only NAP and GN are supported.

		string FindServer(string pattern)

			Returns server path.

			Possible errors: org.bluez.network.Error.DoesNotExist
			                 org.bluez.network.Error.Failed

		string CreateConnection(string address, string uuid)

			Creates a network connection object(NAP or GN).

			Possible errors: org.bluez.network.Error.AlreadyExists
			                 org.bluez.network.Error.NotSupported
			                 org.bluez.network.Error.ConnectionAttemptFailed
			                 org.bluez.network.Error.Failed

		void RemoveConnection(string path)

			Removes a network connection object for a given path.

			Possible errors:org.bluez.network.Error.DoesNotExist
					org.bluez.network.Error.Failed

		array{string} ListConnections()

			Returns an array of available network connections paths.

		string FindConnection(string pattern)

			Returns connection path.

			Possible errors:org.bluez.network.Error.DoesNotExist
					org.bluez.network.Error.Failed

Signals

		void ServerCreated(string path)

		void ServerRemoved(string path)

		void ConnectionCreated(string path)

		void ConnectionRemoved(string path)


Network Server hierarchy (experimental)
=======================================

Interface	org.bluez.network.Server
Object path	/org/bluez/network/server*

Methods		string GetUUID()

			Returns the UUID-128 string representation of
			the server.

		void Enable()

			Enable server and updates service record.

			Possible errors: org.bluez.network.Error.AlreadyExists
			                 org.bluez.network.Error.Failed

		void Disable()

			Disable server and remove service record.

			Possible errors: org.bluez.network.Error.Failed

		void SetName(string name)

			Sets the name attribute.

		string GetName()

			Returns the service name.

		void SetAddressRange(string start, string end)

			TBD

		void SetRouting(string interface)

			TBD

		void SetSecurity(bool enable)

			Enable or disable encryption.

		bool GetSecurity()

			Returns server encryption.

		dict GetInfo()

			Returns the server properties.


Signals		void Enabled()

		void Disabled()


Network Connection hierarchy (experimental)
===========================================

Interface	org.bluez.network.Connection
Object path	/org/bluez/network/connection*

Methods		string GetAdapter()

			Returns the Bluetooth address of the adapter.

		string GetAddress()

			Returns the Bluetooth address of the ending point.

		string GetUUID()

			Returns the uuid 128 string representation of
			the connected service.

		string GetName()

			Returns the string representation of connected host.

			Possible errors: org.bluez.network.Error.Failed

		string GetDescription()

			Returns the string description of connected host.

			Possible errors: org.bluez.network.Error.Failed

		string GetInterface()

			Returns the string network interface.

			Possible errors: org.bluez.network.Error.Failed

		string Connect()

			Connects to host and return the network interface
			created.

			Possible errors: org.bluez.network.Error.ConnectionAttemptFailed
			                 org.bluez.network.Error.Failed

		string CancelConnect()

			Abort connection attempt in case of errors or
			timeouts in the client.

		void Disconnect()

			Disconnects to host.

			Possible errors: org.bluez.network.Error.Failed

		bool IsConnected()

			Returns the connection status.

		dict GetInfo()

			Returns the connection properties.

Signals		void Connected()

		void Disconnected()