git.maemo.org Git - connman/blob - doc/manager-api.txt

   1 Manager hierarchy
   2 *****************
   3
   4 Service name    org.freedesktop.connman
   5 Interface name  org.freedesktop.connman.Manager
   6 Object path     /
   7
   8 Methods         array{object} ListInterfaces()
   9                 void RegisterAgent(object path)
  10                 void UnregisterAgent(object path)
  11
  12 Signals         InterfaceAdded(object)
  13                 InterfaceRemoved(object)
  14
  15
  16 Method: ListInferfaces
  17 ======================
  18 This method lists all available interfaces. The return value is an array of
  19 object paths. Every attached network interface (eth0, wlan0 etc.) of the
  20 system is presented by an object path with additional interfaces on it. The
  21 main interface is org.freedesktop.connman.Interface.
  22
  23 Method: RegisterAgent
  24 =====================
  25 This method allows the user interace to register an agent. There can be only
  26 one agent registered at a time. The parameter of the method is the object
  27 path the agent has been registered for the callback method. The agent has
  28 to implement org.freedesktop.connman.Agent interface on this object path.
  29
  30 Method: UnregisterAgent
  31 =======================
  32 This method unregisters a previously registered agent. In case the agent
  33 application exits the core will automatically unregister the agent. However
  34 for a clean agent application it is important to call the unregister method.
  35
  36 Signal: InterfaceAdded
  37 ======================
  38 This signal is emitted every time a new interface has been found by the
  39 core and successfully activated. The signal is also emitted on startup
  40 or at anytime at runtime in case of hotplug devices.
  41
  42 Signal: InterfaceRemoved
  43 ========================
  44 This signal is emitted every time an interface has been removed. This can
  45 happen at any time in case of hotplug devices. When the system shuts down,
  46 this signal is also emitted.
  47