mbo::IEvent Class Reference

Event implementation. More...

#include <MboSynch.h>

Inheritance diagram for mbo::IEvent:

[legend]

List of all members.

Public Member Functions
virtual	~IEvent ()
virtual void	Set ()=0
virtual void	Reset ()=0
virtual void	Pulse ()=0
virtual bool	Wait (size_t nTime=INFINITE) const =0

---

Detailed Description

Event implementation.

Note:

This class is distributed under the following license GNU Lesser General Public License, version 2.1.

Definition at line 289 of file MboSynch.h.

---

Constructor & Destructor Documentation

virtual mbo::IEvent::~IEvent

(

)

[inline, virtual]

destructor

Definition at line 294 of file MboSynch.h.

{}

---

Member Function Documentation

virtual void mbo::IEvent::Set

(

)

[pure virtual]

Set the signal into the signaled state.

Implemented in mbo::CEventImpl, and mbo::CEventFake.

virtual void mbo::IEvent::Reset

(

)

[pure virtual]

Set the signal into the not signaled state.

Implemented in mbo::CEventImpl, and mbo::CEventFake.

virtual void mbo::IEvent::Pulse

(

)

[pure virtual]

Switch the signal to signaled and then -If no thread waits: switch back to not signaled. -If threads are waiting: In automatic reset mode only one thread can pass the Wait(). After this one thread the signal is switched back to not signaled. In manual reset mode all waiting threads pass Wait(). After all waiting threads have passed Wait(), the signal is switched back to not signaled.

Implemented in mbo::CEventImpl, and mbo::CEventFake.

virtual bool mbo::IEvent::Wait

(

size_t

nTime = INFINITE

)

const [pure virtual]

Pulse (wait & reset) the event.

If the signal is in signaled state: passes the function will return. If the signal is in not signaled state: wait until time elaspes. In automatic reset mode: set signal to not signaled on leaving the method.

Parameters:

nTime

time to wait in milliseconds.

Returns:

The return value is true if Wait() exits because of signaled state reached. When false is returned the time nTime (in ms) has elapsed before the signaled state has been reached.

Implemented in mbo::CEventImpl.

---

The documentation for this class was generated from the following file:

• MboSynch.h

---