SynchroRefHandle.h

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

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

#ifndef CNTM_SYNCHROREFHANDLE_H
#define CNTM_SYNCHROREFHANDLE_H
#include <Cntm/RefUtils/Internal/SynchroRefHandleRefImplementation.h>
#include <Cntm/RefUtils/Internal/BasicRefHandle.h>
#include <Cntm/Synchro/SynchroObject.h>

namespace Cntm
{
        
        /**
         * Механизм хэндлов предназначен для автоматизации вызова определенного метода объекта при уничтожении последнего хэндла, связанного с объектом.
         * 
         * Данный класс является шаблоном, первым параметром которого является тип объекта, а вторым - указатель на метод объекта, который следует вызвать. Метод должен иметь сигнатуру void(void), т.е. ничего не принимать и не возвращать.
         * 
         * Указанный в шаблоне метод может вызываться многократно. Это происходит, если после уничтожения всех хэндлов, связанных с объектом и вызова указанного метода, вновь будут созданы хэндлы, связанные с объектом.
         * 
         * Отличием данного класса от RefHandle является то, что гарантируется синхронизированный отложенный вызов указанного в шаблоне метода. Это приводит к тому, что объект, с которым связан хэндл, может быть только синхрообъектом.
         * 
         * Особенность вызова указанного в шаблоне метода. Если после того, как будет уничтожен последний хэндл, связанный с объектом, но до выполнения метода (он вызывается отложенно) создать новый хэндл, связанный с объектом, внутри синхропространства, к которому принадлежит объект, то гарантируется, что вызов метода будет отменен.
         * 
         * Пример:
         * \code
         * class Class1: public SynchroRefBase
         * {
         * public:
         *      typedef RefPtr<Class1> Ptr;
         *      void Close() { cout << "Class1::Close()" << endl; }
         *      typedef SynchroRefHandle<Class1, &Class1::Close> Handle;
         * };
         * 
         * int main(int argc, char **argv)
         * {
         *      Cntm::QTMainSynchroSpace::Application a(argc, argv);
         * 
         *      mw = new Form1();
         *      mw->setCaption( "Form1" );
         *      mw->show();
         *      a.connect( &a, SIGNAL(lastWindowClosed()), &a, SLOT(quit()) );
         *      
         *      Class1::Ptr p(new Class1);
         * 
         *      if (Какое-то условие)
         *      {
         *              Class1::Handle h1 = p;
         *              Какието-действия с объектом p.
         *      } // Гарантируется вызов метода Close() для объекта p после уничтожения хэндла, связанного с ним.
         *      a.exec();
         * }
         * \endcode
         * 
         * Класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup RefUtils
         */
        template < typename T, void (T::*FinalizeP)()>
        class SynchroRefHandle: public SpecUtils::BasicRefHandle < T, SpecUtils::SynchroRefHandleRefImplementation >
        {
        public:
        
                /**
                 * Конструктор по умолчанию. Создает хэндл, не связанный ни с каким объектом. 
                 */
                SynchroRefHandle(): 
                        SpecUtils::BasicRefHandle<T, SpecUtils::SynchroRefHandleRefImplementation>(RefPtr<T>(), &SynchroRefHandle::Finalize)
                {
                        CheckTypeCast<SynchroObject*>((T*)NULL);
                }
                
                /**
                 * Конструктор. Создает хэндл, связанный с указанным объектом. 
                 */
                SynchroRefHandle(RefPtr<T> Object): 
                        SpecUtils::BasicRefHandle<T, SpecUtils::SynchroRefHandleRefImplementation>(Object, &SynchroRefHandle::Finalize)
                {
                        CheckTypeCast<SynchroObject*>((T*)NULL);
                }
                
                /**
                 * Связывает хэндл с новым объектом. 
                 */
                SynchroRefHandle < T, FinalizeP > & operator = (RefPtr<T> Object)
                {
                        Assign(Object);
                        return *this;
                }
                
                /**
                 * Связывает хэндл с новым объектом. 
                 */
                void Assign(RefPtr<T> Object)
                {
                        SpecUtils::BasicRefHandle<T, SpecUtils::SynchroRefHandleRefImplementation>::
				Assign(Object, &SynchroRefHandle::Finalize);
                }
        
                /**
                 * Делает хэндл не связанным. 
                 */
                void Unassign()
                {
                        Assign(RefPtr<T>::Null());
                }
                
        private:
        
                /**
                 * Вызывает указанный метод объекта. 
                 */
                static void Finalize(RefPtr<T> HandledObject) { (HandledObject.Pointer()->*FinalizeP)(); }
        };

}

#endif //CNTM_SYNCHROREFHANDLE_H

---