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                 string GetState()
  10                 void RegisterAgent(object path)
  11                 void UnregisterAgent(object path)
  12
  13 Signals         InterfaceAdded(object)
  14                 InterfaceRemoved(object)
  15                 StateChanged(string state)
  16
  17
  18 Method: ListInferfaces
  19 ======================
  20 This method lists all available interfaces. The return value is an array of
  21 object paths. Every attached network interface (eth0, wlan0 etc.) of the
  22 system is presented by an object path with additional interfaces on it. The
  23 main interface is org.freedesktop.connman.Interface.
  24
  25 Method: GetState
  26 ================
  27 This method gets the overall master state of the Internet connection. Possible
  28 return values are "offline" and "online". If at least one interface is
  29 connected it will return "online".
  30
  31 Method: RegisterAgent
  32 =====================
  33 This method allows the user interace to register an agent. There can be only
  34 one agent registered at a time. The parameter of the method is the object
  35 path the agent has been registered for the callback method. The agent has
  36 to implement org.freedesktop.connman.Agent interface on this object path.
  37
  38 Method: UnregisterAgent
  39 =======================
  40 This method unregisters a previously registered agent. In case the agent
  41 application exits the core will automatically unregister the agent. However
  42 for a clean agent application it is important to call the unregister method.
  43
  44 Signal: InterfaceAdded
  45 ======================
  46 This signal is emitted every time a new interface has been found by the
  47 core and successfully activated. The signal is also emitted on startup
  48 or at anytime at runtime in case of hotplug devices.
  49
  50 Signal: InterfaceRemoved
  51 ========================
  52 This signal is emitted every time an interface has been removed. This can
  53 happen at any time in case of hotplug devices. When the system shuts down,
  54 this signal is also emitted.
  55
  56 Signal: StateChanged
  57 ====================
  58 This signal is emitted every time the master state changes. Possible values
  59 are "offline" and "online" and reflect the state of the Internet connection.