#include <pithread.h>

Граф наследования:PIThread:

Открытые типы
enum	Priority { piLowerst , piLow , piNormal , piHigh , piHighest }
	Приоритет потока Подробнее...

Открытые члены
	PIThread (void *data, ThreadFunc func, bool startNow=false, PISystemTime loop_delay={})
	Создает поток с данными "data", функцией "func" и задержкой цикла "loop_delay".

	PIThread (std::function< void()> func, bool startNow=false, PISystemTime loop_delay={})
	Создает поток с функцией "func" и задержкой цикла "loop_delay".

	PIThread (bool startNow=false, PISystemTime loop_delay={})
	Создает поток с задержкой цикла "loop_delay".

bool	start ()
	Запускает поток

bool	start (PISystemTime loop_delay)
	Запускает поток

bool	start (ThreadFunc func)
	Запускает поток

bool	start (ThreadFunc func, PISystemTime loop_delay)
	Запускает поток

bool	start (std::function< void()> func)
	Запускает поток

bool	start (std::function< void()> func, PISystemTime loop_delay)
	Запускает поток

bool	startOnce ()
	Запускает поток без внутреннего цикла Подробнее...

bool	startOnce (ThreadFunc func)
	Запускает поток без внутреннего цикла Подробнее...

bool	startOnce (std::function< void()> func)
	Запускает поток без внутреннего цикла

bool	stopAndWait (PISystemTime timeout={})
	Останавливает поток и ожидает завершения. Возвращает false если таймаут истек.

void	setData (void *d)
	Устанавливает данные, передаваемые в функцию потока

void	setSlot (ThreadFunc func)
	Устанавливает функцию потока, вызываемую после каждого run()

void	setSlot (std::function< void()> func)
	Устанавливает функцию потока, вызываемую после каждого run()

void	setPriority (PIThread::Priority prior)
	Устанавливает приоритет потока

void *	data () const
	Возвращает данные, передаваемые в функцию потока

PIThread::Priority	priority () const
	Возвращает приоритет потока

bool	isRunning () const
	Возвращает исполняется ли поток

bool	isStopping () const
	Возвращает останавливается ли поток

bool	waitForStart (PISystemTime timeout={})
	Ожидает старта потока

bool	waitForStart (int timeout_msecs) DEPRECATEDM("use waitForStart(PISystemTime)")

bool	waitForFinish (PISystemTime timeout={})
	Ожидает завершения потока. Возвращает false если таймаут истек.

bool	waitForFinish (int timeout_msecs) DEPRECATEDM("use waitForFinish(PISystemTime)")

void	needLockRun (bool need)
	Устанавливает необходимость блокировки внутреннего мьютекса каждый run()

PIMutex &	mutex () const
	Возвращает внутренний мьютекс

llong	tid () const
	Возвращает ID потока

Открытые члены унаследованные от PIObject
	PIObject (const PIString &name=PIString())
	Создает PIObject с именем "name".

PIString	name () const
	Возвращает имя объекта

virtual const char *	className () const
	Возвращает имя класса объекта

virtual const char *	parentClassName () const
	Возвращает имя родительского класса

bool	debug () const
	Возвращает включен ли вывод piCoutObj для этого объекта

void	setName (const PIString &name)
	Устанавливает имя объекта

void	setDebug (bool debug)
	Включает или отключает вывод piCoutObj для этого объекта

PIVariant	property (const char *name) const
	Возвращает свойство объекта по имени "name".

void	setProperty (const char *name, const PIVariant &value)
	Устанавливает у объекта свойство по имени "name" в "value". Если такого свойства нет, оно добавляется

bool	isPropertyExists (const char *name) const
	Возвращает присутствует ли свойство по имени "name".

PIStringList	scopeList () const
	Возвращает цепочку наследования объекта (вместе с классом самого объекта)

void	piDisconnect (const PIString &sig, PIObject dest, void ev_h)
	Разрывает все соединения от события "sig" к объекту "dest" и обработчику "ev_h".

