AsyncTask.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\scheduler;
 
use pmmp\thread\Runnable;
use pmmp\thread\ThreadSafe;
use pmmp\thread\ThreadSafeArray;
use pocketmine\thread\NonThreadSafeValue;
use pocketmine\timings\Timings;
use function array_key_exists;
use function igbinary_serialize;
use function igbinary_unserialize;
use function is_null;
use function is_scalar;
use function spl_object_id;
 
abstract class AsyncTask extends Runnable{
    private static array $threadLocalStorage = [];
 
    private ?ThreadSafeArray $progressUpdates = null;
 
    private ThreadSafe|string|int|bool|null|float $result = null;
 
    private bool $submitted = false;
    private bool $finished = false;
 
    public function run() : void{
        $this->result = null;
 
        $timings = Timings::getAsyncTaskRunTimings($this);
        $timings->startTiming();
 
        try{
            $this->onRun();
        }finally{
            $timings->stopTiming();
        }
 
        $this->finished = true;
        AsyncWorker::getNotifier()->wakeupSleeper();
        AsyncWorker::maybeCollectCycles();
    }
 
    public function isCrashed() : bool{
        return $this->isTerminated();
    }
 
    public function isFinished() : bool{
        return $this->finished || $this->isTerminated();
    }
 
    public function hasResult() : bool{
        return $this->result !== null;
    }
 
    public function getResult(){
        if($this->result instanceof NonThreadSafeValue){
            return $this->result->deserialize();
        }
        return $this->result;
    }
 
    public function setResult(mixed $result) : void{
        $this->result = is_scalar($result) || is_null($result) || $result instanceof ThreadSafe ? $result : new NonThreadSafeValue($result);
    }
 
    public function cancelRun() : void{
        //NOOP
    }
 
    public function hasCancelledRun() : bool{
        return false;
    }
 
    public function setSubmitted() : void{
        $this->submitted = true;
    }
 
    public function isSubmitted() : bool{
        return $this->submitted;
    }
 
    abstract public function onRun() : void;
 
    public function onCompletion() : void{
 
    }
 
    public function publishProgress(mixed $progress) : void{
        $progressUpdates = $this->progressUpdates;
        if($progressUpdates === null){
            $progressUpdates = $this->progressUpdates = new ThreadSafeArray();
        }
        $progressUpdates[] = igbinary_serialize($progress) ?? throw new \InvalidArgumentException("Progress must be serializable");
    }
 
    public function checkProgressUpdates() : void{
        $progressUpdates = $this->progressUpdates;
        if($progressUpdates !== null){
            while(($progress = $progressUpdates->shift()) !== null){
                $this->onProgressUpdate(igbinary_unserialize($progress));
            }
        }
    }
 
    public function onProgressUpdate($progress) : void{
 
    }
 
    public function onError() : void{
 
    }
 
    protected function storeLocal(string $key, mixed $complexData) : void{
        self::$threadLocalStorage[spl_object_id($this)][$key] = $complexData;
    }
 
    protected function fetchLocal(string $key){
        $id = spl_object_id($this);
        if(!isset(self::$threadLocalStorage[$id]) || !array_key_exists($key, self::$threadLocalStorage[$id])){
            throw new \InvalidArgumentException("No matching thread-local data found on this thread");
        }
 
        return self::$threadLocalStorage[$id][$key];
    }
 
    final public function __destruct(){
        $this->reallyDestruct();
        unset(self::$threadLocalStorage[spl_object_id($this)]);
    }
 
    protected function reallyDestruct() : void{
 
    }
}