Files
cocos4/native/cocos/bindings/jswrapper/RefCounter.h
T
2022-01-24 17:18:47 +08:00

67 lines
2.4 KiB
C++

/****************************************************************************
Copyright (c) 2016 Chukong Technologies Inc.
Copyright (c) 2017-2022 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#pragma once
namespace se {
/**
* This class is used to manage reference-counting providing a simple interface and a counter.
*
*/
class RefCounter {
public:
/**
* @brief Increases reference count by one.
*/
void incRef();
/**
* @brief Decrements the reference count, if it reaches zero, destroys this instance of RefCounter to release its memory.
* @note Please note that after calling this function, the caller should absolutely avoid to use the pointer to this instance since it may not be valid anymore.
*/
void decRef();
/**
* @brief Gets reference count.
* @return The reference count.
* @note When this goes to zero during a decRef() call, the object will auto-delete itself.
*/
unsigned int getRefCount();
protected:
// Default constructor
// Initialises the internal reference count to 1.
RefCounter();
// Destructor
virtual ~RefCounter();
private:
unsigned int _refCount;
};
} // namespace se