void	piDisconnect (const PIString &sig, PIObject *dest)
	Разрывает все соединения от события "sig" к объекту "dest".

void	piDisconnect (const PIString &sig)
	Разрывает все соединения от события "sig".

bool	isPIObject () const
	Возвращает действительный ли это PIObject (проверяет подпись)

template<typename T >
bool	isTypeOf () const
	Возвращает действительный ли это наследник PIObject типа "T" (проверяет подпись и имя класса)

template<typename T >
T *	cast () const
	Возвращает преобразование к типу T если это действительный наследник типа "T" (проверяет через isTypeOf()), или "nullptr".

void	callQueuedEvents ()
	Выполнить все отложенные события от CONNECTU_QUEUED соединений

bool	maybeCallQueuedEvents ()
	Если было хотя бы одно CONNECTU_QUEUED соединение с исполнителем this, то выполнить события Подробнее...

void	deleteLater ()
	Пометить объект на удаление Подробнее...

void	deleted (PIObject *o)
	Вызывается перед удалением объекта Подробнее...

Открытые статические члены
static void	runOnce (PIObject object, const char handler, const PIString &name=PIString())
	Вызывает обработчик "handler" объекта "object" в отдельном потоке Подробнее...

static void	runOnce (std::function< void()> func, const PIString &name=PIString())
	Вызывает лямбда-выражение "func" в отдельном потоке Подробнее...

Открытые статические члены унаследованные от PIObject
static void	piDisconnect (PIObject src, const PIString &sig, PIObject dest, void *ev_h)
	Разрывает все соединения от события "sig" объекта "src" к объекту "dest" и обработчику "ev_h".

static void	piDisconnect (PIObject src, const PIString &sig, PIObject dest)
	Разрывает все соединения от события "sig" объекта "src" к объекту "dest".

static void	piDisconnect (PIObject *src, const PIString &sig)
	Разрывает все соединения от события "sig" объекта "src".

static PIObject *	findByName (const PIString &name)
	Returns PIObject* with name "name" or 0, if there is no object found.

static bool	isPIObject (const PIObject *o)
	Возвращает действительный ли "o" PIObject (проверяет подпись)

template<typename T >
static bool	isTypeOf (const PIObject *o)
	Возвращает действительный ли "o" наследник PIObject типа "T" (проверяет подпись и имя класса)

Защищенные члены
virtual void	begin ()
	Метод выполняется один раз при старте потока

virtual void	run ()
	Метод выполняется каждые "loop_delay" миллисекунд

virtual void	end ()
	Метод выполняется один раз при остановке потока

Защищенные члены унаследованные от PIObject
PIObject *	emitter () const
	Возвращает PIObject* который вызвал это событие. Значение допустимо только из методов обработчиков событий

virtual void	propertyChanged (const char *name)
	Виртуальная функция, вызывается после изменения любого свойства.

Handlers
void	stop ()
	Останавливает поток Подробнее...

void	terminate ()
	Жёстко прерывает поток Подробнее...

void	lock () const
	Блокирует внутренний мьютекс

void	unlock () const
	Разблокирует внутренний мьютекс

Events
void	started ()
	Вызывается при старте потока

void	stopped ()
	Вызывается при завершении потока

Дополнительные унаследованные члены
Относящиеся к классу функции унаследованные от PIObject
#define	piCoutObj
	Макрос для условного (piDebug && PIObject::debug()) вывода в PICout(StdOut) для наследников PIObject.

#define	piCerrObj
	Макрос для условного (piDebug && PIObject::debug()) вывода в PICout(StdErr) для наследников PIObject.

#define	PIOBJECT(name)
	Необходимо использовать этот макрос после объявления класса для использования событийной системы и корректного вывода piCoutObj.

#define	EVENT_HANDLER0(ret, name) ret name()
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name()

#define	EVENT_HANDLER1(ret, name, type0, var0) ret name(type0 var0)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0)

