com.facebook.react.cxxbridge

Class CxxModuleWrapper

java.lang.Object

com.facebook.react.cxxbridge.CxxModuleWrapper

All Implemented Interfaces:

NativeModule

public class CxxModuleWrapper
extends java.lang.Object
implements NativeModule

A Java Object which represents a cross-platform C++ module This module implements the NativeModule interface but will never be invoked from Java, instead the underlying Cxx module will be extracted by the bridge and called directly.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.react.bridge.NativeModule

NativeModule.NativeMethod

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CxxModuleWrapper(HybridData hd)
	CxxModuleWrapper(java.lang.String library, java.lang.String factory)

Method Summary

Modifier and Type	Method and Description
boolean	canOverrideExistingModule() Return true if you intend to override some other native module that was registered e.g.
java.util.Map<java.lang.String,NativeModule.NativeMethod>	getMethods()
java.lang.String	getName()
void	initialize() This is called at the end of CatalystApplicationFragment#createCatalystInstance() after the CatalystInstance has been created, in order to initialize NativeModules that require the CatalystInstance or JS modules.
void	onCatalystInstanceDestroy() Called before {CatalystInstance#onHostDestroy}
boolean	supportsWebWorkers() In order to support web workers, a module must be aware that it can be invoked from multiple different JS VMs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CxxModuleWrapper

public CxxModuleWrapper(java.lang.String library,
                        java.lang.String factory)

CxxModuleWrapper

protected CxxModuleWrapper(HybridData hd)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface NativeModule

Returns:

the name of this module. This will be the name used to require() this module from javascript.

getMethods

public java.util.Map<java.lang.String,NativeModule.NativeMethod> getMethods()

Specified by:

getMethods in interface NativeModule

Returns:

methods callable from JS on this module

initialize

public void initialize()

Description copied from interface: NativeModule

This is called at the end of CatalystApplicationFragment#createCatalystInstance() after the CatalystInstance has been created, in order to initialize NativeModules that require the CatalystInstance or JS modules.

Specified by:

initialize in interface NativeModule

canOverrideExistingModule

public boolean canOverrideExistingModule()

Description copied from interface: NativeModule

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.

Specified by:

canOverrideExistingModule in interface NativeModule

supportsWebWorkers

public boolean supportsWebWorkers()

Description copied from interface: NativeModule

In order to support web workers, a module must be aware that it can be invoked from multiple different JS VMs. Supporting web workers means recognizing things like: 1) ids (e.g. timer ids, request ids, etc.) may only unique on a per-VM basis 2) the module needs to make sure to enqueue callbacks and JS module calls to the correct VM In order to facilitate this, modules that support web workers will have all their @ReactMethod- annotated methods passed a ExecutorToken as the first parameter before any arguments from JS. This ExecutorToken internally maps to a specific JS VM and can be used by the framework to route calls appropriately. In order to make JS module calls correctly, start using the version of ReactContext.getJSModule(ExecutorToken, Class) that takes an ExecutorToken. It will ensure that any calls you dispatch to the returned object will go to the right VM. For Callbacks, you don't have to do anything special -- the framework automatically tags them with the correct ExecutorToken when the are created. Note: even though calls can come from multiple JS VMs on multiple threads, calls to this module will still only occur on a single thread.

Specified by:

supportsWebWorkers in interface NativeModule

Returns:

whether this module supports web workers.

onCatalystInstanceDestroy

public void onCatalystInstanceDestroy()

Description copied from interface: NativeModule

Called before {CatalystInstance#onHostDestroy}

Specified by:

onCatalystInstanceDestroy in interface NativeModule