Dokumentacja klasy common::Thread
[Moduł Threads]

Klasa bazowa wątku. Więcej...

#include <Threads.hpp>

Lista wszystkich składowych.

Priorytet wątku
Prioritytet wątku jest liczbą całkowitą. Te stałe to niektóre wartości. Mogą być też inne. Ustawianie i pobieranie priotytetu wątku działa tylko między Start() a Join().
static const int	PRIORITY_IDLE
static const int	PRIORITY_VERY_LOW
static const int	PRIORITY_LOW
static const int	PRIORITY_DEFAULT
static const int	PRIORITY_HIGH
static const int	PRIORITY_VERY_HIGH
static const int	PRIORITY_REALTIME
void	SetPriority (int Priority)
int	GetPriority ()
Metody publiczne
	Thread ()
virtual	~Thread ()
void	Start ()
	Uruchamiamia wątek.
void	Join ()
	Czeka na zakończenie wątku.
void	Kill ()
	Brutalnie zabija wątek - nie używać!
bool	IsRunning ()
	Zwraca true, jeśli wątek jest w tej chwili uruchomiony i naprawdę jeszcze działa.
void	Pause ()
	Zatrzymuje wątek, wznawia wątek (posiada wewnętrzny licznik zatrzymań).
void	Resume ()
Metody chronione
virtual void	Run ()=0
	Napisz swoją wersję z kodem, który ma się wykonać w osobnym wątku.
void	Exit ()
	Kończy działanie wątku.
void	Yield_ ()
	Oddaje sterowanie innemu wątkowi.
Przyjaciele
class	Thread_pimpl

---

Opis szczegółowy

Klasa bazowa wątku.

• Odziedzicz po tej klasie, żeby zdefiniować własny typ wątku. Nadpisać metodę Thread::Run().
• Obiekt tej klasy reprezentuje pojedynczy wątek.
• Wątek można odpalić jeden raz - Thread::Start().
• Przed zniszczeniem obiektu na odpalony wątek trzeba poczekać - Thread::Join().
• Obiekt można tworzyć na stosie lub na stercie - obojętne.
• Obiekt, jeśli alokowany new, trzeba zniszczyć delete - sam się nie zniszczy.

---

Dokumentacja konstruktora i destruktora

common::Thread::Thread

(

)

virtual common::Thread::~Thread

(

)

[virtual]

---

Dokumentacja funkcji składowych

virtual void common::Thread::Run

(

)

[protected, pure virtual]

Napisz swoją wersję z kodem, który ma się wykonać w osobnym wątku.

void common::Thread::Exit

(

)

[protected]

Kończy działanie wątku.

• Wywoływać z funkcji Run().
• Lepiej jednak normalnie zakończyć funkcję Run. Stosowanie Exit() nie ma sensu i jest niebezpieczne dla zasobów.

void common::Thread::Yield_

(

)

[protected]

Oddaje sterowanie innemu wątkowi.

• Wywoływać z funkcji Run().
• Nazwa taka dziwna, bo jakiś cham zdefiniował makro o nazwie Yield!

void common::Thread::Start

(

)

Uruchamiamia wątek.

void common::Thread::Join

(

)

Czeka na zakończenie wątku.

• Jeśli wątek już się zakończył, wychodzi od razu.
• Jeśli wątek jeszcze nie był odpalony albo już raz było testowane Join(), nic się nie dzieje.

void common::Thread::Kill

(

)

Brutalnie zabija wątek - nie używać!

bool common::Thread::IsRunning

(

)

Zwraca true, jeśli wątek jest w tej chwili uruchomiony i naprawdę jeszcze działa.

void common::Thread::Pause

(

)

Zatrzymuje wątek, wznawia wątek (posiada wewnętrzny licznik zatrzymań).

• Działa tylko między Start() a Join().
• Raczej nie ma sensu tego używać.

void common::Thread::Resume

(

)

void common::Thread::SetPriority

(

int

Priority

)

int common::Thread::GetPriority

(

)

---

Dokumentacja przyjaciół i funkcji związanych

friend class Thread_pimpl [friend]

---

Dokumentacja atrybutów składowych

const int common::Thread::PRIORITY_IDLE [static]

const int common::Thread::PRIORITY_VERY_LOW [static]

const int common::Thread::PRIORITY_LOW [static]

const int common::Thread::PRIORITY_DEFAULT [static]

const int common::Thread::PRIORITY_HIGH [static]

const int common::Thread::PRIORITY_VERY_HIGH [static]

const int common::Thread::PRIORITY_REALTIME [static]

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Threads.hpp