CManualResetEvent Class Reference
[Win32 Synchronization primitives, Win32 Kernel Objects]
Inheritance diagram for CManualResetEvent:
Collaboration diagram for CManualResetEvent:
Detailed Description
A class that wraps the operating system Event API and exposes just the interface for an manual reset event.Public Member Functions | |
| CManualResetEvent (CEvent::InitialState initialState=CEvent::NonSignaled, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr) | |
| Create an anonymous CManualResetEvent object for in-process use. | |
| CManualResetEvent (const IKernelObjectName &name, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr, CEvent::InitialState initialState=CEvent::NonSignaled) | |
| Create a new named CManualResetEvent object or connect to an existing one with the same name, for cross-process use. | |
| CManualResetEvent (const IKernelObjectName &name, CEvent::CreationFlags creationFlags, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr, CEvent::InitialState initialState=CEvent::NonSignaled) | |
| Create a new named CManualResetEvent object or connect to an existing one with the same name, for cross-process use. Use the CreationFlags to force creation only or connection only if required. | |
| CManualResetEvent (const CManualResetEvent &rhs) | |
| CManualResetEvent & | operator= (const CManualResetEvent &rhs) |
| void | Set () |
| Set the event to the signalled state. | |
| void | Reset () |
| Resets the event to the unsignalled state. | |
| void | Pulse () |
| Pulse the event. Releases all waiting threads and resets the event. | |
| HANDLE | GetWaitHandle () const override |
| void | Wait () const override |
| bool | Wait (Milliseconds timeout) const override |
Constructor & Destructor Documentation
| CManualResetEvent | ( | CEvent::InitialState | initialState = CEvent::NonSignaled, |
|
| SECURITY_ATTRIBUTES * | pSecurityAttributes = nullptr | |||
| ) | [explicit] |
Create an anonymous CManualResetEvent object for in-process use.
| CManualResetEvent | ( | const IKernelObjectName & | name, | |
| SECURITY_ATTRIBUTES * | pSecurityAttributes = nullptr, |
|||
| CEvent::InitialState | initialState = CEvent::NonSignaled | |||
| ) | [explicit] |
Create a new named CManualResetEvent object or connect to an existing one with the same name, for cross-process use.
| CManualResetEvent | ( | const IKernelObjectName & | name, | |
| CEvent::CreationFlags | creationFlags, | |||
| SECURITY_ATTRIBUTES * | pSecurityAttributes = nullptr, |
|||
| CEvent::InitialState | initialState = CEvent::NonSignaled | |||
| ) |
Create a new named CManualResetEvent object or connect to an existing one with the same name, for cross-process use. Use the CreationFlags to force creation only or connection only if required.
| CManualResetEvent | ( | const CManualResetEvent & | rhs | ) |
Member Function Documentation
| CManualResetEvent& operator= | ( | const CManualResetEvent & | rhs | ) |
| void Set | ( | ) |
Set the event to the signalled state.
| void Reset | ( | ) |
Resets the event to the unsignalled state.
| void Pulse | ( | ) |
Pulse the event. Releases all waiting threads and resets the event.
| HANDLE GetWaitHandle | ( | ) | const [override] |
| void Wait | ( | ) | const [override] |
| bool Wait | ( | Milliseconds | timeout | ) | const [override] |
