N-API documentation incorectly states napi_create_async_work is not multithreaded #19071

ebickle · 2018-03-01T16:40:26Z

Version: 9.7.0
Platform: Windows 7, Build 7601: Service Pack 1, 64-bit.
Subsystem: Documentation / N-API

The N-API documentation for the Custom Asynchronous Operations (https://nodejs.org/api/n-api.html#n_api_custom_asynchronous_operations) incorrectly states that napi_create_async_work (Simple Asynchronous Operations) executes on the main event loop.

This is incorrect; simple asynchronous operations execute from the Node.js Worker Thread Pool. People who read the documentation may make the dangerous assumption that asynchronous work queued via N-API will never execute in parallel with the main event loop.

I've implemented my own simple test on 64-bit Windows 7 using the N-API Simple Asynchronous Operations and verified that Execute is called from a separate thread-id.

Documentation for N-API Custom Asynchronous Operations incorrectly stated that async execution happens on the main event loop. Added details to napi_create_async_work about which threads are used to invoke the execute and complete callbacks. Fixes: nodejs#19071

Documentation for N-API Custom Asynchronous Operations incorrectly stated that async execution happens on the main event loop. Added details to napi_create_async_work about which threads are used to invoke the execute and complete callbacks. Changed 'async' to 'asynchronous' in the documentation for Custom Asynchronous Operations. Changed "executes in parallel" to "can execute in parallel" for the documentation of napi_create_async_work execute parameter. PR-URL: nodejs#19073 Fixes: nodejs#19071 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Documentation for N-API Custom Asynchronous Operations incorrectly stated that async execution happens on the main event loop. Added details to napi_create_async_work about which threads are used to invoke the execute and complete callbacks. Changed 'async' to 'asynchronous' in the documentation for Custom Asynchronous Operations. Changed "executes in parallel" to "can execute in parallel" for the documentation of napi_create_async_work execute parameter. Backport-PR-URL: #19447 PR-URL: #19073 Fixes: #19071 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Documentation for N-API Custom Asynchronous Operations incorrectly stated that async execution happens on the main event loop. Added details to napi_create_async_work about which threads are used to invoke the execute and complete callbacks. Changed 'async' to 'asynchronous' in the documentation for Custom Asynchronous Operations. Changed "executes in parallel" to "can execute in parallel" for the documentation of napi_create_async_work execute parameter. Backport-PR-URL: #19265 PR-URL: #19073 Fixes: #19071 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

Documentation for N-API Custom Asynchronous Operations incorrectly stated that async execution happens on the main event loop. Added details to napi_create_async_work about which threads are used to invoke the execute and complete callbacks. Changed 'async' to 'asynchronous' in the documentation for Custom Asynchronous Operations. Changed "executes in parallel" to "can execute in parallel" for the documentation of napi_create_async_work execute parameter. PR-URL: nodejs#19073 Fixes: nodejs#19071 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

ebickle mentioned this issue Mar 1, 2018

doc: fix n-api asynchronous threading documentation #19073

Closed

2 tasks

apapirovski closed this as completed in 449d1c8 Mar 4, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

N-API documentation incorectly states napi_create_async_work is not multithreaded #19071

N-API documentation incorectly states napi_create_async_work is not multithreaded #19071

ebickle commented Mar 1, 2018 •

edited

Loading

N-API documentation incorectly states napi_create_async_work is not multithreaded #19071

N-API documentation incorectly states napi_create_async_work is not multithreaded #19071

Comments

ebickle commented Mar 1, 2018 • edited Loading

ebickle commented Mar 1, 2018 •

edited

Loading