ActiveThread.h

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

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

#ifndef CNTM_ACTIVETHREAD_H
#define CNTM_ACTIVETHREAD_H
#include <Cntm/SystemUtils/SysThread.h>
#include <Cntm/Concurrency/ExecutionUnit.h>
#include <Cntm/ActiveObjects/Internal/ActiveThreadFunctor.h>
#include <Cntm/ActiveObjects/ActiveThreadTerminatingSignal.h>

namespace Cntm
{
        
        class ActiveObject;
        
        /**
         * Класс потока активного объекта. Предоставляет средства для запуска потока активного объекта.
         * 
         * Поток активного объекта является единицей выполнения. Наследует класс Cntm::ExecutionUnit, который предоставляет средства для останова единиц выполнения и потоков активных объектов в частности.
         * 
         * Запуск потока производится методом Start()(). Методу Start передается активный объект и указатель на его метод. Метод Start() возвращает специальный объект-фанктор, имеющий operator(), принимающий аргументы для указанного метода объекта, запускающего указанный метод в другом потоке. При вызове указанного метода ему будут переданы аргументы,  заданные в методе Start()(). Т.о. вызов метода Start()() выглядит так: Start(активный объект, метод активного объекта)(список аргументов метода активного объекта). При указании аргументов производится проверка типов указанных значений и типов аргументов указанного метода. Типы аргументов должны иметь конструктор копирования, т.к. копии аргументов хранятся на всем протяжении выполнения потока (иначе их невозможно передать в другой поток). Пример:
         * class Class1: public ActiveRefBase
         * {
         * void Thread1(int a, string s) { ... } // Метод, который будет вызван в другом потоке.
         * 
         * Class1() { ActiveThread::Start(this, &Class1::Thread1)(45, "Text"); } // Вызов метода в новом потоке и передача ему аргументов - числа и строки.
         * };
         * 
         * Взаимодействие с созданным потоком осуществляется через хэндл потока активного объекта (класс Cntm::ActiveThreadHandle). Через хэндл можно сообщить потоку об останове. Поток может узнать об останове через методы Terminated() и CheckTerminating(), унаследованные им от класса Cntm::ExecutionUnit().
         * 
         * Данный класс обеспечивает многопоточность.
         * @author Овсеевич Р.
         * \ingroup ActiveObjects
         */
        class ActiveThread: public ExecutionUnit
        {
        public:
                
                /**
                 * Приоритет потока.
                 */
                enum ThreadPriority
                {
                        /**
                         * Обычный приоритет.
                         */
                        tpNormal = Cntm::SpecUtils::SysThread::prNormal,
                        
                        /**
                         * Пониженный приоритет.
                         */
                        tpLow = Cntm::SpecUtils::SysThread::prLow,

                        /**
                         * Повышенный приоритет.
                         */
                        tpHigh = Cntm::SpecUtils::SysThread::prHigh,

                        /**
                         * Наивысший приоритет. Может устанавливаться только root'ом.
                         */
                        tpTimeCritical = Cntm::SpecUtils::SysThread::prTimeCritical
                };


