wearable/doc/network-api.txt

   1 BlueZ D-Bus Network API description
   2 ***********************************
   3
   4 Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>
   5
   6
   7 Network hierarchy
   8 =================
   9
  10 Service         org.bluez
  11 Interface       org.bluez.Network
  12 Object path     [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
  13
  14 Methods         string Connect(string uuid)
  15
  16                         Connect to the network device and return the network
  17                         interface name. Examples of the interface name are
  18                         bnep0, bnep1 etc.
  19
  20                         uuid can be either one of "gn", "panu" or "nap" (case
  21                         insensitive) or a traditional string representation of
  22                         UUID or a hexadecimal number.
  23
  24                         The connection will be closed and network device
  25                         released either upon calling Disconnect() or when
  26                         the client disappears from the message bus.
  27
  28                         Possible errors: org.bluez.Error.AlreadyConnected
  29                                          org.bluez.Error.ConnectionAttemptFailed
  30
  31                 void Disconnect()
  32
  33                         Disconnect from the network device.
  34
  35                         To abort a connection attempt in case of errors or
  36                         timeouts in the client it is fine to call this method.
  37
  38                         Possible errors: org.bluez.Error.Failed
  39
  40                 dict GetProperties()
  41
  42                         Returns all properties for the interface. See the
  43                         properties section for available properties.
  44
  45 Signals         PropertyChanged(string name, variant value)
  46
  47                         This signal indicates a changed value of the given
  48                         property.
  49
  50 Properties      boolean Connected [readonly]
  51
  52                         Indicates if the device is connected.
  53
  54                 string Interface [readonly]
  55
  56                         Indicates the network interface name when available.
  57
  58                 string UUID [readonly]
  59
  60                         Indicates the connection role when available.
  61
  62
  63 Network server hierarchy
  64 ========================
  65
  66 Service         org.bluez
  67 Interface       org.bluez.NetworkServer
  68 Object path     /org/bluez/{hci0,hci1,...}
  69
  70 Methods         void Register(string uuid, string bridge)
  71
  72                         Register server for the provided UUID. Every new
  73                         connection to this server will be added the bridge
  74                         interface.
  75
  76                         Valid UUIDs are "gn", "panu" or "nap".
  77
  78                         Initially no network server SDP is provided. Only
  79                         after this method a SDP record will be available
  80                         and the BNEP server will be ready for incoming
  81                         connections.
  82
  83                 void Unregister(string uuid)
  84
  85                         Unregister the server for provided UUID.
  86
  87                         All servers will be automatically unregistered when
  88                         the calling application terminates.