doc/peer-api.txt

   1 Peer hierarchy [EXPERIMENTAL]
   2 =============================
   3
   4 Service         net.connman
   5 Interface       net.connman.Peer
   6 Object path     [variable prefix]/{peer0,peer1,...}
   7
   8 Methods         dict GetProperties() [deprecated]
   9
  10                         Returns properties for the peer object. See the
  11                         properties sections for available properties.
  12
  13                         Usage of this method is highly discouraged. Use
  14                         the Manager.GetPeers() method instead.
  15
  16                         Possible Errors: [service].Error.InvalidArguments
  17
  18                 void Connect() [experimental]
  19
  20                         Connect this peer.
  21
  22                         This method call will only return in case of an error
  23                         or when the peer is fully connected. So setting a
  24                         longer D-Bus timeout might be a really good idea.
  25
  26                         Possible Errors: [service].Error.InvalidArguments
  27
  28                 void Disconnect() [experimental]
  29
  30                         Disconnect this peer. If the peer is not connected, an
  31                         error message will be generated.
  32
  33                         Possible Errors: [service].Error.InvalidArguments
  34
  35 Signals         PropertyChanged(string name, variant value) [experimental]
  36
  37                         This signal indicates a changed value of the given
  38                         property.
  39
  40 Properties      string State [readonly] [experimental]
  41
  42                         The peer state information.
  43
  44                         Valid state are "idle", "failure", "association",
  45                         "configuration", "ready" and "disconnect".
  46
  47                 string Name [readonly] [experimental]
  48
  49                         Name of the peer.
  50
  51                 dict IPv4 [readonly] [experimental]
  52
  53                         string Local [readonly]
  54
  55                                 The current peer's local configured IPv4
  56                                 address.
  57
  58                         string Remote [readonly]
  59
  60                                 The current peer's remote configured IPv4
  61                                 address.
  62
  63                 array{dict} Services [readonly] [experimental]
  64
  65                         Array of P2P service specifications consisting of
  66                         either UpnpService and UpnpVersion or BonjourQuery
  67                         and BonjourResponse, but not a mix of these. The
  68                         dict members have the following format:
  69
  70                         String UpnpService [readonly]
  71
  72                                 The UPNP service URI.
  73
  74                         int32 UpnpVersion [readonly]
  75
  76                                 The UPNP version in use.
  77
  78                         array{byte} BonjourQuery [readonly]
  79
  80                                 The bonjour service query data, provided
  81                                 through a byte array.
  82
  83                                 Note: a Peer object will never show this
  84                                 information. When scanning, a device gets
  85                                 only the bonjour response data. However,
  86                                 this information is mandatory when a bonjour
  87                                 service is given through Manager API
  88                                 RegisterPeerService and
  89                                 UnregisterPeerService.
  90
  91                         array{byte} BonjourResponse [readonly]
  92
  93                                 The bonjour service response data, provided
  94                                 through a byte array.
  95
  96                                 Note: this will be the only bonjour related
  97                                 information a Peer object will show.
  98
  99                         array{byte} WiFiDisplayIEs [readonly]
 100
 101                                 The TLV formatted byte array representing the
 102                                 WiFi Display Information Elements.