mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-09-06 17:59:48 +00:00
Code Issues Projects Releases Wiki Activity

Builtin thread-local object storage for AsyncTask (#1)

Browse Source 
* Added AsyncTask::fetchLocal()
This commit is contained in:
SOFe
2016-11-06 22:02:53 +08:00
committed by GitHub
parent 3b7377370c
commit 074583d104
3 changed files with 101 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
src/pocketmine/scheduler/AsyncTask.php
View File

@ -27,7 +27,7 @@ use pocketmine\Server;
/**
* Class used to run async tasks in other threads.
*
* WARNING: Do not call PocketMine-MP API methods, or save objects from/on other Threads!!
* WARNING: Do not call PocketMine-MP API methods, or save objects (and arrays cotaining objects) from/on other Threads!!
*/
abstract class AsyncTask extends Collectable{
@ -42,6 +42,29 @@ abstract class AsyncTask extends Collectable{
private $crashed = false;
/**
* Constructs a new instance of AsyncTask. Subclasses don't need to call this constructor unless an argument is to be passed. ONLY construct this class from the main thread.
* <br>
* If an argument is passed into this constructor, it will be stored in a thread-local storage (in ServerScheduler), which MUST be retrieved through {@link #fetchLocal} when {@link #onCompletion} is called.
* Otherwise, a NOTICE level message will be raised and the reference will be removed after onCompletion exits.
* <br>
* If null or no argument is passed, do <em>not</em> call {@link #fetchLocal}, or an exception will be thrown.
* <br>
* WARNING: Use this method carefully. It might take a long time before an AsyncTask is completed. PocketMine will keep a strong reference to objects passed in this method.
* This may result in a light memory leak. Usually this does not cause memory failure, but be aware that the object may be no longer usable when the AsyncTask completes.
* (E.g. a {@link \pocketmine\Level} object is no longer usable because it is unloaded while the AsyncTask is executing, or even a plugin might be unloaded)
* Since PocketMine keeps a strong reference, the objects are still valid, but the implementation is responsible for checking whether these objects are still usable.
*
* @param mixed $complexData the data to store, pass null to store nothing. Scalar types can be safely stored in class properties directly instead of using this thread-local storage.
*/
public function __construct($complexData = null){
if($complexData === null){
return;
}
Server::getInstance()->getScheduler()->storeLocalComplex($this, $complexData);
}
public function run(){
$this->result = null;
@ -145,6 +168,24 @@ abstract class AsyncTask extends Collectable{
}
/**
* Call this method from {@link #onCompletion} to fetch the data stored in the constructor, if any.
*
* @param Server $server default null
*
* @return mixed
*
* @throws \RuntimeException if no data were stored by this AsyncTask instance.
*/
protected function fetchLocal(Server $server = null){
if($server === null){
$server = Server::getInstance();
assert($server !== null, "Call this method only from the main thread!");
}
return $server->getScheduler()->fetchLocalComplex($this);
}
public function cleanObject(){
foreach($this as $p => $v){
if(!($v instanceof \Threaded)){
@ -154,3 +195,4 @@ abstract class AsyncTask extends Collectable{
}
}