Skip to content

doc: clarify async execute callback usage #21217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mhdawson wants to merge 2 commits into from
Closed

doc: clarify async execute callback usage #21217

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e11e8fd
doc: clarify async execute callback usage
mhdawson Jun 8, 2018
158c729
squash: address comments.
mhdawson Jun 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: clarify async execute callback usage 
Clarify that calls to N-API should be avoided in
the 'execute' callback.

Refs: nodejs/help#1318
  • Loading branch information
@mhdawson
mhdawson committed Jun 8, 2018
commit e11e8fd2e61c381d2c8b0dc8b41527ce85ad4136
14 changes: 13 additions & 1 deletion doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ operations. Callback functions must statisfy the following signature:
typedef void (*napi_async_execute_callback)(napi_env env, void* data);
```

Implementations of this type of function should avoid making any N-API calls
that could result in the execution of JavaScript or interaction with
JavaScript objects. Most often any code that needs to make N-API
Copy link
Copy Markdown
Member

@Trott Trott Jun 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Micro-nit: comma after often

calls should be made in `napi_async_complete_callback` instead.

#### napi_async_complete_callback
Function pointer used with functions that support asynchronous
operations. Callback functions must statisfy the following signature:
Expand Down Expand Up @@ -3322,7 +3327,14 @@ asynchronous workers. Instances are created/deleted with

The `execute` and `complete` callbacks are functions that will be
invoked when the executor is ready to execute and when it completes its
task respectively. These functions implement the following interfaces:
task respectively.

The `execute` function should avoid making any N-API calls
that could result in the execution of JavaScript or interaction with
JavaScript objects. Most often any code that needs to make N-API
Copy link
Copy Markdown
Member

@Trott Trott Jun 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

calls should be made in `complete` callback instead.

These functions implement the following interfaces:

```C
typedef void (*napi_async_execute_callback)(napi_env env,
Expand Down