summaryrefslogtreecommitdiffstats
path: root/src/sensors
diff options
context:
space:
mode:
authorThomas McGuire <thomas.mcguire.qnx@kdab.com>2012-07-09 14:15:59 +0200
committerQt by Nokia <qt-info@nokia.com>2012-07-12 02:28:35 +0200
commit5464963f9afae3bf7329d9b0ea7102231125f794 (patch)
tree840eaf19cea84d2185105272a651dc1675130731 /src/sensors
parenta355c3a54cdc1c8bfd2129307c7824dd7012bd11 (diff)
Blackberry: Implement buffering
The API provided by QSensor does not fit nicely for what the OS service API provides. Instead of adding yet another buffer-related property to QSensor, I added documentation to QSensor describing the differences in behaviour. Change-Id: I2d81d9c62ce7e8b50c27631a28aa7fbcaca70373 Reviewed-by: Adam Parco <aparco@rim.com> Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src/sensors')
-rw-r--r--src/sensors/qsensor.cpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp
index 2949e771..be0c7862 100644
--- a/src/sensors/qsensor.cpp
+++ b/src/sensors/qsensor.cpp
@@ -776,6 +776,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