From e590ca3004b354588f45facab7989b59cf9d9309 Mon Sep 17 00:00:00 2001 From: Kieran Bingham Date: Wed, 28 Jul 2021 09:13:54 +0100 Subject: 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 Signed-off-by: Kieran Bingham --- Documentation/guides/application-developer.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'Documentation/guides/application-developer.rst') 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; 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 cm = std::make_unique(); 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 -------------------------- -- cgit v1.2.1