@@ -52,9 +52,9 @@ virtual void Napi::AsyncProgressWorker::OnOK();
52
52
### OnProgress
53
53
54
54
This method is invoked when the computation in the
55
- ` Napi::AsyncProgressWorker::ExecutionProcess ::Send ` method was called during
55
+ ` Napi::AsyncProgressWorker::ExecutionProgress ::Send ` method was called during
56
56
worker thread execution. This method can also be triggered via a call to
57
- ` Napi::AsyncProgress[Queue]Worker::ExecutionProcess ::Signal ` , in which case the
57
+ ` Napi::AsyncProgress[Queue]Worker::ExecutionProgress ::Signal ` , in which case the
58
58
` data ` parameter will be ` nullptr ` .
59
59
60
60
``` cpp
@@ -227,40 +227,40 @@ unexpected upcoming thread safe calls.
227
227
virtual Napi::AsyncProgressWorker::~AsyncProgressWorker ();
228
228
```
229
229
230
- # AsyncProgressWorker::ExecutionProcess
230
+ # AsyncProgressWorker::ExecutionProgress
231
231
232
232
A bridge class created before the worker thread execution of ` Napi::AsyncProgressWorker::Execute ` .
233
233
234
234
## Methods
235
235
236
236
### Send
237
237
238
- ` Napi::AsyncProgressWorker::ExecutionProcess ::Send ` takes two arguments, a pointer
238
+ ` Napi::AsyncProgressWorker::ExecutionProgress ::Send ` takes two arguments, a pointer
239
239
to a generic type of data, and a ` size_t ` to indicate how many items the pointer is
240
240
pointing to.
241
241
242
242
The data pointed to will be copied to internal slots of ` Napi::AsyncProgressWorker ` so
243
- after the call to ` Napi::AsyncProgressWorker::ExecutionProcess ::Send ` the data can
243
+ after the call to ` Napi::AsyncProgressWorker::ExecutionProgress ::Send ` the data can
244
244
be safely released.
245
245
246
- Note that ` Napi::AsyncProgressWorker::ExecutionProcess ::Send ` merely guarantees
246
+ Note that ` Napi::AsyncProgressWorker::ExecutionProgress ::Send ` merely guarantees
247
247
** eventual** invocation of ` Napi::AsyncProgressWorker::OnProgress ` , which means
248
248
multiple send might be coalesced into single invocation of ` Napi::AsyncProgressWorker::OnProgress `
249
249
with latest data. If you would like to guarantee that there is one invocation of
250
250
` OnProgress ` for every ` Send ` call, you should use the ` Napi::AsyncProgressQueueWorker `
251
251
class instead which is documented further down this page.
252
252
253
253
``` cpp
254
- void Napi::AsyncProgressWorker::ExecutionProcess ::Send (const T* data, size_t count) const;
254
+ void Napi::AsyncProgressWorker::ExecutionProgress ::Send (const T* data, size_t count) const;
255
255
```
256
256
257
257
### Signal
258
258
259
- `Napi::AsyncProgressWorker::ExecutionProcess ::Signal` triggers an invocation of
259
+ `Napi::AsyncProgressWorker::ExecutionProgress ::Signal` triggers an invocation of
260
260
`Napi::AsyncProgressWorker::OnProgress` with `nullptr` as the `data` parameter.
261
261
262
262
```cpp
263
- void Napi::AsyncProgressWorker::ExecutionProcess ::Signal();
263
+ void Napi::AsyncProgressWorker::ExecutionProgress ::Signal();
264
264
```
265
265
266
266
## Example
@@ -402,38 +402,38 @@ thread in the order it was committed.
402
402
For the most basic use, only the ` Napi::AsyncProgressQueueWorker::Execute ` and
403
403
` Napi::AsyncProgressQueueWorker::OnProgress ` method must be implemented in a subclass.
404
404
405
- # AsyncProgressQueueWorker::ExecutionProcess
405
+ # AsyncProgressQueueWorker::ExecutionProgress
406
406
407
407
A bridge class created before the worker thread execution of ` Napi::AsyncProgressQueueWorker::Execute ` .
408
408
409
409
## Methods
410
410
411
411
### Send
412
412
413
- ` Napi::AsyncProgressQueueWorker::ExecutionProcess ::Send ` takes two arguments, a pointer
413
+ ` Napi::AsyncProgressQueueWorker::ExecutionProgress ::Send ` takes two arguments, a pointer
414
414
to a generic type of data, and a ` size_t ` to indicate how many items the pointer is
415
415
pointing to.
416
416
417
417
The data pointed to will be copied to internal slots of ` Napi::AsyncProgressQueueWorker ` so
418
- after the call to ` Napi::AsyncProgressQueueWorker::ExecutionProcess ::Send ` the data can
418
+ after the call to ` Napi::AsyncProgressQueueWorker::ExecutionProgress ::Send ` the data can
419
419
be safely released.
420
420
421
- ` Napi::AsyncProgressQueueWorker::ExecutionProcess ::Send ` guarantees invocation
421
+ ` Napi::AsyncProgressQueueWorker::ExecutionProgress ::Send ` guarantees invocation
422
422
of ` Napi::AsyncProgressQueueWorker::OnProgress ` , which means multiple ` Send `
423
423
call will result in the in-order invocation of ` Napi::AsyncProgressQueueWorker::OnProgress `
424
424
with each data item.
425
425
426
426
``` cpp
427
- void Napi::AsyncProgressQueueWorker::ExecutionProcess ::Send (const T* data, size_t count) const;
427
+ void Napi::AsyncProgressQueueWorker::ExecutionProgress ::Send (const T* data, size_t count) const;
428
428
```
429
429
430
430
### Signal
431
431
432
- `Napi::AsyncProgressQueueWorker::ExecutionProcess ::Signal` triggers an invocation of
432
+ `Napi::AsyncProgressQueueWorker::ExecutionProgress ::Signal` triggers an invocation of
433
433
`Napi::AsyncProgressQueueWorker::OnProgress` with `nullptr` as the `data` parameter.
434
434
435
435
```cpp
436
- void Napi::AsyncProgressQueueWorker::ExecutionProcess ::Signal() const;
436
+ void Napi::AsyncProgressQueueWorker::ExecutionProgress ::Signal() const;
437
437
```
438
438
439
439
## Example
0 commit comments