83 lines
2.9 KiB
Haxe
83 lines
2.9 KiB
Haxe
|
/*
|
||
|
|
* Copyright (C)2005-2019 Haxe Foundation
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
||
|
|
* copy of this software and associated documentation files (the "Software"),
|
||
|
|
* to deal in the Software without restriction, including without limitation
|
||
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
||
|
|
* Software is furnished to do so, subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be included in
|
||
|
|
* all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||
|
|
* DEALINGS IN THE SOFTWARE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
package sys.thread;
|
||
|
|
|
||
|
|
#if (!target.threaded)
|
||
|
|
#error "This class is not available on this target"
|
||
|
|
#end
|
||
|
|
|
||
|
|
private typedef ThreadImpl = {};
|
||
|
|
|
||
|
|
extern abstract Thread(ThreadImpl) from ThreadImpl {
|
||
|
|
/**
|
||
|
|
Event loop of this thread (if available).
|
||
|
|
|
||
|
|
Note that by default event loop is only available in the main thread.
|
||
|
|
To setup an event loop in other threads use `sys.thread.Thread.runWithEventLoop`
|
||
|
|
or create new threads with built-in event loops using `sys.thread.Thread.createWithEventLoop`
|
||
|
|
**/
|
||
|
|
public var events(get,never):EventLoop;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Send a message to the thread queue. This message can be read by using `readMessage`.
|
||
|
|
**/
|
||
|
|
public function sendMessage(msg:Dynamic):Void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns the current thread.
|
||
|
|
**/
|
||
|
|
public static function current():Thread;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Creates a new thread that will execute the `job` function, then exit.
|
||
|
|
|
||
|
|
This function does not setup an event loop for a new thread.
|
||
|
|
**/
|
||
|
|
public static function create(job:()->Void):Thread;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Simply execute `job` if current thread already has an event loop.
|
||
|
|
|
||
|
|
But if current thread does not have an event loop: setup event loop,
|
||
|
|
run `job` and then destroy event loop. And in this case this function
|
||
|
|
does not return until no more events left to run.
|
||
|
|
**/
|
||
|
|
public static function runWithEventLoop(job:()->Void):Void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
This is logically equal to `Thread.create(() -> Thread.runWithEventLoop(job));`
|
||
|
|
**/
|
||
|
|
public static function createWithEventLoop(job:()->Void):Thread;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reads a message from the thread queue. If `block` is true, the function
|
||
|
|
blocks until a message is available. If `block` is false, the function
|
||
|
|
returns `null` if no message is available.
|
||
|
|
**/
|
||
|
|
public static function readMessage(block:Bool):Dynamic;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Run event loop of the current thread
|
||
|
|
**/
|
||
|
|
private static function processEvents():Void;
|
||
|
|
}
|