Commit 88521ea

committed

Merge branch '159-database-and-sync-version-apis' into 'main'

Add getters for Sync protocol, database version See merge request objectbox/objectbox-dart!117

2 parents 419ce2c + d8743be commit 88521eaCopy full SHA for 88521ea

File tree

+21

-1

lines changed

+21

-1

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -498,6 +498,13 @@ class Store implements Finalizable {`
`498`	`498`	`detach: this, externalSize: 200 * 1024);`
`499`	`499`	`}`
`500`	`500`
	`501`	`+ /// Returns the version and features of the platform-specific ObjectBox`
	`502`	`+ /// database library.`
	`503`	`+ ///`
	`504`	`+ /// The format may change in any future release, only use this for`
	`505`	`+ /// informational purposes.`
	`506`	`+ static String databaseVersion() => dartStringFromC(C.version_core_string());`
	`507`	`+`
`501`	`508`	`/// Returns if an open store (i.e. opened before and not yet closed) was found`
`502`	`509`	`/// for the given [directoryPath].`
`503`	`510`	`///`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -238,6 +238,13 @@ class SyncClient {`
`238`	`238`	`/// Returns if this sync client is closed and can no longer be used.`
`239`	`239`	`bool isClosed() => _cSync.address == 0;`
`240`	`240`
	`241`	`+ /// Returns the protocol version this client uses.`
	`242`	`+ static int protocolVersion() => C.sync_protocol_version();`
	`243`	`+`
	`244`	`+ /// Returns the protocol version of the server after a connection is`
	`245`	`+ /// established (or attempted), zero otherwise.`
	`246`	`+ int protocolVersionServer() => C.sync_protocol_version_server(_ptr);`
	`247`	`+`
`241`	`248`	`/// Gets the current sync client state.`
`242`	`249`	`SyncState state() {`
`243`	`250`	`final state = C.sync_state(_ptr);`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`import 'dart:ffi' as ffi;`
`2`	`2`
`3`	`3`	`import 'package:objectbox/internal.dart';`
	`4`	`+import 'package:objectbox/objectbox.dart';`
`4`	`5`	`import 'package:objectbox/src/native/bindings/bindings.dart';`
`5`	`6`	`import 'package:objectbox/src/native/bindings/helpers.dart';`
`6`	`7`	`import 'package:objectbox/src/native/version.dart';`
`@@ -14,7 +15,8 @@ void main() {`
`14`	`15`	`expect(atLeastDart("999.0.0"), false);`
`15`	`16`	`});`
`16`	`17`
`17`		`- print("Testing basics of ObjectBox using C lib V${libraryVersion()}");`
	`18`	`+ print("Testing basics of ObjectBox using C lib V${libraryVersion()} "`
	`19`	`+ "with database version ${Store.databaseVersion()}");`
`18`	`20`
`19`	`21`	`// Prior to Dart 2.6, the exception wasn't accessible and may have crashed.`
`20`	`22`	`// Similarly, this occured in Fluter for Linux (desktop).`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ void main() {`
`99`	`99`
`100`	`100`	`if (Sync.isAvailable()) {`
`101`	`101`	`// TESTS to run when SYNC is available`
	`102`	`+ print("Testing Sync with protocol version ${SyncClient.protocolVersion()}");`
`102`	`103`
`103`	`104`	`test('SyncClient lifecycle', () {`
`104`	`105`	`expect(store.syncClient(), isNull);`
`@@ -210,6 +211,9 @@ void main() {`
`210`	`211`	`SyncClient c = createClient(store);`
`211`	`212`	`expect(c.isClosed(), isFalse);`
`212`	`213`
	`214`	`+ expect(SyncClient.protocolVersion(), greaterThanOrEqualTo(7));`
	`215`	`+ expect(c.protocolVersionServer(), 0);`
	`216`	`+`
`213`	`217`	`c.setCredentials(SyncCredentials.none());`
`214`	`218`	`c.setCredentials(SyncCredentials.googleAuthString('secret'));`
`215`	`219`	`c.setCredentials(SyncCredentials.sharedSecretString('secret'));`

Comments

(0)