#define	EVENT_HANDLER2(ret, name, type0, var0, type1, var1) ret name(type0 var0, type1 var1)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1)

#define	EVENT_HANDLER3(ret, name, type0, var0, type1, var1, type2, var2) ret name(type0 var0, type1 var1, type2 var2)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_HANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_HANDLER EVENT_HANDLER0
	Аналог EVENT_HANDLER0.

#define	EVENT_VHANDLER0(ret, name) virtual ret name()
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name()

#define	EVENT_VHANDLER1(ret, name, type0, var0) virtual ret name(type0 var0)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0)

#define	EVENT_VHANDLER2(ret, name, type0, var0, type1, var1) virtual ret name(type0 var0, type1 var1)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1)

#define	EVENT_VHANDLER3(ret, name, type0, var0, type1, var1, type2, var2) virtual ret name(type0 var0, type1 var1, type2 var2)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_VHANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_VHANDLER EVENT_VHANDLER0
	Аналог EVENT_VHANDLER0.

#define	EVENT0(name) void name();
	Объявляет событие с именем "name", void name();.

#define	EVENT1(name, type0, var0) void name(type0 var0);
	Объявляет событие с именем "name", void name(type0 var0);.

#define	EVENT2(name, type0, var0, type1, var1) void name(type0 var0, type1 var1);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1);.

#define	EVENT3(name, type0, var0, type1, var1, type2, var2) void name(type0 var0, type1 var1, type2 var2);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1, type2 var2);.

#define	EVENT4(name, type0, var0, type1, var1, type2, var2, type3, var3) void name(type0 var0, type1 var1, type2 var2, type3 var3);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);.

#define	EVENT EVENT0
	Аналог EVENT0.

#define	CONNECTU(src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" объекта "dest". Подробнее...

#define	CONNECTU_QUEUED(src, event, dest, handler, performer)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" объекта "dest". Подробнее...

#define	CONNECTL(src, event, functor)
	Соединяет событие "event" объекта "src" к лямбда-функции "functor". Подробнее...

#define	CONNECT0(ret, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...

#define	CONNECT1(ret, type0, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...

#define	CONNECT2(ret, type0, type1, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...

#define	CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...

#define	CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...

#define	CONNECT CONNECT0
	Аналог CONNECT0. Подробнее...

#define	WEAK_CONNECT0(ret, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...

#define	WEAK_CONNECT1(ret, type0, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...

#define	WEAK_CONNECT2(ret, type0, type1, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...

#define	WEAK_CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...

#define	WEAK_CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...

#define	WEAK_CONNECT WEAK_CONNECT0
	Аналог WEAK_CONNECT0. Подробнее...

#define	DISCONNECT0(ret, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"

#define	DISCONNECT1(ret, type0, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"

#define	DISCONNECT2(ret, type0, type1, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"

#define	DISCONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"

#define	DISCONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"

#define	DISCONNECT DISCONNECT0
	Аналог DISCONNECT0.

#define	HANDLER(handler)
	Возвращает указатель на обработчик события "handler".

Подробное описание

Класс потока

Этот класс позволяет выполнять код из параллельного потока.

Краткий обзор

Многопоточность позволяет исполнять код в нескольких потоках одновременно и использовать все ядра современных процессоров. Однако это таит в себе опасности.

Этот класс предоставляет виртуальные методы begin(), run() и end(), которые описывают старт, выполнение и завершение потоковой задачи. Все эти методы исполняются в отдельном потоке. Когда выполняется start(int), PIThread создает отдельный поток средствами ОС и последовательно выполняет begin(), run() и end(). Можно переопределить каждый метод для реализации нужной задачи.

Схема выполнения методов:

virtual begin()
event started()
while (isRunning()) {     // while not stop()
    virtual run()
    ThreadFunc()          // Slot or lambda
    piMSleep(loop_delay)  // if loop_delay > 0
}
event stopped()
virtual end()

Если внутренний цикл не нужен, то можно использовать метод startOnce() вместо start(int).

