SynchroAggregatedBase.h

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

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

#ifndef CNTM_SYNCHROAGGREGATEDBASE_H
#define CNTM_SYNCHROAGGREGATEDBASE_H
#include <Cntm/RefCount/AggregatedBase.h>
#include <Cntm/Synchro/SynchroObject.h>
#include <Cntm/Synchro/SyncScopes/Sync.h>
#include <Cntm/Synchro/SyncScopes/ReentrantSync.h>

namespace Cntm
{

        /**
         * Базовый класс для синхрообъектов. Объединяет средства синхронизации, предоставляемые классом Cntm::SynchroObject, и подсчета ссылок для агрегированных объектов, предоставляемого классом Cntm::AggregatedBase. См. описания базовых классов, а также класса Cntm::SynchroSpace.
         * 
         * Данный класс может использоваться в качестве базового класса или примеси для объектов, которым требуются средства синхронизации и которые являются агрегированными объектами.
         * 
         * Данный класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup Synchro
         */
        class SynchroAggregatedBase : public AggregatedBase, public SynchroObject
        {
        protected:

                /**
                 * Конструктор используется, когда операция создания синхрообъекта уже выполняется внутри пространства, к которому будет принадлежать новый объект. Если синхропространство не указано, то будет использовано главное синхропространство (т.о. если в программе используется только главное синхропространство, то нет необходимости указывать его явно).
                 * 
                 * @param Aggregate - агрегат, в который будет входить создаваемый объект. Не должен принимать значение NULL.
                 * 
                 * Исключение Cntm::IllegalStateException - если синхропространство явно не указано, а главное синхропространство отсутствует
                 */
                SynchroAggregatedBase(SynchroObject* Aggregate):
                        AggregatedBase(Aggregate), SynchroObject(Aggregate->Space()) {}

                /**
                 * Конструктор используется, когда операция создания синхрообъекта уже выполняется внутри пространства, к которому будет принадлежать новый объект. Если синхропространство не указано, то будет использовано главное синхропространство (т.о. если в программе используется только главное синхропространство, то нет необходимости указывать его явно).
                 * 
                 * @param Aggregate - агрегат, в который будет входить создаваемый объект. Не должен принимать значение NULL.
                 * @param Space - (опционально) используется для задания синхропространства, к которому будет принадлежать создаваемый объект.
                 * 
                 * Исключение Cntm::IllegalStateException - если синхропространство явно не указано, а главное синхропространство отсутствует
                 */
                SynchroAggregatedBase(IRefObject* Aggregate, const SynchroSpace::Ptr& Space = Cntm::SynchroSpace::Ptr()):
                        AggregatedBase(Aggregate), SynchroObject(Space) {}
                
                /**
                 * Конструктор используется, когда объект создается в новом или просто другом синхропространстве. В этом случае конструктор синхрообъекта пытается извлечь синхропространство из ConstructSync и если ConstructSync был проинициализирован, то использует извлеченное синхропространство. Если был указан пустой ConstructSync, то первым делом конструктор синхрообъекта создает дополнительное синхропространство (класс Cntm::ExtraSynchroSpace) и присваивает его ConstructSync (который передан по ссылке). Т.о. работа конструктора SynchroObject и конструкторов производных классов всегда будет осуществляться внутри синхпространства данного объекта.
                 * 
                 * @param Aggregate - агрегат, в который будет входить создаваемый объект. Определяет синхропространство, к которому будет принадлежать новый объект. Не должен принимать значение NULL.
                 * @param ConstructSync - ссылка на синхросекцию, которая обеспечивает нахождение в синхропространстве при создании объекта.
                 */
                SynchroAggregatedBase(IRefObject* Aggregate, Sync& ConstructSync):
                        AggregatedBase(Aggregate), SynchroObject(ConstructSync) {}
                
                /**
                 * Конструктор используется, когда объект создается в новом или просто другом синхропространстве. В этом случае конструктор синхрообъекта пытается извлечь синхропространство из ConstructSync и если ConstructSync был проинициализирован, то использует извлеченное синхропространство. Если был указан пустой ConstructSync, то первым делом конструктор синхрообъекта создает дополнительное синхропространство (класс Cntm::ExtraSynchroSpace) и присваивает его ConstructSync (который передан по ссылке). Т.о. работа конструктора SynchroObject и конструкторов производных классов всегда будет осуществляться внутри синхпространства данного объекта.
                 * 
                 * @param Aggregate - агрегат, в который будет входить создаваемый объект. Определяет синхропространство, к которому будет принадлежать новый объект. Не должен принимать значение NULL.
                 * @param ConstructSync - ссылка на реентерабельную синхросекцию, которая обеспечивает нахождение в синхропространстве при создании объекта.
                 */
                SynchroAggregatedBase(IRefObject* Aggregate, ReentrantSync& ConstructSync):
                        AggregatedBase(Aggregate), SynchroObject(ConstructSync) {}
        };

}

#endif //CNTM_SYNCHROAGGREGATEDBASE_H

---