CEvent Class Reference
[Win32 Synchronization primitives, Win32 Kernel Objects]
Inheritance diagram for CEvent:
Collaboration diagram for CEvent:
Detailed Description
A class that wraps the operating system Event API. See here for more details.Public Types | |
| enum | ResetType { ManualReset, AutoReset } |
| Specify the type of event object. More... | |
| enum | InitialState { Signaled, NonSignaled } |
| Specify the initial state of an event object. More... | |
| enum | CreationFlags { CreateOrConnect, CreateNew, ConnectToExisting } |
| Specify how to create or connect to an existing event object. More... | |
Public Member Functions | |
| CEvent (SECURITY_ATTRIBUTES *pSecurityAttributes, ResetType resetType, InitialState initialState) | |
| Create an anonymous CEvent object for in-process use. | |
| CEvent (SECURITY_ATTRIBUTES *pSecurityAttributes, ResetType resetType, InitialState initialState, const IKernelObjectName &name, CreationFlags creationFlags=CreateOrConnect) | |
| Create a new named CEvent 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. | |
| CEvent (SECURITY_ATTRIBUTES *pSecurityAttributes, const IKernelObjectName &name) | |
| Connect to an existing named CEvent object for cross-process use. | |
| CEvent (const CEvent &rhs) | |
| CEvent & | operator= (const CEvent &rhs) |
| void | Reset () |
| Reset the event to the unsignalled state. | |
| void | Set () |
| Set the event to the signalled state. | |
| void | Pulse () |
| Pulse the event. | |
| HANDLE | GetWaitHandle () const override |
| void | Wait () const override |
| bool | Wait (Milliseconds timeout) const override |
Member Enumeration Documentation
| enum ResetType |
| enum InitialState |
| enum CreationFlags |
Constructor & Destructor Documentation
| CEvent | ( | SECURITY_ATTRIBUTES * | pSecurityAttributes, | |
| ResetType | resetType, | |||
| InitialState | initialState | |||
| ) |
Create an anonymous CEvent object for in-process use.
| CEvent | ( | SECURITY_ATTRIBUTES * | pSecurityAttributes, | |
| ResetType | resetType, | |||
| InitialState | initialState, | |||
| const IKernelObjectName & | name, | |||
| CreationFlags | creationFlags = CreateOrConnect | |||
| ) |
Create a new named CEvent 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.
| CEvent | ( | SECURITY_ATTRIBUTES * | pSecurityAttributes, | |
| const IKernelObjectName & | name | |||
| ) |
Connect to an existing named CEvent object for cross-process use.
Member Function Documentation
| void Reset | ( | ) |
Reset the event to the unsignalled state.
| void Set | ( | ) |
Set the event to the signalled state.
| void Pulse | ( | ) |
Pulse the event.
| HANDLE GetWaitHandle | ( | ) | const [override] |
| void Wait | ( | ) | const [override] |
| bool Wait | ( | Milliseconds | timeout | ) | const [override] |
