ServerScheduler Class Reference

Public Member Functions
	__construct ()
	scheduleTask (Task $task)
	scheduleAsyncTask (AsyncTask $task)
	scheduleAsyncTaskToWorker (AsyncTask $task, $worker)
	getAsyncTaskPoolSize ()
	increaseAsyncTaskPoolSize ($newSize)
	scheduleDelayedTask (Task $task, $delay)
	scheduleRepeatingTask (Task $task, $period)
	scheduleDelayedRepeatingTask (Task $task, $delay, $period)
	cancelTask ($taskId)
	cancelTasks (Plugin $plugin)
	cancelAllTasks ()
	isQueued ($taskId)

Static Public Attributes
static	$WORKERS = 2

Protected Attributes
	$queue
	$tasks = []
	$asyncPool
	$currentTick = 0

Constructor & Destructor Documentation

__construct()

__construct

(

)

ServerScheduler constructor.

                                 {
        $this->queue = new ReversePriorityQueue();
        $this->asyncPool = new AsyncPool(Server::getInstance(), self::$WORKERS);
    }

Member Function Documentation

cancelAllTasks()

cancelAllTasks

(

)

                                    {
        foreach($this->tasks as $task){
            $task->cancel();
        }
        $this->tasks = [];
        $this->asyncPool->removeTasks();
        while(!$this->queue->isEmpty()){
            $this->queue->extract();
        }
        $this->ids = 1;
    }

cancelTask()

cancelTask

(

$taskId

)

Parameters

int

$taskId

                                       {
        if($taskId !== null and isset($this->tasks[$taskId])){
            $this->tasks[$taskId]->cancel();
            unset($this->tasks[$taskId]);
        }
    }

cancelTasks()

cancelTasks

(

Plugin

$plugin

)

Parameters

Plugin

$plugin

                                               {
        foreach($this->tasks as $taskId => $task){
            $ptask = $task->getTask();
            if($ptask instanceof PluginTask and $ptask->getOwner() === $plugin){
                $task->cancel();
                unset($this->tasks[$taskId]);
            }
        }
    }

getAsyncTaskPoolSize()

getAsyncTaskPoolSize

(

)

Returns

int

                                          {
        return $this->asyncPool->getSize();
    }

increaseAsyncTaskPoolSize()

increaseAsyncTaskPoolSize

(

$newSize

)

Parameters

$newSize

                                                       {
        $this->asyncPool->increaseSize($newSize);
    }

isQueued()

isQueued

(

$taskId

)

Parameters

int

$taskId

Returns

bool

                                     {
        return isset($this->tasks[$taskId]);
    }

scheduleAsyncTask()

scheduleAsyncTask

(

AsyncTask

$task

)

Submits an asynchronous task to the Worker Pool

Parameters

AsyncTask

$task

Returns

void

                                                      {
        $id = $this->nextId();
        $task->setTaskId($id);
        $this->asyncPool->submitTask($task);
    }

scheduleAsyncTaskToWorker()

scheduleAsyncTaskToWorker	(	AsyncTask	$task,
			$worker
	)

Submits an asynchronous task to a specific Worker in the Pool

Parameters

AsyncTask	$task
int	$worker

Returns

void

                                                                       {
        $id = $this->nextId();
        $task->setTaskId($id);
        $this->asyncPool->submitTaskToWorker($task, $worker);
    }

scheduleDelayedRepeatingTask()

scheduleDelayedRepeatingTask	(	Task	$task,
			$delay,
			$period
	)

Parameters

Task	$task
int	$delay
int	$period

Returns

null|TaskHandler

                                                                             {
        return $this->addTask($task, (int) $delay, (int) $period);
    }

scheduleDelayedTask()

scheduleDelayedTask	(	Task	$task,
			$delay
	)

Parameters

Task	$task
int	$delay

Returns

null|TaskHandler

                                                           {
        return $this->addTask($task, (int) $delay, -1);
    }

scheduleRepeatingTask()

scheduleRepeatingTask	(	Task	$task,
			$period
	)

Parameters

Task	$task
int	$period

Returns

null|TaskHandler

                                                              {
        return $this->addTask($task, -1, (int) $period);
    }

scheduleTask()

scheduleTask

(

Task

$task

)

Parameters

Task

$task

Returns

null|TaskHandler

                                            {
        return $this->addTask($task, -1, -1);
    }

Field Documentation

$asyncPool

$asyncPool

protected

$currentTick

$currentTick = 0

protected

$queue

$queue

protected

$tasks

$tasks = []

protected

$WORKERS

$WORKERS = 2

static

---

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

• src/pocketmine/scheduler/ServerScheduler.php