Heap Class Reference

#include <heap.h>

Data Structures
struct	HeapOptions

Public Types
using	StackState = EmbedderStackState

Public Member Functions
virtual	~Heap ()=default
void	ForceGarbageCollectionSlow (const char *source, const char *reason, StackState stack_state=StackState::kMayContainHeapPointers)

Static Public Member Functions
static std::unique_ptr< Heap >	Create (HeapOptions=HeapOptions::Default())

Friends
class	internal::Heap

Detailed Description

Definition at line 20 of file heap.h.

Member Typedef Documentation

StackState

using StackState = EmbedderStackState

Specifies the stack state the embedder is in.

Definition at line 25 of file heap.h.

Constructor & Destructor Documentation

~Heap()

virtual ~Heap ( )

virtualdefault

Member Function Documentation

Create()

static std::unique_ptr<Heap> Create ( HeapOptions  = HeapOptions::Default() )

static

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.

Friends And Related Function Documentation

internal::Heap

friend class internal::Heap

friend

Definition at line 58 of file heap.h.

---

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

• include/cppgc/heap.h