diff options
| author | Thomas McGuire <thomas.mcguire.qnx@kdab.com> | 2012-07-09 14:15:59 +0200 |
|---|---|---|
| committer | Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> | 2012-11-28 20:13:03 +0100 |
| commit | 6751bb62dab6957e6212e0a03ecc54d3d8f94092 (patch) | |
| tree | 559dfb30d6b8bb87451fdbaac933aaec6d03cd97 | |
| parent | a7646144f8ebee1a07f20741bba37f953fd2ef8e (diff) | |
Add docs for Blackberry sensor queuing
Change-Id: I2d81d9c62ce7e8b50c27631a28aa7fbcaca70373
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
Reviewed-by: Lorn Potter <lorn.potter@gmail.com>
| -rw-r--r-- | src/sensors/qsensor.cpp | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp index e9637fb06c..47f4840413 100644 --- a/src/sensors/qsensor.cpp +++ b/src/sensors/qsensor.cpp @@ -832,6 +832,17 @@ int QSensor::error() const When the sensor is started with buffering option, values are collected from that moment onwards. There is no pre-existing buffer that can be utilized. + Some backends like Blackberry only support enabling or disabling the buffer and do not give + control over the size. In this case, the maxBufferSize and efficientBufferSize properties + might not be set at all, even though buffering is supported. Setting the bufferSize property + to any value greater than 1 will enable buffering. After the sensor has been started, + the bufferSize property will be set to the actual value by the backend. + + On Blackberry, buffering will not wait until the buffer is full to deliver new + readings. Instead, the buffer will be used if the backend does not manage to retrieve the readings + in time, for example when the event loop is blocked for too long. Without a buffer, these readings + would simply be dropped. + The buffer size can only be changed while the sensor is not active. \sa QSensor::maxBufferSize, QSensor::efficientBufferSize |