                /**
                 * Запустить поток активного объекта. Активный объект задается обычным указателем на объект. Если тип объекта не является производным от Cntm::ActiveObject, то будет выдана ошибка компиляции.
                 * 
                 * После вызова метода Start() в скобках указываются аргументы, которые следует передать запускаемому в новом потоке методу. Если аргументов нет, ставятся круглые скобки. Если после вызова метода Start() не будет второй пары скобок, то поток запущен не будет. Пример:
                 * ActiveThread::Start(this, &Class1::Thread1)(45, "Text");
                 * ActiveThread::Start(this, &Class1::Thread2)();
                 * Метод Start(...) олицетворяет идентификатор функции, а вторая пара скобок - его вызов, поэтому когда говорится о методе Start()() и подобных ему, то указывается две пары скобок.
                 * 
                 * Метод Start()() возвращает хэндл созданного потока (см. класс Cntm::ActiveThreadHandle).
                 * 
                 * Исключения:
                 * NullArgException - если указатель на активный объект равен NULL, т.е. не задан объект-владелец потока.
                 * SystemException - системная ошибка при создании нового потока.
                 * @param Object - обычный указатель на активный объект. Не должен равняться NULL.
                 * @param Method - указатель на метод активного объекта, который будет вызван в новом потоке.
                 * @param Priority - приоритет создаваемого потока. 
                 */
                template < typename MethodSignatureT >
                static SpecUtils::ActiveThreadFunctor < typename SignatureInfo < MethodSignatureT > ::FuncSign > Start(typename SignatureInfo < MethodSignatureT > ::ClassType* Object, MethodSignatureT Method, ThreadPriority Priority = tpNormal)
                {
                        // Проверка на приводимость к ActiveObject*.
                        CheckCastToActiveObject(Object);
                        
                        // Object пропускаем через RefPtr<ActiveObject> для того, чтобы убедиться, что он не в удаляемом состоянии.
                        return SpecUtils::ActiveThreadFunctor<typename SignatureInfo<MethodSignatureT>::FuncSign>
                                ((SpecUtils::SysThread::Priority)Priority, RefPtr<ActiveObject>(Object).Pointer(), GenericMethodNoRefPtr<typename SignatureInfo<MethodSignatureT>::FuncSign>(Object, Method));
                }
                
                /**
                 * Запустить поток активного объекта. Активный объект задается ссылочным указателем на объект. Если тип объекта не является производным от Cntm::ActiveObject, то будет выдана ошибка компиляции.
                 * 
                 * После вызова метода Start() в скобках указываются аргументы, которые следует передать запускаемому в новом потоке методу. Если аргументов нет, ставятся круглые скобки. Если после вызова метода Start() не будет второй пары скобок, то поток запущен не будет. Пример:
                 * ActiveThread::Start(p1, &Class1::Thread1)(45, "Text");
                 * ActiveThread::Start(p1, &Class1::Thread2)();
                 * Метод Start(...) олицетворяет идентификатор функции, а вторая пара скобок - его вызов, поэтому когда говорится о методе Start()() и подобных ему, то указывается две пары скобок.
                 * 
                 * Метод Start()() возвращает хэндл созданного потока (см. класс Cntm::ActiveThreadHandle).
                 * 
                 * Исключения:
                 * NullArgException - если ссылочный указатель на активный объект равен NULL, т.е. не задан объект-владелец потока.
                 * SystemException - системная ошибка при создании нового потока.
                 * @param Object - ссылочный указатель на активный объект. Не должен равняться NULL.
                 * @param Method - указатель на метод активного объекта, который будет вызван в новом потоке.
                 * @param Priority - приоритет создаваемого потока. 
                 */
                template < typename MethodSignatureT >
                static SpecUtils::ActiveThreadFunctor < typename SignatureInfo < MethodSignatureT > ::FuncSign > Start(
                        const RefPtr < typename SignatureInfo < MethodSignatureT > ::ClassType > & Object, 
                        MethodSignatureT Method, 
                        ThreadPriority Priority = tpNormal)
                {
                        // Проверка на приводимость к ActiveObject*.
                        CheckCastToActiveObject(Object.Pointer());
                        
                        return SpecUtils::ActiveThreadFunctor<typename SignatureInfo<MethodSignatureT>::FuncSign>
                                ((SpecUtils::SysThread::Priority)Priority, Object.Pointer(), GenericMethodNoRefPtr<typename SignatureInfo<MethodSignatureT>::FuncSign>(Object, Method));
                }       
        
        private:
        
                /**
                 * Если на данном методе произошла ошибка компиляции, то указанный объект не является активным объектом. 
                 */
                static void CheckCastToActiveObject(const ActiveObject* Ptr) {}
        };

}

#endif //CNTM_ACTIVETHREAD_H

---