1 #ifndef DALI_REF_OBJECT_H
2 #define DALI_REF_OBJECT_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <cstdint> // uint32_t
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/common/intrusive-ptr.h>
31 * @addtogroup dali_core_object
38 * @brief Base class for reference counted objects.
40 * Typically this should be used with an intrusive pointer,
41 * instead of calling Reference() and Unreference() methods directly.
44 class DALI_CORE_API RefObject
49 * @brief Increments the object's reference count.
55 * @brief Decrements the object's reference count.
57 * When the reference count drops to zero, the object will self-destruct.
63 * @brief Retrieves the object's reference count.
66 * @return The reference count
68 uint32_t ReferenceCount();
73 * @brief Default constructor.
79 * @brief RefObject is intended as a base class.
81 * A RefObject may only be deleted when its reference count is zero.
87 * @brief Copy constructor.
89 * The newly copied object will have a reference count of zero.
91 * @param[in] rhs The object to copy
93 RefObject(const RefObject& rhs);
96 * @brief Assignment operator.
98 * The newly copied object will have a reference count of zero.
100 * @param[in] rhs The object to copy
101 * @return A reference to this
103 RefObject& operator=(const RefObject& rhs);
107 volatile uint32_t mCount; ///< Reference count
115 #endif // DALI_REF_OBJECT_H