В этом случает схема выполнения следущая:

virtual begin()
event started()
virtual run()
ThreadFunc()    // Slot or lambda
event stopped()
virtual end()

В отличии от прямого использования "pthread" или похожих механизмов нет необходимости писать свой цикл внутри поточного метода и ожидать в его теле. PIThread уже рализует такой цикл, необходимо лишь установить значение ожидания в конструкторе или при запуске потока, и переопределить методы begin(), run() и end().

Использование с внутренним циклом

class MyThread: public PIThread {
    PIOBJECT_SUBCLASS(MyThread, PIThread)
public:
    void begin() override {piCout << "thread begin";}
    void run() override {piCout << "thread run" << ++cnt;}
    void end() override {piCout << "thread end";}
private:
    int cnt = 0;
};
 
int main(int argc, char * argv[]) {
    MyThread mt;
    mt.start(100);
    piMSleep(500);
    mt.stop(true);
    return 0;
}
 
// thread begin
// thread run 1
// thread run 2
// thread run 3
// thread run 4
// thread run 5
// thread end

Использование без внутреннего цикла

class MyThread: public PIThread {
    PIOBJECT_SUBCLASS(MyThread, PIThread)
public:
    void begin() override {piCout << "thread begin";}
    void run() override {piCout << "thread run" << ++cnt;}
    void end() override {piCout << "thread end";}
private:
    int cnt = 0;
};
 
int main(int argc, char * argv[]) {
    MyThread mt;
    mt.startOnce();
    piMSleep(500);
    mt.stop(true);
    return 0;
}
 
// thread begin
// thread run 1
// thread end

Использование без наследования

Возможно использовать PIThread без наследования. Можно передать ему в конструкторе или при запуске указатель на внешний метод "ThreadFunc". В основном цикле потока, если "ThreadFunc" существует, он будет вызываться после run().

ThreadFunc может быть любым статическим методом в формате "void func(void * data)", либо лямбда-выражение в формате [...]( ){...}. "Data" является произвольным указателем, задаваемым в конструкторе или методом setData().

Также можно присоединиться к событию started(), но в этом случае надо будет своими силами реализовать весь цикл, т.к. это событие вызывается один раз после запуска потока.

Использование с внутренним циклом

void myThreadFunc(void * d) {
    int * cnt = (int*)d;
    piCout << "thread run" << ++(*cnt);
}
 
int main(int argc, char * argv[]) {
    int cnt = 0;
    PIThread mt;
    mt.setData(&cnt);
    mt.start(myThreadFunc, 100);
    piMSleep(500);
    mt.stop(true);
    return 0;
}
 
// thread run 1
// thread run 2
// thread run 3
// thread run 4
// thread run 5

Использование без внутреннего цикла

void myThreadFunc(void * d) {
    int * cnt = (int*)d;
    piCout << "thread run" << ++(*cnt);
}
 
int main(int argc, char * argv[]) {
    int cnt = 0;
    PIThread mt;
    mt.setData(&cnt);
    mt.startOnce(myThreadFunc);
    piMSleep(500);
    mt.stop(true);
    return 0;
}
 
// thread run 1

Использование с лямбда-выражением

int main(int argc, char * argv[]) {
    int cnt = 0;
    PIThread mt;
    mt.start([&cnt](){
        piCout << "thread run" << ++cnt;
    }, 100);
    piMSleep(500);
    mt.stop(true);
    return 0;
}
 
// thread run 1
// thread run 2
// thread run 3
// thread run 4
// thread run 5

Использование с событием

class MyObj: public PIObject {
    PIOBJECT(MyObj)
public:
    EVENT_HANDLER(void, threadRun) {
        piForTimes (5) {
            piCout << "threadRun" << ++cnt;
            piMSleep(100);
        }
    };
private:
    int cnt = 0;
};
 
int main(int argc, char * argv[]) {
    MyObj mo;
    PIThread mt;
    CONNECTU(&mt, started, &mo, threadRun);
    mt.startOnce();
    mt.stop(true);
    return 0;
}
 
