RefHandleFn.h

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

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

#ifndef CNTM_REFHANDLEFN_H
#define CNTM_REFHANDLEFN_H
#include <Cntm/RefUtils/Internal/RefHandleRefImplementation.h>
#include <Cntm/RefUtils/Internal/BasicRefHandle.h>

namespace Cntm
{       

        /**
         * Механизм хэндлов предназначен для автоматизации вызова определенного метода объекта при уничтожении последнего хэндла, связанного с объектом.
         * 
         * Отличием данного класса от RefHandle является то, что задается не метод, а функция, принимающая ссылочный указатель на класс в качестве параметра.
         * 
         * Данный класс является шаблоном, первым параметром которого является тип объекта, а вторым - указатель на функцию, которую следует вызвать. Функция должна иметь сигнатуру void(RefPtr<T>). При вызове данной функции гарантируется, что переданный указатель никогда не будет содержать NULL значения.
         * 
         * Указанный в шаблоне метод может вызываться многократно. Это происходит, если после уничтожения всех хэндлов, связанных с объектом и вызова указанного метода, вновь будут созданы хэндлы, связанные с объектом.
         * 
         * Пример использования приведен в SynchroRefBaseFn.
         * 
         * Класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup RefUtils
         */
        template < typename T, void (*FinalizeP)(RefPtr < T > )>
        class RefHandleFn: public SpecUtils::BasicRefHandle < T, SpecUtils::RefHandleRefImplementation >
        {
        public:
        
                /**
                 * Конструктор по умолчанию. Создает хэндл, не связанный ни с каким объектом. 
                 */
                RefHandleFn(): 
                        SpecUtils::BasicRefHandle<T, SpecUtils::RefHandleRefImplementation>(RefPtr<T>::Null(), FinalizeP) {}
                
                /**
                 * Конструктор. Создает хэндл, связанный с указанным объектом. 
                 */
                RefHandleFn(RefPtr<T> Object): 
                        SpecUtils::BasicRefHandle<T, SpecUtils::RefHandleRefImplementation>(Object, FinalizeP) {}
                
                /**
                 * Связывает хэндл с новым объектом. 
                 */
                RefHandleFn < T, FinalizeP > & operator = (RefPtr<T> Object)
                {
                        Assign(Object);
                        return *this;
                }
                
                /**
                 * Связывает хэндл с новым объектом. 
                 */
                void Assign(RefPtr<T> Object)
                {
                        SpecUtils::BasicRefHandle<T, SpecUtils::RefHandleRefImplementation>::Assign(Object, FinalizeP);
                }
        
                /**
                 * Делает хэндл не связанным. 
                 */
                void Unassign()
                {
                        Assign(RefPtr<T>::Null());
                }
        };

}

#endif //CNTM_REFHANDLEFN_H

---