ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver Class Reference

Class PersistingObserver. More...

Inheritance diagram for ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver:

Public Member Functions
	__construct (protected Bucket $bucket, protected Persistence $persistence)
	notifyState (int $state)
	notifyPercentage (Task $task, int $percentage)
	You can change the progress of a currently running task. More...
	notifyCurrentTask (Task $task)
	If the current task changes notify the observer. More...
	heartbeat ()
	I'm still alive! If your calculation takes a really long time don't forget to use the heartbeat. More...
	notifyState (int $state)
	If the bucket goes into another state notify the observer. More...
	notifyPercentage (Task $task, int $percentage)
	You can change the progress of a currently running task. More...
	notifyCurrentTask (Task $task)
	If the current task changes notify the observer. More...
	heartbeat ()
	I'm still alive! If your calculation takes a really long time don't forget to use the heartbeat. More...

Detailed Description

Class PersistingObserver.

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch When notifying something to the bucket this observer also persists the changes into the database.

Definition at line 31 of file PersistingObserver.php.

Constructor & Destructor Documentation

__construct()

ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver::__construct	(	protected Bucket	$bucket,
		protected Persistence	$persistence
	)

Definition at line 33 of file PersistingObserver.php.

    {
    }

Member Function Documentation

heartbeat()

ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver::heartbeat

(

)

I'm still alive! If your calculation takes a really long time don't forget to use the heartbeat.

Otherwise the bucket might be killed while still running. All notify tasks of the observer also trigger a heartbeat.

Implements ILIAS\BackgroundTasks\Observer.

Definition at line 65 of file PersistingObserver.php.

                               : void
    {
        $this->bucket->heartbeat();
        $this->persistence->updateBucket($this->bucket);
    }

notifyCurrentTask()

ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver::notifyCurrentTask

(

Task

$task

)

If the current task changes notify the observer.

This also triggers a heartbeat.

Implements ILIAS\BackgroundTasks\Observer.

Definition at line 54 of file PersistingObserver.php.

                                                 : void
    {
        $this->bucket->setCurrentTask($task);
        $this->bucket->heartbeat();
        $this->persistence->updateBucket($this->bucket);
    }

notifyPercentage()

ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver::notifyPercentage	(	Task	$task,
		int	$percentage
	)

You can change the progress of a currently running task.

This also triggers a heartbeat.

Implements ILIAS\BackgroundTasks\Observer.

Definition at line 47 of file PersistingObserver.php.

                                                                 : void
    {
        $this->bucket->setPercentage($task, $percentage);
        $this->bucket->heartbeat();
        $this->persistence->updateBucket($this->bucket);
    }

notifyState()

ILIAS\BackgroundTasks\Implementation\TaskManager\PersistingObserver::notifyState

(

int

$state

)

Parameters

$state

int

Implements ILIAS\BackgroundTasks\Observer.

Definition at line 40 of file PersistingObserver.php.

                                           : void
    {
        $this->bucket->setState($state);
        $this->bucket->heartbeat();
        $this->persistence->updateBucket($this->bucket);
    }

---

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

• components/ILIAS/BackgroundTasks/src/Implementation/TaskManager/PersistingObserver.php