Programming Reference:WaitableEvent Class - Revision history

Mellinger: /* bool Wait([TimeInterval timeout]) */

2023-04-18T15:13:03Z

bool Wait([TimeInterval timeout])

← Older revision		Revision as of 15:13, 18 April 2023
Line 14:		Line 14:
	Resets the event to non-signaled state. Call <tt>Reset()</tt> immediately after <tt>Wait()</tt> to emulate the behavior of a Windows auto-reset event. Returns true when successful, false otherwise.		Resets the event to non-signaled state. Call <tt>Reset()</tt> immediately after <tt>Wait()</tt> to emulate the behavior of a Windows auto-reset event. Returns true when successful, false otherwise.
	===bool Wait([TimeInterval timeout])===		===bool Wait([TimeInterval timeout])===
	Waits for the event to become signaled. Does nothing when the event is currently in signaled state. When a timeout is specified, waits ~~for~~ the specified ~~number~~ of ~~milliseconds~~. Returns true when the event is signaled, and false otherwise (error or timeout occurred).		Waits for the event to become signaled. Does nothing when the event is currently in signaled state. When a timeout is specified, waits no longer than the specified amount of time. Returns true when the event is signaled, and false otherwise (error or timeout occurred).

	==See also==		==See also==

Mellinger: /* Location */

2023-04-18T15:12:16Z

Location

← Older revision		Revision as of 15:12, 18 April 2023
Line 1:		Line 1:
	==Location==		==Location==
	<tt>BCI2000/src/shared/utils</tt>		<tt>BCI2000/src/shared/utils/Lib</tt>

	==Synopsis==		==Synopsis==

Mellinger: /* See also */

2023-04-18T15:11:57Z

Mellinger: Mellinger moved page Programming Reference:OSEvent Class to Programming Reference:WaitableEvent Class: Renaming of class

2022-06-08T16:37:35Z

Mellinger moved page Programming Reference:OSEvent Class to Programming Reference:WaitableEvent Class: Renaming of class

← Older revision		Revision as of 16:37, 8 June 2022
(No difference)

Mellinger: /* bool Wait([number timeout]) */

2022-06-08T16:33:27Z

bool Wait([number timeout])

← Older revision		Revision as of 16:33, 8 June 2022
Line 13:		Line 13:
	===bool Reset()===		===bool Reset()===
	Resets the event to non-signaled state. Call <tt>Reset()</tt> immediately after <tt>Wait()</tt> to emulate the behavior of a Windows auto-reset event. Returns true when successful, false otherwise.		Resets the event to non-signaled state. Call <tt>Reset()</tt> immediately after <tt>Wait()</tt> to emulate the behavior of a Windows auto-reset event. Returns true when successful, false otherwise.
	===bool Wait([~~number~~ timeout])===		===bool Wait([TimeInterval timeout])===
	Waits for the event to become signaled. Does nothing when the event is currently in signaled state. When a timeout is specified, waits for the specified number of milliseconds. Returns true when the event is signaled, and false otherwise (error or timeout occurred).		Waits for the event to become signaled. Does nothing when the event is currently in signaled state. When a timeout is specified, waits for the specified number of milliseconds. Returns true when the event is signaled, and false otherwise (error or timeout occurred).

Mellinger at 16:29, 8 June 2022

2022-06-08T16:29:11Z

← Older revision		Revision as of 16:29, 8 June 2022
Line 3:		Line 3:

	==Synopsis==		==Synopsis==
	The <tt>~~OSEvent~~</tt> class provides a ~~wrapper~~ for ~~OS-dependent synchronization functionality~~. The underlying functionality corresponds to a manual-reset event in Windows~~; on Unix systems, equivalent behavior is achieved using a POSIX threads condition variable~~.		The <tt>WaitableEvent</tt> class provides a mechanism to synchronize threads by waiting for another thread to signal the <tt>WaitableEvent</tt>. The underlying functionality corresponds to a manual-reset event in Windows.

	==Methods==		==Methods==
	===~~OSEvent~~()===		===WaitableEvent()===
	Events are created in non-signaled state.		Events are created in non-signaled state.
	===~~~OSEvent~~()===		===~WaitableEvent()===
	Releases all resources allocated for the event object.		Releases all resources allocated for the event object.
	===bool Set()===		===bool Set()===

Mellinger: Programming Reference::OSEvent Class moved to Programming Reference:OSEvent Class: typo in original page title

2011-05-02T14:49:04Z

Programming Reference::OSEvent Class moved to Programming Reference:OSEvent Class: typo in original page title

← Older revision		Revision as of 14:49, 2 May 2011
(No difference)

Mellinger at 14:48, 2 May 2011

2011-05-02T14:48:41Z

New page

==Location==
<tt>BCI2000/src/shared/utils</tt>

==Synopsis==
The <tt>OSEvent</tt> class provides a wrapper for OS-dependent synchronization functionality. The underlying functionality corresponds to a manual-reset event in Windows; on Unix systems, equivalent behavior is achieved using a POSIX threads condition variable.

==Methods==
===OSEvent()===
Events are created in non-signaled state.
===~OSEvent()===
Releases all resources allocated for the event object.
===bool Set()===
Sets the event to signaled state. When one or more threads are blocked waiting for the event, they are released in random order. As long as the event is in signaled state, threads calling its <tt>Wait()</tt> function will not be blocked. Returns true when successful, false otherwise.
===bool Reset()===
Resets the event to non-signaled state. Call <tt>Reset()</tt> immediately after <tt>Wait()</tt> to emulate the behavior of a Windows auto-reset event. Returns true when successful, false otherwise.
===bool Wait([number timeout])===
Waits for the event to become signaled. Does nothing when the event is currently in signaled state. When a timeout is specified, waits for the specified number of milliseconds. Returns true when the event is signaled, and false otherwise (error or timeout occurred).

==See also==
[[Programming Reference:OSThread Class]], [[Programming Reference:OSMutex Class]]

[[Category:Framework API]][[Category:Development]]

← Older revision		Revision as of 15:11, 18 April 2023
Line 17:		Line 17:

	==See also==		==See also==
	[[Programming Reference:~~OSThread Class]], [[Programming Reference:OSMutex~~ Class]]		[[Programming Reference:Thread Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]