Dokumentacja klasy common::Mutex
[Moduł Threads]

Muteks. Więcej...

#include <Threads.hpp>

Lista wszystkich składowych.

Metody publiczne
	Mutex (uint Flag)
	~Mutex ()
void	Lock ()
	Blokuje muteks.
void	Unlock ()
	Odblokowuje muteks.
bool	TryLock ()
	Próbuje wejść do sekcji krytycznej.
bool	TimeoutLock (uint Milliseconds)
	Próbuje wejść do sekcji krytycznej czekając co najwyżej podany czas.
Statyczne atrybuty publiczne
Flagi bitowe do konstruktora
static const uint	FLAG_RECURSIVE = 0x01
	Podaj, jeśli będziesz robił w ramach jednego wątku zagnieżdżone blokowania.
static const uint	FLAG_WAIT_TIMEOUT = 0x02
	Podaj, jeśli będziesz używał metody TimeoutLock.
Przyjaciele
class	Mutex_pimpl
class	Cond

---

Opis szczegółowy

Muteks.

Obiekt do wyznaczania sekcji krytycznej na wzajemnie wykluczającą się wyłączność jednego wątku.

---

Dokumentacja konstruktora i destruktora

common::Mutex::Mutex

(

uint

Flag

)

common::Mutex::~Mutex

(

)

---

Dokumentacja funkcji składowych

void common::Mutex::Lock

(

)

Blokuje muteks.

void common::Mutex::Unlock

(

)

Odblokowuje muteks.

bool common::Mutex::TryLock

(

)

Próbuje wejść do sekcji krytycznej.

• Jeśli się uda, wchodzi blokując muteks i zwraca true.
• Jeśli się nie uda bo muteks jest zablokowany przez inny wątek, nie blokuje sterowania tylko zawraca false.

bool common::Mutex::TimeoutLock

(

uint

Milliseconds

)

Próbuje wejść do sekcji krytycznej czekając co najwyżej podany czas.

• Jeśli się uda, wchodzi blokując muteks i zwraca true.
• Jeśli się nie uda przez podany czas, bo muteks jest zablokowany przez inny wątek, zwraca false.

---

Dokumentacja przyjaciół i funkcji związanych

friend class Mutex_pimpl [friend]

friend class Cond [friend]

---

Dokumentacja atrybutów składowych

const uint common::Mutex::FLAG_RECURSIVE = 0x01 [static]

Podaj, jeśli będziesz robił w ramach jednego wątku zagnieżdżone blokowania.

const uint common::Mutex::FLAG_WAIT_TIMEOUT = 0x02 [static]

Podaj, jeśli będziesz używał metody TimeoutLock.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Threads.hpp