summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKieran Bingham <kieran.bingham@ideasonboard.com>2021-07-28 09:13:54 +0100
committerKieran Bingham <kieran.bingham@ideasonboard.com>2021-08-25 21:35:03 +0100
commite590ca3004b354588f45facab7989b59cf9d9309 (patch)
tree986e3d7ec74d5987af41d56abc99e9f261f50b12
parentd2783171dd9d25f7441bd5317fb2623c8f4b4d84 (diff)
Documentation: application-developer: Recommend unique_ptr for CameraManager
The CameraManager object should be deleted when it is no longer used to prevent it from leaking. When the application closes, the memory will be released, but it would show up in reports from memory validation tools such as valgrind if not handled correctly. Recommend best-practices in the guide and ensure it is automatically cleaned up when the CameraManager goes out of scope. Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rw-r--r--Documentation/guides/application-developer.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst
index 442d8e6a..ce093cbe 100644
--- a/Documentation/guides/application-developer.rst
+++ b/Documentation/guides/application-developer.rst
@@ -61,11 +61,15 @@ variable for the camera to support the event call back later:
std::shared_ptr<Camera> camera;
Create a Camera Manager instance at the beginning of the main function, and then
-start it. An application should only create a single Camera Manager instance.
+start it. An application must only create a single Camera Manager instance.
+
+The CameraManager can be stored in a unique_ptr to automate deleting the
+instance when it is no longer used, but care must be taken to ensure all
+cameras are released explicitly before this happens.
.. code:: cpp
- CameraManager *cm = new CameraManager();
+ std::unique_ptr<CameraManager> cm = std::make_unique<CameraManager>();
cm->start();
During the application initialization, the Camera Manager is started to
@@ -560,6 +564,9 @@ uses, so needs to do the following:
return 0;
+In this instance the CameraManager will automatically be deleted by the
+unique_ptr implementation when it goes out of scope.
+
Build and run instructions
--------------------------