nixo
/
tuhi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README: fix the API documentation, Pairing* is now Search*

This commit is contained in:
Peter Hutterer 2018-01-24 10:50:56 +10:00
parent daf2693927
commit 71dd70cc95
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -59,14 +59,14 @@ org.freedesktop.tuhi1.Manager
Method: StopSearch() -> () Method: StopSearch() -> ()
Stop listening to available devices in pairing mode. If called after Stop listening to available devices in pairing mode. If called after
StartSearch() and before a Searchtopped signal has been received, StartSearch() and before a SearchStopped signal has been received,
this method triggers the SearchStopped signal. That signal indicates this method triggers the SearchStopped signal. That signal indicates
success or an error. success or an error.
If this method is called before StartPairing() or after the If this method is called before StartSearch() or after the
PairingStopped signal, it is ignored and no signal is generated. SearchStopped signal, it is ignored and no signal is generated.
Note that between callling StopPairing() and the PairingStopped signal Note that between calling StopSearch() and the SearchStopped signal
arriving, PairableDevice signals may still arrive. arriving, PairableDevice signals may still arrive.
Signal: PairableDevice(o) Signal: PairableDevice(o)
@ -81,18 +81,18 @@ org.freedesktop.tuhi1.Manager
that object is desired. See the documentation for that interface that object is desired. See the documentation for that interface
for details. for details.
When the search timeout expires, the device is removed by the daemon When the search timeout expires, the device may be removed by the
again. Note that until the device is paired, the device is not listed daemon again. Note that until the device is paired, the device is not
in the managers Devices property. listed in the managers Devices property.
Signal: PairingStopped(i) Signal: SearchStopped(i)
Sent when the pairing has stopped. An argument of 0 indicates a Sent when the search has stopped. An argument of 0 indicates a
successful termination of the pairing process, either when a device successful termination of the search process, either when a device
has been paired or the timeout expired. has been paired or the timeout expired.
Once this signal has been sent, all devices announced through Once this signal has been sent, all devices announced through
PairableDevice signals should be considered invalidated. Attempting to PairableDevice signals should be considered invalidated. Attempting to
Pair() one of the devices after the PairingStopped() signal may result Pair() one of the devices after the SearchStopped() signal may result
in an error. in an error.
In case of error, the argument is a negative errno. In case of error, the argument is a negative errno.