Syntax

The JSContext that is currently in a request on the calling thread. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.

Description

For more information about thread safety and requests, see JS_THREADSAFE.

JS_YieldRequest momentarily suspends the current request. A program can call this function periodically to ensure that a long-running request does not block garbage collection indefinitely. The effect is the same as a call to JS_SuspendRequest immediately followed by a call to JS_ResumeRequest.

JSAPI 1.7 and earlierJS_YieldRequest did not cause cx to relinquish objects it created to other threads that are blocked waiting for them. This bug (bug 402898) will be fixed in SpiderMonkey 1.8.

JSAPI 1.7 and earlierJS_YieldRequest is available only in JS_THREADSAFE builds. In SpiderMonkey 1.8 and later, this function will be present, but will do nothing, in non-JS_THREADSAFE builds.

Document Tags and Contributors

Learn the best of web development

Get the latest and greatest from MDN delivered straight to your inbox.

E-mail

I'm okay with Mozilla handling my info as explained in this Privacy Policy.

Thanks! Please check your inbox to confirm your subscription.

If you haven’t previously confirmed a subscription to a Mozilla-related newsletter you may have to do so. Please check your inbox or your spam filter for an email from us.

Why does MDN look different?

MDN is changing to focus just on documenting web technologies. All the same great content is still here; we’re just changing some visual elements and navigation, to help you more quickly find the web technology docs you’re looking for.

But don’t worry, MDN and Mozilla are still together! In fact, we're updating MDN’s look to reflect Mozilla's new logo and colors.