TaskRunner Class Reference

#include <v8-platform.h>

Public Member Functions
void	PostTask (std::unique_ptr< Task > task, const SourceLocation &location=SourceLocation::Current())
void	PostNonNestableTask (std::unique_ptr< Task > task, const SourceLocation &location=SourceLocation::Current())
void	PostDelayedTask (std::unique_ptr< Task > task, double delay_in_seconds, const SourceLocation &location=SourceLocation::Current())
void	PostNonNestableDelayedTask (std::unique_ptr< Task > task, double delay_in_seconds, const SourceLocation &location=SourceLocation::Current())
void	PostIdleTask (std::unique_ptr< IdleTask > task, const 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 74 of file v8-platform.h.

Constructor & Destructor Documentation

TaskRunner() [1/2]

TaskRunner ( )

default

Referenced by operator=(), and TaskRunner().

~TaskRunner()

virtual ~TaskRunner ( )

virtualdefault

TaskRunner() [2/2]

TaskRunner ( const TaskRunner & )

delete

References TaskRunner().

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 176 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 171 of file v8-platform.h.

operator=()

TaskRunner & operator= ( const TaskRunner & )

delete

References TaskRunner().

PostDelayedTask()

void PostDelayedTask ( std::unique_ptr< Task > task, double delay_in_seconds, const 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 117 of file v8-platform.h.

References SourceLocation::Current(), and PostDelayedTaskImpl().

PostDelayedTaskImpl()

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

inlineprotectedvirtual

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

Referenced by PostDelayedTask().

PostIdleTask()

void PostIdleTask ( std::unique_ptr< IdleTask > task, const 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.

References SourceLocation::Current(), and PostIdleTaskImpl().

PostIdleTaskImpl()

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

inlineprotectedvirtual

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

Referenced by PostIdleTask().

PostNonNestableDelayedTask()

void PostNonNestableDelayedTask ( std::unique_ptr< Task > task, double delay_in_seconds, const 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.

References SourceLocation::Current(), and PostNonNestableDelayedTaskImpl().

PostNonNestableDelayedTaskImpl()

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

inlineprotectedvirtual

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

Referenced by PostNonNestableDelayedTask().

PostNonNestableTask()

void PostNonNestableTask ( std::unique_ptr< Task > task, const 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 104 of file v8-platform.h.

References SourceLocation::Current(), and PostNonNestableTaskImpl().

PostNonNestableTaskImpl()

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

inlineprotectedvirtual

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

Referenced by PostNonNestableTask().

PostTask()

void PostTask ( std::unique_ptr< Task > task, const 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 82 of file v8-platform.h.

References SourceLocation::Current(), and PostTaskImpl().

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 188 of file v8-platform.h.

Referenced by PostTask().

---

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

• include/v8-platform.h