1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- <chapter xml:id="windows.event.h">
- <title><tt>__vic/windows/event.h</tt></title>
- <chapter xml:id="windows--Event">
- <title><tt>windows::Event</tt></title>
- <code-block lang="C++">
- class windows::Event : private non_copyable
- {
- public:
- explicit Event(bool bManualReset,
- bool bInitialSignaled = false, LPCWSTR lpName = nullptr);
- ~Event();
- void Set();
- void Reset();
- bool Wait(DWORD timeout = INFINITE) const;
- bool wait_for(std::chrono::milliseconds ms) const; // C++11
- HANDLE handle() const;
- };
- </code-block>
- <p>Wrapper for Win32 API event synchronization object.</p>
- <section><title>Class members</title>
- <synopsis>
- <prototype>explicit Event(bool bManualReset, bool bInitialSignaled = false, LPCWSTR lpName = nullptr)</prototype>
- <p>Creates the object using <tt>::CreateEvent()</tt>. Throws on error.</p>
- </synopsis>
- <synopsis>
- <prototype>~Event()</prototype>
- <p>Destroys the object.</p>
- </synopsis>
- <synopsis>
- <prototype>void Set()</prototype>
- <p>Calls <tt>::SetEvent()</tt>. Throws on error.</p>
- </synopsis>
- <synopsis>
- <prototype>void Reset()</prototype>
- <p>Calls <tt>::ResetEvent()</tt>. Throws on error.</p>
- </synopsis>
- <synopsis>
- <prototype>bool Wait(DWORD timeout = INFINITE) const</prototype>
- <p>Calls <tt>::WaitForSingleObject()</tt>. Throws on error.</p>
- </synopsis>
- <synopsis>
- <prototype>bool wait_for(std::chrono::milliseconds ms) const <sign>C++11</sign></prototype>
- <p>chrono-friendly wrapper for <tt>Wait()</tt>.</p>
- </synopsis>
- <synopsis>
- <prototype>HANDLE handle() const</prototype>
- <p>Returns Win32 API handle.</p>
- </synopsis>
- </section>
- </chapter>
- </chapter>
|