Heap::HeapOptions Struct Reference

#include <heap.h>

Collaboration diagram for Heap::HeapOptions:

Static Public Member Functions
static HeapOptions	Default ()

Data Fields
std::vector< std::unique_ptr< CustomSpaceBase > >	custom_spaces
StackSupport	stack_support = StackSupport::kSupportsConservativeStackScan
ResourceConstraints	resource_constraints

Detailed Description

Options specifying Heap properties (e.g. custom spaces) when initializing a heap through Heap::Create().

Definition at line 71 of file heap.h.

Member Function Documentation

Default()

static HeapOptions Default ( )

inlinestatic

Creates reasonable defaults for instantiating a Heap.

Returns

the HeapOptions that can be passed to Heap::Create().

Definition at line 77 of file heap.h.

Field Documentation

custom_spaces

std::vector<std::unique_ptr<CustomSpaceBase> > custom_spaces

Custom spaces added to heap are required to have indices forming a numbered sequence starting at 0, i.e., their kSpaceIndex must correspond to the index they reside in the vector.

Definition at line 84 of file heap.h.

resource_constraints

ResourceConstraints resource_constraints

Resource constraints specifying various properties that the internal GC scheduler follows.

Definition at line 100 of file heap.h.

stack_support

StackSupport stack_support = StackSupport::kSupportsConservativeStackScan

Specifies whether conserative stack scan is supported. When conservative stack scan is not supported, the collector may try to invoke garbage collections using non-nestable task, which are guaranteed to have no interesting stack, through the provided Platform. If such tasks are not supported by the Platform, the embedder must take care of invoking the GC through ForceGarbageCollectionSlow().

Definition at line 94 of file heap.h.

---

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

• include/cppgc/heap.h