summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
blob: 03b39a5c618789cb1253dff13e9e18baa100eafc (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
Manager hierarchy
*****************

Service name	org.moblin.connman
Interface name	org.moblin.connman.Manager
Object path	/

Methods		array{object} ListElements()
		void RegisterAgent(object path)
		void UnregisterAgent(object path)

Signals		ElementAdded(object)
		ElementRemoved(object)


Method: ListElements
====================
This method lists all available interfaces. The return value is an array of
object paths. Every attached network interface (eth0, wlan0 etc.) of the
system is presented by an object path with additional interfaces on it. The
main interface is org.freedesktop.connman.Interface.

Method: RegisterAgent
=====================
This method allows the user interace to register an agent. There can be only
one agent registered at a time. The parameter of the method is the object
path the agent has been registered for the callback method. The agent has
to implement org.moblin.connman.Agent interface on this object path.

Method: UnregisterAgent
=======================
This method unregisters a previously registered agent. In case the agent
application exits the core will automatically unregister the agent. However
for a clean agent application it is important to call the unregister method.

Signal: ElementAdded
====================
This signal is emitted every time a new element has been added by the
core and successfully activated. The signal is also emitted on startup
or at anytime at runtime in case of hotplug devices.

Signal: ElementRemoved
======================
This signal is emitted every time an element has been removed. This can
happen at any time in case of hotplug devices. When the system shuts down,
this signal is also emitted.