v8  9.0.257(node16.0.0)
V8 is Google's open source JavaScript engine
JobHandle Class Referenceabstract

#include <v8-platform.h>

Public Member Functions

virtual ~JobHandle ()=default
virtual void NotifyConcurrencyIncrease ()=0
virtual void Join ()=0
virtual void Cancel ()=0
virtual void CancelAndDetach ()
virtual bool IsActive ()=0
virtual bool IsCompleted ()
virtual bool IsValid ()=0
virtual bool IsRunning ()
virtual bool UpdatePriorityEnabled () const
virtual void UpdatePriority (TaskPriority new_priority)

Detailed Description

Handle returned when posting a Job. Provides methods to control execution of the posted Job.

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

Constructor & Destructor Documentation

◆ ~JobHandle()

virtual ~JobHandle ( )

Member Function Documentation

◆ Cancel()

virtual void Cancel ( )
pure virtual

Forces all existing workers to yield ASAP. Waits until they have all returned from the Job's callback before returning.

Referenced by JobHandle::CancelAndDetach().

◆ CancelAndDetach()

virtual void CancelAndDetach ( )

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

References JobHandle::Cancel().

◆ IsActive()

virtual bool IsActive ( )
pure virtual

Returns true if there's any work pending or any worker running.

Referenced by JobHandle::IsCompleted().

◆ IsCompleted()

virtual bool IsCompleted ( )

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

References JobHandle::IsActive().

◆ IsRunning()

virtual bool IsRunning ( )

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

References JobHandle::IsValid().

◆ IsValid()

virtual bool IsValid ( )
pure virtual

Returns true if associated with a Job and other methods may be called. Returns false after Join() or Cancel() was called. This may return true even if no workers are running and IsCompleted() returns true

Referenced by JobHandle::IsRunning().

◆ Join()

virtual void Join ( )
pure virtual

Contributes to the job on this thread. Doesn't return until all tasks have completed and max concurrency becomes 0. When Join() is called and max concurrency reaches 0, it should not increase again. This also promotes this Job's priority to be at least as high as the calling thread's priority.

◆ NotifyConcurrencyIncrease()

virtual void NotifyConcurrencyIncrease ( )
pure virtual

Notifies the scheduler that max concurrency was increased, and the number of worker should be adjusted accordingly. See Platform::PostJob() for more details.

◆ UpdatePriority()

virtual void UpdatePriority ( TaskPriority  new_priority)

Update this Job's priority.

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

◆ UpdatePriorityEnabled()

virtual bool UpdatePriorityEnabled ( ) const

Returns true if job priority can be changed.

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

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