// threadRun 1
// threadRun 2
// threadRun 3
// threadRun 4
// threadRun 5

Блокировки

PIThread имеет встроенный мьютекс, который может блокироваться и разблокироваться каждый run() при установленном needLockRun(true). К нему есть доступ через методы lock(), unlock() и mutex(). Использование этих методов вне потока совместно с needLockRun(true) поможет защитить данные.

Перечисления

◆ Priority

enum PIThread::Priority

Приоритет потока

Элементы перечислений
piLowerst	Низший
piLow	Низкий
piNormal	Нормальный, это приоритет по умолчанию для потоков и таймеров
piHigh	Высокий
piHighest	Высший

Методы

◆ startOnce() [1/2]

bool PIThread::startOnce ( )

Запускает поток без внутреннего цикла

Начинает выполнение run() один раз. Также поток вызывает внешний метод, заданный через setSlot(), если он существует.

Возвращает: false если поток уже запущен или не может запуститься

◆ startOnce() [2/2]

bool PIThread::startOnce ( ThreadFunc func )

Запускает поток без внутреннего цикла

Перегрузка метода, устанавливает внешний метод в "func" перед запуском.

Возвращает: false если поток уже запущен или не может запуститься

◆ stop()

void PIThread::stop ( )

Останавливает поток

Помечает поток на остановку и ожидает завершения если "wait" true. Поток может быть остановлен только вне run() или внешнего метода.

Предупреждения: Этот метод может ожидать бесконечно если "wait" true и любой из потоковых методов занят навечно.

◆ terminate()

void PIThread::terminate ( )

Жёстко прерывает поток

Немедленно останавливает поток.

Предупреждения: Это может повредить память, старайтесь не использовать этот метод!

◆ waitForStart()

bool PIThread::waitForStart ( int timeout_msecs = -1 )

inline

Блокирует до тех пор, пока поток не запустится в течении "timeout_msecs", или бесконечно, если "timeout_msecs" < 0

Возвращает: true если поток запустился менее чем за таймаут; false если таймаут истёк

◆ waitForFinish()

bool PIThread::waitForFinish ( int timeout_msecs = -1 )

inline

Блокирует до тех пор, пока поток не завершится в течении "timeout_msecs", или бесконечно, если "timeout_msecs" < 0

Возвращает: true если поток завершился менее чем за таймаут; false если таймаут истёк

◆ runOnce() [1/2]

void PIThread::runOnce	(	PIObject *	object,
		const char *	handler,
		const PIString &	name = `PIString()`
	)

static

Вызывает обработчик "handler" объекта "object" в отдельном потоке

Этот метод создает PIThread с именем "name" и выполняет обработчик "handler" объекта "object" в этом потоке.
PIThread автоматически удаляется после завершения обработчика.

class MyObj: public PIObject {
    PIOBJECT(MyObj)
public:
    EVENT_HANDLER(void, threadRun) {
        piForTimes (5) {
            piCout << "threadRun";
            piMSleep(100);
        }
    };
};
 
int main(int argc, char * argv[]) {
    MyObj mo;
    PIThread::runOnce(&mo, "threadRun");
    piMSleep(1000); // wait for thread finish
    return 0;
}

◆ runOnce() [2/2]

void PIThread::runOnce	(	std::function< void()>	func,
		const PIString &	name = `PIString()`
	)

static

Вызывает лямбда-выражение "func" в отдельном потоке

Этот метод создает PIThread с именем "name" и выполняет лямбда-выражение "func" в этом потоке.
PIThread автоматически удаляется после завершения функции.
"func" не должна иметь аргументов.

PIThread::runOnce([](){
    piForTimes(5) {
        piCout << "thread func";
        piMSleep(100);
    }
});
piMSleep(1000);

Открытые типы

Открытые члены

Открытые статические члены

Защищенные члены

Handlers

Events

Дополнительные унаследованные члены