#include <heap.h>
Definition at line 39 of file heap.h.
◆ StackState
Specifies the stack state the embedder is in.
Definition at line 44 of file heap.h.
◆ MarkingType
Specifies supported marking types
Enumerator |
---|
kAtomic | Atomic stop-the-world marking. This option does not require any write barriers but is the most intrusive in terms of jank.
|
kIncremental | Incremental marking interleaves marking with the rest of the application workload on the same thread.
|
kIncrementalAndConcurrent | Incremental and concurrent marking.
|
Definition at line 64 of file heap.h.
◆ StackSupport
Specifies whether conservative stack scanning is supported.
Enumerator |
---|
kSupportsConservativeStackScan | Conservative stack scan is supported.
|
kNoConservativeStackScan | Conservative stack scan is not supported. Embedders may use this option when using custom infrastructure that is unsupported by the library.
|
Definition at line 49 of file heap.h.
◆ SweepingType
Specifies supported sweeping types
Enumerator |
---|
kAtomic | Atomic stop-the-world sweeping. All of sweeping is performed at once.
|
kIncremental | Incremental sweeping interleaves sweeping with the rest of the application workload on the same thread.
|
kIncrementalAndConcurrent | Incremental and concurrent sweeping. Sweeping is split and interleaved with the rest of the application.
|
Definition at line 84 of file heap.h.
◆ ~Heap()
◆ Create()
Creates a new heap that can be used for object allocation.
- Parameters
-
platform | implemented and provided by the embedder. |
options | HeapOptions specifying various properties for the Heap. |
- Returns
- a new Heap instance.
◆ ForceGarbageCollectionSlow()
void ForceGarbageCollectionSlow |
( |
const char * |
source, |
|
|
const char * |
reason, |
|
|
StackState |
stack_state = StackState::kMayContainHeapPointers |
|
) |
| |
Forces garbage collection.
- Parameters
-
source | String specifying the source (or caller) triggering a forced garbage collection. |
reason | String specifying the reason for the forced garbage collection. |
stack_state | The embedder stack state, see StackState. |
◆ GetAllocationHandle()
AllocationHandle& GetAllocationHandle |
( |
| ) |
|
◆ GetHeapHandle()
HeapHandle& GetHeapHandle |
( |
| ) |
|
- Returns
- the opaque heap handle which may be used to refer to this heap in other APIs. Valid as long as the underlying
Heap
is alive.
◆ internal::Heap
friend class internal::Heap |
|
friend |
The documentation for this class was generated from the following file: