* 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.
*
* If null or no argument is passed, do not call {@link #fetchLocal}, or an exception will be thrown.
*
* 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;
if($this->cancelRun !== true){
try{
$this->onRun();
}catch(\Throwable $e){
$this->crashed = true;
$this->worker->handleException($e);
}
}
$this->setGarbage();
}
public function isCrashed(){
return $this->crashed;
}
/**
* @return mixed
*/
public function getResult(){
return $this->serialized ? unserialize($this->result) : $this->result;
}
public function cancelRun(){
$this->cancelRun = true;
}
public function hasCancelledRun(){
return $this->cancelRun === true;
}
/**
* @return bool
*/
public function hasResult(){
return $this->result !== null;
}
/**
* @param mixed $result
* @param bool $serialize
*/
public function setResult($result, $serialize = true){
$this->result = $serialize ? serialize($result) : $result;
$this->serialized = $serialize;
}
public function setTaskId($taskId){
$this->taskId = $taskId;
}
public function getTaskId(){
return $this->taskId;
}
/**
* Gets something into the local thread store.
* You have to initialize this in some way from the task on run
*
* @param string $identifier
* @return mixed
*/
public function getFromThreadStore($identifier){
global $store;
return ($this->isGarbage() or !isset($store[$identifier])) ? null : $store[$identifier];
}
/**
* Saves something into the local thread store.
* This might get deleted at any moment.
*
* @param string $identifier
* @param mixed $value
*/
public function saveToThreadStore($identifier, $value){
global $store;
if(!$this->isGarbage()){
$store[$identifier] = $value;
}
}
/**
* Actions to execute when run
*
* @return void
*/
abstract public function onRun();
/**
* Actions to execute when completed (on main thread)
* Implement this if you want to handle the data in your AsyncTask after it has been processed
*
* @param Server $server
*
* @return void
*/
public function onCompletion(Server $server){
}
/**
* Call this method from {@link AsyncTask#onRun} (AsyncTask execution thread) to schedule a call to
* {@link AsyncTask#onProgressUpdate} from the main thread with the given progress parameter.
*
* @param mixed $progress A value that can be safely serialize()'ed.
*/
public function publishProgress($progress){
$this->progressUpdates[] = serialize($progress);
}
/**
* @internal Only call from AsyncPool.php on the main thread
*
* @param Server $server
*/
public function checkProgressUpdates(Server $server){
while($this->progressUpdates->count() !== 0){
$progress = $this->progressUpdates->shift();
$this->onProgressUpdate($server, unserialize($progress));
}
}
/**
* Called from the main thread after {@link AsyncTask#publishProgress} is called.
* All {@link AsyncTask#publishProgress} calls should result in {@link AsyncTask#onProgressUpdate} calls before
* {@link AsyncTask#onCompletion} is called.
*
* @param Server $server
* @param mixed $progress The parameter passed to {@link AsyncTask#publishProgress}. It is serialize()'ed
* and then unserialize()'ed, as if it has been cloned.
*/
public function onProgressUpdate(Server $server, $progress){
}
/**
* Call this method from {@link AsyncTask#onCompletion} to fetch the data stored in the constructor, if any, and
* clears it from the storage.
*
* Do not call this method from {@link AsyncTask#onProgressUpdate}, because this method deletes the data and cannot
* be used in the next {@link AsyncTask#onProgressUpdate} call or from {@link AsyncTask#onCompletion}. Use
* {@link AsyncTask#peekLocal} instead.
*
* @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);
}
/**
* Call this method from {@link AsyncTask#onProgressUpdate} to fetch the data stored in the constructor.
*
* Use {@link AsyncTask#peekLocal} instead from {@link AsyncTask#onCompletion}, because this method does not delete
* the data, and not clearing the data will result in a warning for memory leak after {@link AsyncTask#onCompletion}
* finished executing.
*
* @param Server|null $server default null
*
* @return mixed
*
* @throws \RuntimeException if no data were stored by this AsyncTask instance
*/
protected function peekLocal(Server $server = null){
if($server === null){
$server = Server::getInstance();
assert($server !== null, "Call this method only from the main thread!");
}
return $server->getScheduler()->peekLocalComplex($this);
}
public function cleanObject(){
foreach($this as $p => $v){
if(!($v instanceof \Threaded)){
$this->{$p} = null;
}
}
$this->setGarbage();
}
}