#include <stdint.h>
#include "dart_api.h"
#include "objectbox-sync.h"

Include dependency graph for objectbox-dart.h:

Typedefs
typedef struct OBX_dart_sync_listener	OBX_dart_sync_listener

typedef struct OBX_dart_stream	OBX_dart_stream

typedef struct OBX_dart_finalizer	OBX_dart_finalizer

typedef obx_err	obx_dart_closer(void *native_object)
	A function to clean up native resources. Must be a c-function (non-throwing). The returned error is ignored. e.g. obx_query_close(), obx_store_close(), ...

Functions
OBX_C_API obx_err	obx_dart_init_api (void *data)
	Initializes Dart API - call before any other obx_dart_* functions.

OBX_C_API OBX_observer *	obx_dart_observe (OBX_store *store, int64_t native_port)

OBX_C_API OBX_observer *	obx_dart_observe_single_type (OBX_store *store, obx_schema_id type_id, int64_t native_port)

OBX_C_API obx_err	obx_dart_sync_listener_close (OBX_dart_sync_listener *listener)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_connect (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_disconnect (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_login (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_login_failure (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_complete (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_change (OBX_sync *sync, int64_t native_port)

OBX_C_API OBX_dart_sync_listener *	obx_dart_sync_listener_server_time (OBX_sync *sync, int64_t native_port)

OBX_C_API obx_id	obx_dart_async_put_object (OBX_async async, int64_t native_port, void data, size_t size, OBXPutMode mode)

OBX_C_API obx_err	obx_dart_stream_close (OBX_dart_stream *stream)

OBX_C_API OBX_dart_stream *	obx_dart_query_find (OBX_query *query, int64_t native_port)

OBX_C_API OBX_dart_stream *	obx_dart_query_find_ptr (OBX_query *query, int64_t native_port)

OBX_C_API OBX_dart_finalizer *	obx_dart_attach_finalizer (Dart_Handle dart_object, obx_dart_closer closer, void native_object, size_t native_object_size)
	Attaches a finalizer (destructor) to be called when the given object is garbage-collected.

OBX_C_API obx_err	obx_dart_detach_finalizer (OBX_dart_finalizer *finalizer, Dart_Handle dart_object)
	Detach the finalizer preliminarily, without executing its "closer".

Typedef Documentation

◆ obx_dart_closer

typedef obx_err obx_dart_closer(void *native_object)

A function to clean up native resources. Must be a c-function (non-throwing). The returned error is ignored. e.g. obx_query_close(), obx_store_close(), ...

◆ OBX_dart_finalizer

typedef struct OBX_dart_finalizer OBX_dart_finalizer

◆ OBX_dart_stream

typedef struct OBX_dart_stream OBX_dart_stream

◆ OBX_dart_sync_listener

typedef struct OBX_dart_sync_listener OBX_dart_sync_listener

Function Documentation

◆ obx_dart_async_put_object()

OBX_C_API obx_id obx_dart_async_put_object	(	OBX_async *	async,
		int64_t	native_port,
		void *	data,
		size_t	size,
		OBXPutMode	mode
	)

See also: obx_async_put_object()

◆ obx_dart_attach_finalizer()

OBX_C_API OBX_dart_finalizer * obx_dart_attach_finalizer	(	Dart_Handle	dart_object,
		obx_dart_closer *	closer,
		void *	native_object,
		size_t	native_object_size
	)

Attaches a finalizer (destructor) to be called when the given object is garbage-collected.

Parameters

dart_object	marks the object owning the native pointer
native_object	is the native pointer to be freed
closer	is the function that frees native_object
native_object_size	is an allocated size estimate - can be used by a the Dart garbage collector to prioritize

Returns: a finalizer freed automatically when the GC finalizer runs (or manually by obx_dart_detach_finalizer()); NULL if the finalizer couldn't be attached, in which case the caller is responsible for running the closer

◆ obx_dart_detach_finalizer()

OBX_C_API obx_err obx_dart_detach_finalizer	(	OBX_dart_finalizer *	finalizer,
		Dart_Handle	dart_object
	)

Detach the finalizer preliminarily, without executing its "closer".

◆ obx_dart_init_api()

OBX_C_API obx_err obx_dart_init_api ( void * data )

Initializes Dart API - call before any other obx_dart_* functions.

◆ obx_dart_observe()

OBX_C_API OBX_observer * obx_dart_observe	(	OBX_store *	store,
		int64_t	native_port
	)

See also: obx_observe() Note: use obx_observer_close() to free unassign the observer and free resources after you're done with it

◆ obx_dart_observe_single_type()

OBX_C_API OBX_observer * obx_dart_observe_single_type	(	OBX_store *	store,
		obx_schema_id	type_id,
		int64_t	native_port
	)

◆ obx_dart_query_find()

OBX_C_API OBX_dart_stream * obx_dart_query_find	(	OBX_query *	query,
		int64_t	native_port
	)

See also: obx_dart_stream_query_find

◆ obx_dart_query_find_ptr()

OBX_C_API OBX_dart_stream * obx_dart_query_find_ptr	(	OBX_query *	query,
		int64_t	native_port
	)

◆ obx_dart_stream_close()

OBX_C_API obx_err obx_dart_stream_close ( OBX_dart_stream * stream )

◆ obx_dart_sync_listener_change()

OBX_C_API OBX_dart_sync_listener * obx_dart_sync_listener_change	(	OBX_sync *	sync,
		int64_t	native_port
	)

See also: obx_sync_listener_change()

◆ obx_dart_sync_listener_close()

OBX_C_API obx_err obx_dart_sync_listener_close ( OBX_dart_sync_listener * listener )