IRefObject.h

См. документацию.

/*
 * CntmLib - Подсчет ссылок, потоки, синхронизация, асинхронные процедуры, события
 * Copyright (c) 2005, Овсеевич Роман, CntmLib@mail.ru
 * _______________________________________________________________________________
 * Разрешено свободное использование, копирование, распространение, изменение
 * (изменение сведений об авторских правах запрещено). Запрещена продажа и 
 * включение всей библиотеки или ее частей в другие библиотеки. В сведениях об
 * авторских правах на программу (или сведениях о программе, об авторах, 
 * использованных средствах разработки и т.д.) должна быть указана информация
 * о библиотеке CntmLib, ее авторе и, возможно, сайте или email'е.
 * Библиотека поставляется "как есть", без каких-либо гарантий со стороны автора.
 */
 
#ifndef CNTM_IREFOBJECT_H
#define CNTM_IREFOBJECT_H
#include <Cntm/RefCount/RefPtr.h>

namespace Cntm
{

        namespace SpecUtils
        {
                template < typename T > class RefObjectPtrProxy;
                template < typename T > class RefObjectPtrPtrProxy;
        }

        /**
         * Интерфейс для объекта, подсчитывающего ссылки на себя. Используется объектом для декларации возможности подсчитывать ссылки.
         * 
         * При использовании объектов, подсчитывающих ссылки (наследующих данный интерфейс), следует учитывать следующее. Все управление подсчетом ссылок осуществляется через ссылочные указатели - RefPtr при их инициализации, присвоении, уничтожении (см. класс RefPtr). Все обращения к объекту, подсчитывающему ссылки, должны производится через ссылочные указатели. Пока выполняется метод объекта, должен иметься ссылочный указатель на этот объект (это требование следует учитывать при разработке многопоточных систем или систем с обратными вызовами).
         * 
         * При создании объекта его счетчик ссылок устанавливается в 0. При инициализации ссылочного указателя ссылкой на объект или другим ссылочным указателем производится увеличение кол-ва ссылок на объект. При потере ссылки при разрушении ссылочного указателя или присвоении ему нового значения счетчик ссылок на старый объект уменьшается.
         * 
         * При достижении счетчиком ссылок 0 объект переводится в т.н. удаляемое состояние, в котором он может находиться до своего физического удаления. Если наряду с сылочными указателями используются и обычные указатели, то при присвоении ссылочному указателю обычного указателя на объект, который находится в удаляемом состоянии, ссылочный указатель принудительно будет установлен в NULL (все это не относится к случаю, когда ссылочному указателю присваивается значение другого ссылочного указателя, т.к. объект по определению не может находится в удаляемом состоянии при наличии хотя бы одного ссылочного указателя). Поэтому перед использованием ссылочного указателя после присвоения ему обычного указателя его следует проверять на NULL. Из этого правила существуют 2 очевидных исключения:
         * - проверять на NULL не надо после инициализации указателем на только что созданный объект, возвращаемый оператором new;
         * - при использовании this внутри методов самого объекта, т.к. при выполнении метода, вызванного клиентом, объект не может находиться в удаляемом состоянии (это не относится к деструктору).
         * 
         * Создавать объекты с подсчетом ссылок рекомендуется в динамической памяти. В статической памяти или в стеке тоже возможно, однако при этом нельзя использовать ссылочные указатели, т.к. это приведет к вызову опертора delete не в динамической памяти.
         * 
         * Внимание! Когда объект создается в динамической памяти, необходимо присвоить результат оператора new какому-либо указателю (с использованием конструктора, принимающего обычный указатель, или операции NewPointer), даже если объект не будет использоваться. В противном случае объект никогда не будет удален автоматически.
         * 
         * Наследующие классы не могут сами реализовывать данный интерфейс. Для реализации они должны наследовать RefBase, RefBaseEx или AggregatedBase.
         * 
         * Для удобства использования наследующие данный интерфейс классы должны объявлять вложенный тип Ptr как ссылочный указатель на этот класс:
         * \code
         * class MyClass : public Cntm::RefBase
         * {
         * public:
         *      typedef Cntm::RefPtr<MyClass> Ptr;
         *      .....
         * };
         * ....
         * MyClass::Ptr p1 = new MyClass;
         * \endcode
         * 
         * Реализации интерфейса поддерживают многопоточность.
         * @author Овсеевич Р.
         * \ingroup RefCount
         */
        class IRefObject
        {
        public:
                
                typedef RefPtr < IRefObject > Ptr;       
        
        private:
        
                friend class RefBase;
                friend class AggregatedBase;
                template < typename T > friend class SpecUtils::RefObjectPtrProxy;
                template < typename T > friend class SpecUtils::RefObjectPtrPtrProxy;
                
                /**
                 * Увеличить кол-во ссылок. Возвращает true, если объект не находится в удаляемом состоянии и кол-во ссылок увеличено, иначе возвращается false.
                 */
                virtual bool IncRefCount() = 0;

                /**
                 * Уменьшить кол-во ссылок. Если счетчик ссылок достиг 0, то возвращается true, иначе возвращается false.
                 */
                virtual bool DecRefCount() = 0;
                
        /**
         * Сообщить объекту, что он может быть удален. 
         */
                virtual void DeleteInstance() = 0;
        };

}

// Следует средства для void* включать вместе со средствами для IRefObject*
#include <Cntm/RefCount/Internal/RefNoneOpsImpl.h>
#include <Cntm/RefCount/Internal/GenericRefNonePtrImpl.h>

// Включение средств для IRefObject* промзводится после полного определения IRefObject
#include <Cntm/RefCount/Internal/RefObjectOpsImpl.h>
#include <Cntm/RefCount/Internal/GenericRefObjectPtrImpl.h>

#endif //CNTM_IREFOBJECT_H

---