feat(Worklets): Worklet Runtime C++ scheduling API #8456
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.
Summary
Inspired by #8425
I'm adding scheduling APIs for the
WorkletRuntimeclass resembling the ones in TypeScript API. I preserved previous scheduling APIs as deprecated.Synchronous call methods
jsi::Functionorstd::shared_ptr<SerializableWorklet>runOn...SyncTS API etc.callGuardjsi::Valuejsi::Runtime & as an argument, i.e.std::function<TReturn(jsi::Runtime &)>`runOn...SyncTS API etc.callGuard- the user have to do it themselvesrunSyncbut returns extractedSerializablefromjsi::ValuecreateSerializablestd::function<TReturn(jsi::Runtime &)>asTReturnmight not be serializableAsynchronous call methods
scheduleOn...TS API etc.jsi::Function,std::shared_ptr<SerializableWorklet>,std::function<void()>orstd::function<void(jsi::Runtime&)>AsyncQueuesetjsi::Functionandstd::shared_ptr<SerializableWorklet>we don't want to be responsible for how arguments are stored in the lambda passed toAsyncQueuestd::functionthe user can store the arguments in their lambdarunAsyncfunction possibly returning promises (futures) is yet to be considered for implementation in future PRsDeprecated methods
runGuarded- identical torunSync, replaced withrunSyncrunAsyncGuarded- identical toschedule, replaced withscheduleexecuteSync- this function was a bit complicated. It took two runtimes, executed a worklet on the target runtime then serialized data back to the caller runtime. While it's a handy syntax sugar I think it shouldn't be a method of a runtime but rather some utility API. Replaced withrunSyncSerializedand manual extraction on the caller runtime.executeSync- identical torunSyncreplaced withrunSyncTest plan
⭐ BokehExample ⭐