Dokumentacja klasy common::Event
[Moduł Threads]

Zdarzenie. Więcej...

#include <Threads.hpp>

Lista wszystkich składowych.

Typy publiczne
enum	TYPE { TYPE_AUTO_RESET, TYPE_MANUAL_RESET }
Metody publiczne
	Event (bool InitialState, TYPE Type)
	~Event ()
void	Set ()
	Zmienia stan na true.
void	Reset ()
	Zmienia stan na false.
void	Wait ()
	Czeka, aż stan będzie true.
bool	Test ()
	Zwraca stan.
bool	TimeoutWait (uint Milliseconds)
	Czeka, aż stan będzie true przez co najwyżej podany czas.

---

Opis szczegółowy

Zdarzenie.

Ten obiekt, wzorowany na WinAPI. Jest trochę podobny do zmiennej warunkowej, ale ma swój stan - true lub false.

---

Dokumentacja składowych wyliczanych

enum common::Event::TYPE

Wartości wyliczeń:

TYPE_AUTO_RESET	Zdarzenie samo przywróci się do false, kiedy jakiś jeden wątek doczeka się true w wywołaniu Wait. SetEvent() wznawia jeden wątek czekajacy na Wait.
TYPE_MANUAL_RESET	Zdarzenie samo nie przywróci się do false. SetEvent() wznawia wszystkie wątki czekające na Wait.

---

Dokumentacja konstruktora i destruktora

common::Event::Event	(	bool	InitialState,
		TYPE	Type
	)

common::Event::~Event

(

)

---

Dokumentacja funkcji składowych

void common::Event::Set

(

)

Zmienia stan na true.

• Event::TYPE_AUTO_RESET: Jeśli jakieś wątki czekały, wznawia jeden i przestawia z powrotem na false.
• Event::TYPE_MANUAL_RESET: Jeśli jakieś wątki czekały, wznawia je wszystkie.

void common::Event::Reset

(

)

Zmienia stan na false.

void common::Event::Wait

(

)

Czeka, aż stan będzie true.

• Jeśli już jest, zwraca sterowanie od razu.
• Event::TYPE_AUTO_RESET: Kiedy się doczeka, przestawia go z powrotem na false.

bool common::Event::Test

(

)

Zwraca stan.

Event::TYPE_AUTO_RESET: Jeśli był true, przestawia go z powrotem na false.

bool common::Event::TimeoutWait

(

uint

Milliseconds

)

Czeka, aż stan będzie true przez co najwyżej podany czas.

• Jeśli jest albo się doczeka aż będzie, zwraca true.
• Jeśli się nie doczeka przez podany czas (stan jest cały czas false), zwraca false.
• Event::TYPE_AUTO_RESET: Kiedy się doczeka na stan true, przestawia go z powrotem na false.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Threads.hpp