ReentrantSync.h

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

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

#ifndef CNTM_REENTRANTSYNC_H
#define CNTM_REENTRANTSYNC_H
#include <Cntm/Utils/CheckTypeCast.h>
#include <Cntm/Exceptions/NullArgException.h>
#include <Cntm/Synchro/SyncScopes/BasicSync.h>

namespace Cntm
{

        /**
         * Класс синхросекции, выполняющей вход в синхропространство в реентерабельном режиме. Синхросекции автоматизируют процесс входа и выхода из синхропространства. В конструкторе синхросекций обычно производится вход в реентерабельном режиме, а в деструкторе - выход из синхропространства в реентерабельном режиме.
         * 
         * Использование синхросекций повышает удобство (для входа/выхода требуется написать только 1 строку кода) и надежность (выход из синхропространства будет произведен в любом случае, в т.ч. и при исключении).
         * 
         * Объекты синхросекций содержат ссылочные указатели на синхрообъекты или на синхропространства (IBasicSynchro), в которые произведен вход. Если синхросекция не используется для входа, то указатель на синхропространство равен NULL.
         * 
         * Данный класс не поддерживает многопоточность.
         * @author Овсеевич Р.
         */
        class ReentrantSync: public BasicSync
        {
        public:

                /**
                 * Конструктор по умолчанию. Инициализирует указатель на IBasicSynchro в NULL и не выполняет никаких действий.
                 */
                ReentrantSync() {}

                /**
                 * Конструктор инициализации IBasicSynchro. Производится вход в синхропространство, к которому принадлежит синхрообъект, в реентерабельном режиме.
                 * 
                 * Исключение: NullArgException если аргумент Object равен NULL.
                 * @param Object - синхрообъект, в синхропространство которого требуется войти в реентерабельном режиме. Он не должен равняться NULL.
                 */
                ReentrantSync(IBasicSynchro::Ptr Object)
                {
                        if (!Object) throw NullArgException("Cntm::ReentrantSync::ReentrantSync(IBasicSynchro::Ptr)", "Не задан синхрообъект");
                        Enter(Object);
                }

                /**
                 * Конструктор инициализации IBasicSynchro. Производится вход в синхропространство, к которому принадлежит синхрообъект, в реентерабельном режиме.
                 * 
                 * Исключение: NullArgException если аргумент Object равен NULL.
                 * @param Object - синхрообъект, в синхропространство которого требуется войти в реентерабельном режиме. Он не должен равняться NULL.
                 */
                template <typename T>
                ReentrantSync(RefPtr<T> Object)
                {
                        CheckTypeCast<IBasicSynchro*>((T*)NULL);
                        if (!Object) throw NullArgException("Cntm::ReentrantSync::ReentrantSync(IBasicSynchro::Ptr)", "Не задан синхрообъект");
                        Enter(Object);
                }

                /**
                 * Конструктор копирования. Если Object() источника не равен NULL, то производится вход в синхропространство в реентерабельном режиме.
                 * @param Src - источник, из которого берется Object().
                 */
                ReentrantSync(const BasicSync& Src) { Enter(Src.Object()); }

                /**
                 * Конструктор копирования. Если Object() источника не равен NULL, то производится вход в синхропространство в реентерабельном режиме.
                 * @param Src - источник, из которого берется Object().
                 */
                ReentrantSync(const ReentrantSync& Src) { Enter(Src.Object()); }

                /**
                 * Деструктор. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).
                 */
                ~ReentrantSync() { Leave(); }

                /**
                 * Оператор присвоения IBasicSynchro. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).  Производит вход в синхропространство, к которому принадлежит синхрообъект, в реентерабельном режиме.
                 * 
                 * Исключение: NullArgException если аргумент Object равен NULL.
                 * @param Object - IBasicSynchro, в синхропространство которого требуется войти в реентерабельном режиме. Он не должен равняться NULL.
                 */
                ReentrantSync& operator= (IBasicSynchro::Ptr Object)
                {
                        if (!Object) throw NullArgException("Cntm::ReentrantSync::operator=(IBasicSynchro::Ptr)", "Не задан синхрообъект");
                        Set(Object);
                        return *this;
                }

                /**
                 * Оператор присвоения IBasicSynchro. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).  Производит вход в синхропространство, к которому принадлежит синхрообъект, в реентерабельном режиме.
                 * 
                 * Исключение: NullArgException если аргумент Object равен NULL.
                 * @param Object - IBasicSynchro, в синхропространство которого требуется войти в реентерабельном режиме. Он не должен равняться NULL.
                 */
                template <typename T>
                ReentrantSync& operator= (RefPtr<T> Object)
                {
                        CheckTypeCast<IBasicSynchro*>((T*)NULL);
                        if (!Object) throw NullArgException("Cntm::ReentrantSync::operator=(IBasicSynchro::Ptr)", "Не задан синхрообъект");
                        Set(Object);
                        return *this;
                }

                /**
                 * Оператор копирования. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).  Если Object() источника не равен NULL, то производится вход в синхропространство в реентерабельном режиме. Object() принимает новое значение.
                 * 
                 * Если новое синхропространство совпадает со старым, то ни каких действий не выполняется.
                 * @param Src - источник, из которого берется Object().
                 */
                ReentrantSync& operator= (const BasicSync& Src) { Set(Src.Object()); return *this; }

                /**
                 * Оператор копирования. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).  Если Object() источника не равен NULL, то производится вход в синхропространство в реентерабельном режиме. Object() принимает новое значение.
                 * 
                 * Если новое синхропространство совпадает со старым, то ни каких действий не выполняется.
                 * @param Src - источник, из которого берется Object().
                 */
                ReentrantSync& operator= (const ReentrantSync& Src) { Set(Src.Object()); return *this; }

                /**
                 * Установить новое значение Object(). Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL).  Если Object() источника не равен NULL, то производится вход в синхропространство в реентерабельном режиме. Object() принимает новое значение.
                 * 
                 * Если новое синхропространство совпадает со старым, то ни каких действий не выполняется.
                 * @param Object - синхропространство, в которое требуется войти в реентерабельном режиме.
                 */
                void Set(IBasicSynchro::Ptr Object)
                {
                        if (Object == ReentrantSync::Object()) return; 
                        Leave();
                        Enter(Object);
                }

                /**
                 * Выйти из синхропространства. Производит выход из синхропространства, если в него был произведен вход (Object() не равен NULL). Object() принимает значение NULL.
                 */
                void Leave()
                {
                        if (Object()) Object()->Leave(true);
                        ResetObject();
                }
                
        private:
        
                /**
                 * Производит вход в указанное синхропространство.
                 */
                void Enter(const IBasicSynchro::Ptr& Object) { if (Object) Object->Enter(true); SetObject(Object); }
        };

}

#endif //CNTM_REENTRANTSYNC_H

---