Difference between revisions of "Thread"
From GiderosMobile
(removed language stuff) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
<!-- GIDEROSOBJ:Thread --> | <!-- GIDEROSOBJ:Thread --> | ||
| − | ''' | + | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform pc.png]][[File:Platform mac.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> |
| − | ''' | + | '''Available since:''' 2018.10<br/> |
| − | === | + | === Description === |
| − | + | The ''Threads'' plugin provides the ability to run Lua code in separate threads, taking advantage of multiple cores where available. | |
| − | === | + | === Example === |
| − | '''Simple example of getting result from thread | + | '''Simple example of getting result from thread''' |
<source lang="lua">require "Threads" | <source lang="lua">require "Threads" | ||
local thread = Thread.new() | local thread = Thread.new() | ||
thread:setFunction(function() | thread:setFunction(function() | ||
local a = 0 | local a = 0 | ||
| − | for i = 1, 10000000 do | + | for i = 1, 10000000 do a += 1 end |
| − | |||
| − | |||
return i | return i | ||
end) | end) | ||
thread:execute() | thread:execute() | ||
local ok = false | local ok = false | ||
| − | while not ok do | + | while not ok do ok = thread:getResult() end |
| − | |||
| − | end | ||
print("woot!") | print("woot!") | ||
</source> | </source> | ||
| Line 29: | Line 24: | ||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | + | === Methods === | |
| − | === | + | [[Thread.new]] ''creates a new thread object''<br/><!--GIDEROSMTD:Thread.new() creates a new thread object--> |
| − | [[ | + | [[Thread:setFunction]] ''sets Lua function that thread will execute''<br/><!--GIDEROSMTD:Thread:setFunction(func) sets Lua function that thread will execute--> |
| − | <!-- GIDEROSMTD:Thread.new() | + | [[Thread:execute]] ''starts/executes our thread''<br/><!--GIDEROSMTD:Thread:execute(vararg) starts/executes our thread--> |
| − | [[ | + | [[Thread:resume]] ''resumes a thread that has been yielded''<br/><!--GIDEROSMTD:Thread:resume(...) resumes a thread that has been yielded--> |
| − | <!-- GIDEROSMTD:Thread:setFunction(func) | + | [[Thread.yield]] ''pauses executions of thread (only valid inside thread function)''<br/><!--GIDEROSMTD:Thread.yield(...) pauses executions of thread (only valid inside thread function)--> |
| − | [[ | + | [[Thread:status]] ''returns current status of the thread''<br/><!--GIDEROSMTD:Thread:status() returns current status of the thread--> |
| − | <!-- GIDEROSMTD:Thread:execute(vararg) | + | [[Thread:getNumLogicalCores]] ''returns number of logical cores on host machine''<br/><!--GIDEROSMTD:Thread:getNumLogicalCores() returns number of logical cores on host machine--> |
| − | [[ | + | [[Thread:requestTermination]] ''sets a flag to terminate thread''<br/><!--GIDEROSMTD:Thread:requestTermination() sets a flag to terminate thread--> |
| − | <!-- GIDEROSMTD:Thread:resume(...) | + | [[Thread.sendData]] ''sends data for retrieval by main thread (only valid inside thread function)''<br/><!--GIDEROSMTD:Thread.sendData(...) sends data for retrieval by main thread (only valid inside thread function)--> |
| − | [[ | + | [[Thread:fetchData]] ''returns any data sent by thread sendData call''<br/><!--GIDEROSMTD:Thread:fetchData() returns any data sent by thread sendData call--> |
| − | <!-- GIDEROSMTD:Thread.yield(...) | + | [[Thread:getResults]] ''gets any results from thread''<br/><!--GIDEROSMTD:Thread:getResults(wait_time) gets any results from thread--> |
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread:status() | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread:getNumLogicalCores() | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread:requestTermination() | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread.sendData(...) | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread:fetchData() | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Thread:getResults(wait_time) | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Events === |
| − | === | + | === Constants === |
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Revision as of 20:05, 15 April 2021
Supported platforms: 
Available since: 2018.10
Description
The Threads plugin provides the ability to run Lua code in separate threads, taking advantage of multiple cores where available.
Example
Simple example of getting result from thread
require "Threads"
local thread = Thread.new()
thread:setFunction(function()
local a = 0
for i = 1, 10000000 do a += 1 end
return i
end)
thread:execute()
local ok = false
while not ok do ok = thread:getResult() end
print("woot!")
MethodsThread.new creates a new thread object |
EventsConstants |
