ManualEvent (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Declaration
Using the ManualEvent variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ManualEvent (Type of variable)

In french: SignalManuel

The ManualEvent type is used to manage a manual event. A manual event is used to simplify the synchronization between several threads.

A manual event can only be modified by EventChange.

Remark: We recommend that you use an AutomaticEvent or ManualEvent variable to create an event rather than naming it by using a character string. Indeed, using a variable allows you to:

manage the variable scope,
avoid having 2 events with the same name in 2 different threads.

Versions 21 and later

This type of variable is now available in Apple Watch mode.

New in version 21

This type of variable is now available in Apple Watch mode.

Example

// MAIN THREAD
//------------------
// Define the event
s is ManualEvent
// Start the thread
ThreadExecute("Thread", threadNormal, ProcThread, s)
// Code in parallel of the thread
...
// Wait for the event triggered by the thread
EventWait("s")

// SECONDARY THREAD
// ----------------------
PROCÉDURE ProcThread(s)

// Code in the thread
...
// Unlocks the main thread
EventOpen(s)

Declaration

Declaring a manual event (simple syntax) Hide the details

MyVariable is ManualEvent

In this case, the manual event is closed when it is created.

Declaring a manual event (advanced syntax) Hide the details

MyVariable is ManualEvent(<Initial status>)

<Initial status>: Integer constant

Initial status of the event:
eventOpen The event is open when it is created.
eventClose The event is closed during its creation.

Remarks

Using the ManualEvent variables

The ManualEvent variables can be used to synchronize threads in the functions:

standard syntax:


Versions 20 and later EventClose New in version 20 EventClose EventClose	Closes a synchronization event between several threads.
Versions 20 and later EventOpen New in version 20 EventOpen EventOpen	Opens a synchronization event between several threads.
Versions 09 and later EventWait New in version 09 EventWait EventWait	Locks the current thread while waiting for the specified event to be opened.

prefixed syntax:


Versions 24 and later <ManualEvent variable>.Close New in version 24 <ManualEvent variable>.Close <ManualEvent variable>.Close	Closes a synchronization event between several threads.
Versions 24 and later <ManualEvent variable>.Wait New in version 24 <ManualEvent variable>.Wait <ManualEvent variable>.Wait	Locks the current thread while waiting for the specified event to be opened.
Versions 24 and later <ManualEvent variable>.Open New in version 24 <ManualEvent variable>.Open <ManualEvent variable>.Open	Opens a synchronization event between several threads.

During a call to EventOpen (or <ManualEvent variable>.Open), the event remains open:

all the pending threads are freed,
all the threads that will reach the event later will go through without waiting.

During a call to EventClose (or <ManualEvent variable>.Close), the event is closed: all the threads that will reach the event later will remain locked.