v8  10.1.124 (node 18.2.0)
V8 is Google's open source JavaScript engine
DisallowGarbageCollectionScope Class Referencefinal

#include <heap-consistency.h>

Public Member Functions

 DisallowGarbageCollectionScope (HeapHandle &heap_handle)
 
 ~DisallowGarbageCollectionScope ()
 
 DisallowGarbageCollectionScope (const DisallowGarbageCollectionScope &)=delete
 
DisallowGarbageCollectionScopeoperator= (const DisallowGarbageCollectionScope &)=delete
 

Static Public Member Functions

static bool IsGarbageCollectionAllowed (HeapHandle &heap_handle)
 
static void Enter (HeapHandle &heap_handle)
 
static void Leave (HeapHandle &heap_handle)
 

Detailed Description

Disallows garbage collection finalizations. Any garbage collection triggers result in a crash when in this scope.

Note that the garbage collector already covers paths that can lead to garbage collections, so user code does not require checking IsGarbageCollectionAllowed() before allocations.

Definition at line 177 of file heap-consistency.h.

Constructor & Destructor Documentation

◆ DisallowGarbageCollectionScope() [1/2]

DisallowGarbageCollectionScope ( HeapHandle &  heap_handle)
explicit

Constructs a scoped object that automatically enters and leaves a disallow garbage collection scope based on its lifetime.

Parameters
heap_handleThe corresponding heap.

◆ ~DisallowGarbageCollectionScope()

◆ DisallowGarbageCollectionScope() [2/2]

Member Function Documentation

◆ Enter()

static void Enter ( HeapHandle &  heap_handle)
static

Enters a disallow garbage collection scope. Must be paired with Leave(). Prefer a scope instance of DisallowGarbageCollectionScope.

Parameters
heap_handleThe corresponding heap.

◆ IsGarbageCollectionAllowed()

static bool IsGarbageCollectionAllowed ( HeapHandle &  heap_handle)
static
Returns
whether garbage collections are currently allowed.

◆ Leave()

static void Leave ( HeapHandle &  heap_handle)
static

Leaves a disallow garbage collection scope. Must be paired with Enter(). Prefer a scope instance of DisallowGarbageCollectionScope.

Parameters
heap_handleThe corresponding heap.

◆ operator=()


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