summaryrefslogtreecommitdiffstats
path: root/network/network-api.txt
blob: c38b3e638d64e3066622fc9f71f8fec167d29df6 (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
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: TBD

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

			Possible errors: TBD

		array{string} ListServers()

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

		string CreateConnection(string address, string uuid)

			Creates a network connection object(NAP or GN).

		string RemoveConnection(string path)

			Removes a network connection object for a given path.

			Possible errors: TBD

		array{string} ListConnections()

			Returns an array of available network connections paths.

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()              // do this automatically?
		void Disable()             // do this automatically?
		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)
			TBD

		bool GetSecurity()
			TBD

Signals

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

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

Methods		string GetAddress()
			Returns the Bluetooth address of the ending point.

		string GetUUID()
			Returns the uuid 128 string representation of
			the connected service.

		string GetName()
			TBD

		string GetDescription()
			TBD

		string GetInterface()
			TBD

		void Connect()
			TBD

		void Disconnect()
			TBD

		bool IsConnected()
			Returns the connection status.

Signals