Repository navigation
tsfn: implement TypedThreadSafeFunction #742
implement optional function callback
- Loading branch information
commit cc8de121c0abb3994855352398c9a4647a5b1efa
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4317,7 +4317,241 @@ inline void AsyncWorker::OnWorkComplete(Napi::Env /*env*/, napi_status status) { | |
| // ThreadSafeFunctionEx<ContextType,DataType,CallJs> class | ||
| //////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| // Starting with NAPI 4, the JavaScript function `func` parameter of | ||
|
Member
There was a problem hiding this comment. Should this say starting with NAPI 5 , as that is what the #if does.
Contributor
Author
There was a problem hiding this comment. Good catch; this has been addressed here. |
||
| // `napi_create_threadsafe_function` is optional. | ||
| #if NAPI_VERSION > 4 | ||
| // static, with Callback [missing] Resource [missing] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, ResourceString resourceName, size_t maxQueueSize, | ||
| size_t initialThreadCount, ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, | ||
| CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [nullptr] Resource [missing] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, std::nullptr_t callback, ResourceString resourceName, size_t maxQueueSize, | ||
| size_t initialThreadCount, ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, | ||
| CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [missing] Resource [passed] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, const Object &resource, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, CallJsInternal, | ||
| &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [nullptr] Resource [passed] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, std::nullptr_t callback, const Object &resource, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, CallJsInternal, | ||
| &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [missing] Resource [missing] Finalizer [passed] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
| typename FinalizerDataType> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, ResourceString resourceName, size_t maxQueueSize, | ||
| size_t initialThreadCount, ContextType *context, Finalizer finalizeCallback, | ||
| FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [nullptr] Resource [missing] Finalizer [passed] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
| typename FinalizerDataType> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, std::nullptr_t callback, ResourceString resourceName, size_t maxQueueSize, | ||
| size_t initialThreadCount, ContextType *context, Finalizer finalizeCallback, | ||
| FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [missing] Resource [passed] Finalizer [passed] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
| typename FinalizerDataType> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, const Object &resource, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context, | ||
| Finalizer finalizeCallback, FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [nullptr] Resource [passed] Finalizer [passed] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
| typename FinalizerDataType> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, std::nullptr_t callback, const Object &resource, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context, | ||
| Finalizer finalizeCallback, FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, nullptr, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
| #endif | ||
|
|
||
| // static, with Callback [passed] Resource [missing] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, const Function &callback, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, callback, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, CallJsInternal, | ||
| &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [x] Resource [x] Finalizer [missing] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString> | ||
|
|
@@ -4326,12 +4560,51 @@ ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | |
| napi_env env, const Function &callback, const Object &resource, | ||
| ResourceString resourceName, size_t maxQueueSize, size_t initialThreadCount, | ||
| ContextType *context) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| napi_status status = napi_create_threadsafe_function( | ||
| env, callback, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, nullptr, nullptr, context, CallJsInternal, | ||
| &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with Callback [x] Resource [missing ] Finalizer [x] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
| typename FinalizerDataType> | ||
| inline ThreadSafeFunctionEx<ContextType, DataType, CallJs> | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | ||
| napi_env env, const Function &callback, ResourceString resourceName, | ||
| size_t maxQueueSize, size_t initialThreadCount, ContextType *context, | ||
| Finalizer finalizeCallback, FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, callback, nullptr, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| // static, with: Callback [x] Resource [x] Finalizer [x] | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| template <typename ResourceString, typename Finalizer, | ||
|
|
@@ -4341,11 +4614,24 @@ ThreadSafeFunctionEx<ContextType, DataType, CallJs>::New( | |
| napi_env env, const Function &callback, const Object &resource, | ||
| ResourceString resourceName, size_t maxQueueSize, size_t initialThreadCount, | ||
| ContextType *context, Finalizer finalizeCallback, FinalizerDataType *data) { | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs> tsfn; | ||
|
|
||
| auto *finalizeData = new details::ThreadSafeFinalize<ContextType, Finalizer, | ||
| FinalizerDataType>( | ||
| {data, finalizeCallback}); | ||
| napi_status status = napi_create_threadsafe_function( | ||
| env, callback, resource, String::From(env, resourceName), maxQueueSize, | ||
| initialThreadCount, finalizeData, | ||
| details::ThreadSafeFinalize<ContextType, Finalizer, FinalizerDataType>:: | ||
| FinalizeFinalizeWrapperWithDataAndContext, | ||
| context, CallJsInternal, &tsfn._tsfn); | ||
| if (status != napi_ok) { | ||
| delete finalizeData; | ||
| NAPI_THROW_IF_FAILED(env, status, | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>()); | ||
| } | ||
|
|
||
| return tsfn; | ||
| } | ||
|
|
||
| template <typename ContextType, typename DataType, | ||
|
|
@@ -4438,43 +4724,23 @@ ThreadSafeFunctionEx<ContextType, DataType, CallJs>::GetContext() const { | |
| // static | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| void ThreadSafeFunctionEx<ContextType, DataType, CallJs>::CallJsInternal( | ||
| napi_env env, napi_value jsCallback, void *context, void *data) { | ||
| details::CallJsWrapper<ContextType, DataType, decltype(CallJs), CallJs>( | ||
| env, jsCallback, context, data); | ||
| } | ||
|
|
||
| // static | ||
| template <typename ContextType, typename DataType, | ||
| void (*CallJs)(Napi::Env, Napi::Function, ContextType *, DataType *)> | ||
| typename ThreadSafeFunctionEx<ContextType, DataType, CallJs>::DefaultFunctionType | ||
| ThreadSafeFunctionEx<ContextType, DataType, CallJs>::DefaultFunctionFactory( | ||
| Napi::Env env) { | ||
| #if NAPI_VERSION > 4 | ||
| return nullptr; | ||
| #else | ||
| return Function::New(env, [](const CallbackInfo &cb) {}); | ||
| #endif | ||
| } | ||
|
|
||
| //////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this change necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was for testing, will remove...