mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Andy Street
2b251638a6
Summary: Now that web workers are just JSCExecutors, we can move forward with adding native module support. The means we need to supply the worker with a correct __fbBatchedBridgeConfig global so it can appropriately set up its JS MessageQueue. Unfortunately, native modules can't support multiple JS execution contexts out-of-the-box, so we need to whitelist those modules that actually can be referenced from a webworker. In order to do that, we add the supportsWebWorkers call in NativeModule and the SupportsWebWorkers annotation for JS modules. These add metadata to __fbBatchedBridgeConfig which allows us to create a new config with only those modules that support web workers. Reviewed By: lexs Differential Revision: D2927091 fb-gh-sync-id: 9b47331253b277940b552e7d899198b5f0a3ed8c shipit-source-id: 9b47331253b277940b552e7d899198b5f0a3ed8c
81 lines
2.8 KiB
Java
81 lines
2.8 KiB
Java
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
package com.facebook.react.bridge;
|
|
|
|
import java.io.IOException;
|
|
import java.util.Map;
|
|
|
|
import com.fasterxml.jackson.core.JsonGenerator;
|
|
|
|
/**
|
|
* A native module whose API can be provided to JS catalyst instances. {@link NativeModule}s whose
|
|
* implementation is written in Java should extend {@link BaseJavaModule} or {@link
|
|
* ReactContextBaseJavaModule}. {@link NativeModule}s whose implementation is written in C++
|
|
* must not provide any Java code (so they can be reused on other platforms), and instead should
|
|
* register themselves using {@link CxxModuleWrapper}.
|
|
*/
|
|
public interface NativeModule {
|
|
interface NativeMethod {
|
|
void invoke(CatalystInstance catalystInstance, ReadableNativeArray parameters);
|
|
String getType();
|
|
}
|
|
|
|
/**
|
|
* @return the name of this module. This will be the name used to {@code require()} this module
|
|
* from javascript.
|
|
*/
|
|
String getName();
|
|
|
|
/**
|
|
* @return methods callable from JS on this module
|
|
*/
|
|
Map<String, NativeMethod> getMethods();
|
|
|
|
/**
|
|
* Append a field which represents the constants this module exports
|
|
* to JS. If no constants are exported this should do nothing.
|
|
*/
|
|
void writeConstantsField(JsonGenerator jg, String fieldName) throws IOException;
|
|
|
|
/**
|
|
* This is called at the end of {@link CatalystApplicationFragment#createCatalystInstance()}
|
|
* after the CatalystInstance has been created, in order to initialize NativeModules that require
|
|
* the CatalystInstance or JS modules.
|
|
*/
|
|
void initialize();
|
|
|
|
/**
|
|
* Return true if you intend to override some other native module that was registered e.g. as part
|
|
* of a different package (such as the core one). Trying to override without returning true from
|
|
* this method is considered an error and will throw an exception during initialization. By
|
|
* default all modules return false.
|
|
*/
|
|
boolean canOverrideExistingModule();
|
|
|
|
/**
|
|
* Called on the JS thread after a ReactBridge has been created. This is useful for native modules
|
|
* that need to do any setup before the JS bundle has been loaded. An example of this would be
|
|
* installing custom functionality into the JavaScriptCore context.
|
|
*
|
|
* @param bridge the ReactBridge instance that has just been created
|
|
*/
|
|
void onReactBridgeInitialized(ReactBridge bridge);
|
|
|
|
/**
|
|
* Called before {CatalystInstance#onHostDestroy}
|
|
*/
|
|
void onCatalystInstanceDestroy();
|
|
|
|
/**
|
|
* Whether this native module supports calls from web workers. Ignored for now.
|
|
*/
|
|
boolean supportsWebWorkers();
|
|
}
|