| commit | 993e42aacd16efb6310f25c49797583afa970dd0 | [log] [tgz] |
|---|---|---|
| author | Aaron Zinman <aaron@azinman.com> | Mon Jun 20 23:37:59 2016 -0700 |
| committer | Aaron Zinman <aaron@azinman.com> | Mon Jun 20 23:37:59 2016 -0700 |
| tree | 625e2c10ad47996c8eb8e04dc699e8d8a0d14b58 | |
| parent | da8a23487209138836c10a3b1c9b5224aabf7f0f [diff] |
swift: Create high-level Syncbase framework Initial implementation of the Sycnbase high level API and framework. Builds on top of the SyncbaseCore framework and its CGO library so no changes yet needed for the jiri swift command. This CL achieves parity with the current Java high-level API, although it has not been tested much. Unit tests and bug fixes to come. Note unit tests are currently not passing due to blessings issues that are being worked on wrt to init and login. This CL has following additional changes to the SyncbaseCore framework to make this high-level work possible: - Match the HLAPI in terms of configure/init/login, pass rootDir to v23_syncbase_Init() - Remove Threads.swift as its largely unused. - Implement Database.syncgroup, Database.listSyncgroups, - Collection.exists(row) - Make public many things that were incorrectly internal - Create public initializers for structs - Add runInBatchSync support function + unit test for Syncbase high-level - Add Exist/NoExist errors to SyncbaseError - Create a queue public variable to let the user control threads for callbacks - Make ResumeMarker a typealias instead of a struct - Refactors the OAuth credentials to not force the Google Credential in SyncbaseCore, uses the Syncbase.queue for the callback - Consistently refers to UTF-8 instead of UTF8 in comments and error descriptions, matching the HLAPI. - Make sure callbacks are always on Syncbase.queue and not main. Change-Id: I82c765d269486a7e6c332f796a6896a0ef107677
#Vanadium & Syncbase Swift Demos
The Vanadium/Syncbase Swift implementation is very iOS/OS X specific at this point, especially since the open source release Linux is very early as of this writing (April 2016).
Currently the following are included in the iOS demo:
“Hello world” RPC with a hard coded endpoint (discovery coming soon)
Google Sign-In OAuth used to obtain a default blessing via dev.v.io. Currently broken until we update the security APIs for Syncbase.
Bluetooth discovery/advertisement tests (not using Vanadium itself, but a test hardness to validate BLE compatibility across hardware)
Requires Swift 2.2 which is available in Xcode 7.3. Any earlier versions won't compile, and a later version of Swift will also likely cause a problem as well.
Both the demo and the libraries target iOS 9.0+. We do not support 32-bit ARM, so therefore iOS 9.0 and ARM64 are the required minimum platforms.
The project is split into the following frameworks:
VanadiumCore.framework - This is the Swift bridge to the V23 runtime. It is intended for full Vanadium development, such as performing RPC and manual discovery management.
SyncbaseCore.framework - This is the simple & high-level framework that abstracts away VanadiumCore and exposes a direct Swift API for Syncbase. This is a lower-level building block for Syncbase.
Syncbase.framework - (COMING). We intend most apps will only need to work with APIs in Syncbase.framework for the near-future.
Eventually we will also distribute via Cocoapods, but until then it is required that a checkout of Vanadium is done correctly across multiple-repositories as Demo/VanadiumCore/Syncbase rely on code in the third-party repo separate from this swift-repo.
The repo does not include any of the built CGO libraries or header files. These must be built before the demo may be compiled and run using the following instructions:
In order to compile the CGO library for the iOS platform, we need to install a cross-compiling version of go first. It‘s important to do this for all supported platforms even if you’re only planning on compiling for the simulator, because our Xcode project expects to see files for all architectures (they can be kept out of sync while developing, however).
Install the 64-bit simulator Go profile:
jiri profile install -target amd64-ios v23:base
Install the 64-bit device Go profile:
jiri profile install -target arm64-ios v23:base
For simulator only (these are equivalent)
jiri swift build -project SyncbaseCore cgo # or jiri swift build -project SyncbaseCore -target amd64 cgo
For device:
jiri swift build -project SyncbaseCore -target arm64 cgo
For both:
jiri swift build -project SyncbaseCore -target all cgo
You may specify SyncbaseCore or VanadiumCore with the -project flags. Each are required to run their respective demos.