JS_ScheduleGC

This article needs a technical review. How you can help.

This article covers features introduced in SpiderMonkey 17

Set nextScheduled parameter of GC.

Syntax

void
JS_ScheduleGC(JSContext *cx, uint32_t count);
Name Type Description
cx JSContext * A context. The GC zeal level of the associated JSRuntime is set.
frequency uint32_t The value of nextScheduled parameter of GC.

Description

JS_ScheduleGC sets the nextScheduled parameter of GC.

At every allocation nextScheduled is decremented. When it reaches zero, we do either a full or a compartmental GC.

At this point, if zeal is one of the types that trigger periodic collection, then nextScheduled is reset to the value of frequency. Otherwise, no additional GCs take place.

See Also

Document Tags and Contributors

 Contributors to this page: kscarfone, arai
 Last updated by: kscarfone,