JS_DumpNamedRoots 编辑

Obsolete since JSAPI 19
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Enumerate all the named roots in a runtime.

Syntax

void
JS_DumpNamedRoots(JSRuntime *rt,
    void (*dump)(const char *name, void *rp, void *data),
    void *data);

Description

Each call to JS_AddNamedRoot creates a record in a table of named roots maintained by the garbage collector. JS_DumpNamedRoots provides a way for the application to access the contents of that table. It calls the dump function once for each named root in the given runtime rt. In pseudocode:

/* pseudocode explanation of what JS_DumpNamedRoots does */
void JS_DumpNamedRoots(JSRuntime *rt, DumpFn dump, void *data)
{
    for each (root in rt->namedRoots)
        dump(root.name, root.address, data);
}

Callback syntax

dump is a pointer to a function provided by the application. When JS_DumpNamedRoots calls it, it passes three arguments:

Example

static void dumpRoot(const char *name, void *addr, void *data)
{
    /* The application may use `data` for anything.  In this
       example, we use it to pass the desired output file. */
    FILE *f = (FILE *) data;

    fprintf(f, "There is a root named '%s' at %p\n", name, addr);
}

int main()
{
    ...
    JS_DumpNamedRoots(rt, dumpRoot, stderr);
    ...
}

See Also

• bug 803907