TaskRunner Class Reference

#include <v8-platform.h>

Public Member Functions
void	PostTask (std::unique_ptr< Task > task, SourceLocation location=SourceLocation::Current())
void	PostNonNestableTask (std::unique_ptr< Task > task, SourceLocation location=SourceLocation::Current())
void	PostDelayedTask (std::unique_ptr< Task > task, double delay_in_seconds, SourceLocation location=SourceLocation::Current())
void	PostNonNestableDelayedTask (std::unique_ptr< Task > task, double delay_in_seconds, SourceLocation location=SourceLocation::Current())
void	PostIdleTask (std::unique_ptr< IdleTask > task, SourceLocation location=SourceLocation::Current())
virtual bool	IdleTasksEnabled ()=0
virtual bool	NonNestableTasksEnabled () const
virtual bool	NonNestableDelayedTasksEnabled () const
	TaskRunner ()=default
virtual	~TaskRunner ()=default
	TaskRunner (const TaskRunner &)=delete
TaskRunner &	operator= (const TaskRunner &)=delete

Protected Member Functions
virtual void	PostTaskImpl (std::unique_ptr< Task > task, const SourceLocation &location)
virtual void	PostNonNestableTaskImpl (std::unique_ptr< Task > task, const SourceLocation &location)
virtual void	PostDelayedTaskImpl (std::unique_ptr< Task > task, double delay_in_seconds, const SourceLocation &location)
virtual void	PostNonNestableDelayedTaskImpl (std::unique_ptr< Task > task, double delay_in_seconds, const SourceLocation &location)
virtual void	PostIdleTaskImpl (std::unique_ptr< IdleTask > task, const SourceLocation &location)

Detailed Description

A TaskRunner allows scheduling of tasks. The TaskRunner may still be used to post tasks after the isolate gets destructed, but these tasks may not get executed anymore. All tasks posted to a given TaskRunner will be invoked in sequence. Tasks can be posted from any thread.

Definition at line 75 of file v8-platform.h.

Constructor & Destructor Documentation

TaskRunner() [1/2]

TaskRunner ( )

default

~TaskRunner()

virtual ~TaskRunner ( )

virtualdefault

TaskRunner() [2/2]

TaskRunner ( const TaskRunner &  )

delete

Member Function Documentation

IdleTasksEnabled()

virtual bool IdleTasksEnabled ( )

pure virtual

Returns true if idle tasks are enabled for this TaskRunner.

NonNestableDelayedTasksEnabled()

virtual bool NonNestableDelayedTasksEnabled ( ) const

inlinevirtual

Returns true if non-nestable delayed tasks are enabled for this TaskRunner.

Definition at line 175 of file v8-platform.h.

NonNestableTasksEnabled()

virtual bool NonNestableTasksEnabled ( ) const

inlinevirtual

Returns true if non-nestable tasks are enabled for this TaskRunner.

Definition at line 170 of file v8-platform.h.

operator=()

TaskRunner & operator= ( const TaskRunner &  )

delete

PostDelayedTask()

void PostDelayedTask ( std::unique_ptr< Task >  task, double  delay_in_seconds, SourceLocation  location = SourceLocation::Current()  )

inline

Schedules a task to be invoked by this TaskRunner. The task is scheduled after the given number of seconds |delay_in_seconds|. The TaskRunner implementation takes ownership of |task|.

Embedders should override PostDelayedTaskImpl instead of this.

Definition at line 118 of file v8-platform.h.

PostDelayedTaskImpl()

virtual void PostDelayedTaskImpl ( std::unique_ptr< Task >  task, double  delay_in_seconds, const SourceLocation &  location  )

inlineprotectedvirtual

Definition at line 191 of file v8-platform.h.

PostIdleTask()

void PostIdleTask ( std::unique_ptr< IdleTask >  task, SourceLocation  location = SourceLocation::Current()  )

inline

Schedules an idle task to be invoked by this TaskRunner. The task is scheduled when the embedder is idle. Requires that |TaskRunnerIdleTasksEnabled()| is true. Idle tasks may be reordered relative to other task types and may be starved for an arbitrarily long time if no idle time is available. The TaskRunner implementation takes ownership of |task|.

Embedders should override PostIdleTaskImpl instead of this.

Definition at line 157 of file v8-platform.h.

PostIdleTaskImpl()

virtual void PostIdleTaskImpl ( std::unique_ptr< IdleTask >  task, const SourceLocation &  location  )

inlineprotectedvirtual

Definition at line 197 of file v8-platform.h.

PostNonNestableDelayedTask()

void PostNonNestableDelayedTask ( std::unique_ptr< Task >  task, double  delay_in_seconds, SourceLocation  location = SourceLocation::Current()  )

inline

Schedules a task to be invoked by this TaskRunner. The task is scheduled after the given number of seconds |delay_in_seconds|. The TaskRunner implementation takes ownership of |task|. The |task| cannot be nested within other task executions.

Tasks which shouldn't be interleaved with JS execution must be posted with |PostNonNestableTask| or |PostNonNestableDelayedTask|. This is because the embedder may process tasks in a callback which is called during JS execution.

In particular, tasks which execute JS must be non-nestable, since JS execution is not allowed to nest.

Requires that |TaskRunnerNonNestableDelayedTasksEnabled()| is true.

Embedders should override PostNonNestableDelayedTaskImpl instead of this.

Definition at line 141 of file v8-platform.h.

PostNonNestableDelayedTaskImpl()

virtual void PostNonNestableDelayedTaskImpl ( std::unique_ptr< Task >  task, double  delay_in_seconds, const SourceLocation &  location  )

inlineprotectedvirtual

Definition at line 194 of file v8-platform.h.

PostNonNestableTask()

void PostNonNestableTask ( std::unique_ptr< Task >  task, SourceLocation  location = SourceLocation::Current()  )

inline

Schedules a task to be invoked by this TaskRunner. The TaskRunner implementation takes ownership of |task|. The |task| cannot be nested within other task executions.

Tasks which shouldn't be interleaved with JS execution must be posted with |PostNonNestableTask| or |PostNonNestableDelayedTask|. This is because the embedder may process tasks in a callback which is called during JS execution.

In particular, tasks which execute JS must be non-nestable, since JS execution is not allowed to nest.

Requires that |TaskRunnerNonNestableTasksEnabled()| is true.

Embedders should override PostNonNestableTaskImpl instead of this.

Definition at line 105 of file v8-platform.h.

PostNonNestableTaskImpl()

virtual void PostNonNestableTaskImpl ( std::unique_ptr< Task >  task, const SourceLocation &  location  )

inlineprotectedvirtual

Definition at line 189 of file v8-platform.h.

PostTask()

void PostTask ( std::unique_ptr< Task >  task, SourceLocation  location = SourceLocation::Current()  )

inline

Schedules a task to be invoked by this TaskRunner. The TaskRunner implementation takes ownership of |task|.

Embedders should override PostTaskImpl instead of this.

Definition at line 83 of file v8-platform.h.

PostTaskImpl()

virtual void PostTaskImpl ( std::unique_ptr< Task >  task, const SourceLocation &  location  )

inlineprotectedvirtual

Implementation of above methods with an additional location argument.

Definition at line 187 of file v8-platform.h.

---

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

• include/v8-platform.h