-
-
Notifications
You must be signed in to change notification settings - Fork 311
MultiProcess mode on Android #611
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
maxencehenneron
wants to merge
3
commits into
mrousavy:main
Choose a base branch
from
appsent-co:master
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
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 |
---|---|---|
|
@@ -6,6 +6,14 @@ interface Listener { | |
remove: () => void; | ||
} | ||
|
||
/** | ||
* All the possible MMKV modes. The values are extracted from [MMKV.h](https://github.com/Tencent/MMKV/blob/a8d3cdd2a43a8e5c5ab5043dfad111c96a4963bf/Core/MMKV.h#L41) | ||
*/ | ||
export enum MMKVMode { | ||
SingleProcess = 1 << 0, | ||
MultiProcess = 1 << 1, | ||
} | ||
|
||
/** | ||
* Used for configuration of a single MMKV instance. | ||
*/ | ||
|
@@ -46,6 +54,20 @@ export interface MMKVConfiguration { | |
* ``` | ||
*/ | ||
encryptionKey?: string; | ||
/** | ||
* *Android Only*: The MMKV mode. It is set to SingleProcess by default. You can set its value to MultiProcess to support simultaneous read-write access between processus at the cost of performance. | ||
* | ||
* This is useful when you want to share data between your react-native app and native extensions such as widgets. | ||
* | ||
* @example | ||
* ```ts | ||
* const extensionStorage = new MMKV({ mode: MMKVMode.MultiProcess }) | ||
* ``` | ||
* | ||
* _Notice_: On iOS, this will automatically be set to MMKVMode.MultiProcess if you set an AppGroup in the plist configuration. | ||
* More information on AppGroups [here](https://github.com/mrousavy/react-native-mmkv/tree/master#app-groups) | ||
*/ | ||
mode?: MMKVMode; | ||
|
||
} | ||
|
||
/** | ||
|
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.
Is it possible to also use this prop for iOS? I hate having "android only" or "ios only" props... Maybe we can just reconfigure the instance on iOS when this prop is passed?
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.
Unfortunately no, I wanted to do this first but on iOS we only have the following constructors:
As you can see we cannot set both "rootPath" and "mode" at the same time, meaning the only way to set MMKVMode to "multi-process" is to set an AppGroup when initializing MMKV.
Uh oh!
There was an error while loading. Please reload this page.
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.
I could however add support for single-process mode with AppGroups but I'm not sure why would anyone want to do that.