AsyncTask Class Reference

Public Member Functions
	isGarbage ()
	setGarbage ()
	isFinished ()
	run ()
	isCrashed ()
	getResult ()
	cancelRun ()
	hasCancelledRun ()
	hasResult ()
	setResult ($result, $serialize=true)
	setTaskId ($taskId)
	getTaskId ()
	getFromThreadStore ($identifier)
	saveToThreadStore ($identifier, $value)
	onRun ()
	onCompletion (Server $server)
	cleanObject ()
Public Member Functions inherited from Threaded
	chunk ($size, bool $preserve=false)
	count ()
	isRunning ()
	isTerminated ()
	merge ($from, $overwrite=true)
	notify ()
	notifyOne ()
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	pop ()
	run ()
	shift ()
	synchronized (\Closure $function, $args=null)
	wait ($timeout)
	getRefCount ()
	addRef ()
	delRef ()
	isGarbage ()

Data Fields
	$worker = null

Additional Inherited Members
Static Public Member Functions inherited from Threaded
static	extend ($obj)

Detailed Description

Class used to run async tasks in other threads.

An AsyncTask does not have its own thread. It is queued into an AsyncPool and executed if there is an async worker with no AsyncTask running. Therefore, an AsyncTask SHOULD NOT execute for more than a few seconds. For tasks that run for a long time or infinitely, start another pocketmine\Threadinstead.WARNING:DonotcallPocketMine-MPAPImethods,orsaveobjects(andarrayscontainingobjects)from/onotherThreads!!

Member Function Documentation

cancelRun()

cancelRun

(

)

                               {
        $this->cancelRun = true;
    }

cleanObject()

cleanObject

(

)

                                 {
        foreach($this as $p => $v){
            if(!($v instanceof \Threaded) and !in_array($p, ["isFinished", "isGarbage", "cancelRun"])){
                $this->{$p} = null;
            }
        }
    }

getFromThreadStore()

getFromThreadStore

(

$identifier

)

Gets something into the local thread store. You have to initialize this in some way from the task on run

Parameters

string

$identifier

Returns

mixed

                                                   {
        global $store;
        return $this->isGarbage() ? null : $store[$identifier];
    }

getResult()

getResult

(

)

Returns

mixed

                               {
        return $this->serialized ? unserialize($this->result) : $this->result;
    }

getTaskId()

getTaskId

(

)

Returns

int

                               {
        return $this->taskId;
    }

hasCancelledRun()

hasCancelledRun

(

)

Returns

bool

                                     {
        return $this->cancelRun === true;
    }

hasResult()

hasResult

(

)

Returns

bool

                               {
        return $this->result !== null;
    }

isCrashed()

isCrashed

(

)

Returns

bool

                               {
        return $this->crashed;
    }

isFinished()

isFinished

(

)

Returns

bool

                                 : bool{
        return $this->isFinished;
    }

isGarbage()

isGarbage

(

)

Returns

bool

Implements Collectable.

                                : bool{
        return $this->isGarbage;
    }

onCompletion()

onCompletion

(

Server

$server

)

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

Parameters

Server

$server

Returns

void

                                                {

    }

onRun()

onRun ( )

abstract

Actions to execute when run

Returns

void

run()

run

(

)

                         {
        $this->result = null;
        $this->isGarbage = false;

        if($this->cancelRun !== true){
            try{
                $this->onRun();
            }catch(\Throwable $e){
                $this->crashed = true;
                $this->worker->handleException($e);
            }
        }

        $this->isFinished = true;
        //$this->setGarbage();
    }

saveToThreadStore()

saveToThreadStore	(		$identifier,
			$value
	)

Saves something into the local thread store. This might get deleted at any moment.

Parameters

string	$identifier
mixed	$value

                                                          {
        global $store;
        if(!$this->isGarbage()){
            $store[$identifier] = $value;
        }
    }

setGarbage()

setGarbage

(

)

                                {
        $this->isGarbage = true;
    }

setResult()

setResult	(		$result,
			$serialize = true
	)

Parameters

mixed	$result
bool	$serialize

                                                         {
        $this->result = $serialize ? serialize($result) : $result;
        $this->serialized = $serialize;
    }

setTaskId()

setTaskId

(

$taskId

)

Parameters

$taskId

                                      {
        $this->taskId = $taskId;
    }

Field Documentation

$worker

$worker = null

---

The documentation for this class was generated from the following file:

• src/pocketmine/scheduler/AsyncTask.php