Thread

The thread component enables multithreaded programming in BoxLang.

Component Signature

<bx:Thread name=[string]
action=[string]
duration=[integer]
priority=[string]
timeout=[integer]
virtual=[boolean] />

Attributes

Atrribute	Type	Required	Description	Default
name	string	false	The name of the thread.
action	string	false	The action to perform. The default value is "run". The following are the possible values: "join", "run", "sleep", "terminate".	run
duration	integer	false	The number of milliseconds to pause the thread. This attribute is required if the action attribute is set to "sleep".	0
priority	string	false	The priority of the thread. The default value is "normal". The following are the possible values: "high", "low", "normal".	normal
timeout	integer	false	The number of milliseconds to wait for the thread to finish. If the thread does not finish within the specified time, the thread is terminated. If the timeout attribute is not specified, the thread runs until it finishes.
virtual	boolean	false	If true, the thread will be a virtual thread. Default is false.	false

Examples

Script Syntax

CF9+

// do single thread stuff
bx:thread action="run" name="myThread";
bx:thread action="join" name="myThread,myOtherThread";

Tag Syntax

<bx:thread action="run" name="myThread">
 <!--- Do single thread stuff ---> 
 </bx:thread> 
 <bx:thread action="join" name="myThread,myOtherThread"/>