obx Namespace Reference

Namespaces
	internal

Classes
class	SyncCredentials
class	SyncClientLoginListener
	Listens to login events on a sync client. More...
class	SyncClientConnectionListener
	Listens to sync client connection events. More...
class	SyncClientCompletionListener
	Listens to sync complete event on a sync client. More...
class	SyncClientErrorListener
	Listens to sync error event on a sync client. More...
class	SyncClientTimeListener
	List. More...
struct	SyncChange
	A collection of changes made to one entity type during a sync transaction. Delivered via SyncClientChangeListener. IDs of changed objects are available via puts and those of removed objects via removals. More...
class	SyncChangeListener
	Notifies of fine granular changes on the object level happening during sync. More...
class	SyncClientListener
	Listens to all possible sync events. See each base abstract class for detailed information. More...
class	SyncObjectsMessageListener
class	SyncObjectsMessageBuilder
	Start here to prepare an 'objects message'. You must add at least one object and then you can send the message using SyncClient::send() or SyncServer::send(). More...
class	SyncClient
	Sync client is used to provide ObjectBox Sync client capabilities to your application. More...
class	Sync
	ObjectBox Sync makes data available on other devices. Start building a sync client using client() and connect to a remote server. More...
class	SyncServer
	The ObjectBox Sync Server to run within your application (embedded server). Note that you need a special sync edition, which includes the server components. Check https://objectbox.io/sync/. More...
class	CustomMsgClientDelegate
	A helper class that delegates C style function pointers to C++ class method invocations via user data. Also, it provides makeFunctions() and registerProtocol(). More...
class	AbstractCustomMsgClient
	Typically used together with CustomMsgClientDelegate e.g. to ensure a matching interface. Subclasses represent a custom client. More...
class	CustomMsgServerDelegate
	A helper class that delegates C style function pointers to C++ class method invocations via user data. Also, it provides makeFunctions() and registerProtocol(). More...
class	AbstractCustomMsgConnection
	Typically used together with CustomMsgServerDelegate e.g. to ensure a matching interface. Subclasses represent a connection of a custom server. More...
class	CustomMsgConnectionDelegate
	Used internally to decouple the lifetime of the user connection object from the one "managed" (created/deleted) by AbstractCustomMsgServer/CustomMsgServerDelegate. This way, the user connection can be clear at any time. More...
class	AbstractCustomMsgServer
	Typically used together with CustomMsgServerDelegate e.g. to ensure a matching interface. Subclasses represent a custom server. More...
class	Exception
	Base class for ObjectBox related exceptions. Note that there are currently 3 main sub types: IllegalArgumentException, IllegalStateException, and, for all other error types, DbException. More...
class	IllegalArgumentException
	Thrown when the passed arguments are illegal. More...
class	IllegalStateException
	Thrown when a request does not make sense in the current state. For example, doing actions on a closed object. More...
class	MaxDataSizeExceededException
	Thrown when a transaction is about to commit but it would exceed the user-defined data size limit. See obx_opt_max_data_size_in_kb() for details. More...
class	ShuttingDownException
	The operation on a resource (typically a Store) failed because the resources is in process of being shut down or already has shutdown. For example, calling methods on the Store will throw this exception after Store::close(). More...
class	DbException
	Database related exception, containing a error code to differentiate between various errors. Note: what() typically contains a specific text about the error condition (sometimes helpful to resolve the issue). More...
class	FeatureNotAvailableException
	A functionality was invoked that is not part in this edition of ObjectBox. More...
class	BytesLazy
	Bytes, which must be resolved "lazily" via get() and released via this object (destructor). Unlike void* style bytes, this may represent allocated resources and/or bytes that are only produced on demand. More...
class	Box
	A Box offers database operations for objects of a specific type. More...
class	AsyncBox
	AsyncBox provides asynchronous ("happening on the background") database manipulation. More...
class	Closable
class	Options
	Options provide a way to configure Store when opening it. Options functions can be chained, e.g. options.directory("mypath/objectbox").maxDbSizeInKb(2048); Note: Options objects can be used only once to create a store as they are "consumed" during Store creation. Thus, you need to create a new Option object for each Store that is created. More...
class	Store
	A ObjectBox store represents a database storing data in a given directory on a local file system. More...
class	Transaction
	Provides RAII wrapper for an active database transaction on the current thread (do not use across threads). A Transaction object is considered a "top level transaction" if it is the first one on the call stack in the thread. If the thread already has an ongoing Transaction, additional Transaction instances are considered "inner transactions". More...
class	PropertyTypeless
	Typeless property used as a base class for other types - sharing common conditions. More...
class	Property
	Carries property information when used in the entity-meta ("underscore") class. More...
class	Property< EntityT, OBXPropertyType_String >
	Carries property information when used in the entity-meta ("underscore") class. More...
class	Property< EntityT, OBXPropertyType_ByteVector >
	Carries property information when used in the entity-meta ("underscore") class. More...
class	Property< EntityT, OBXPropertyType_StringVector >
	Carries property information when used in the entity-meta ("underscore") class. More...
class	Property< EntityT, OBXPropertyType_FloatVector >
	Carries property information when used in the entity-meta ("underscore") class. More...
class	RelationProperty
	Carries property-based to-one relation information when used in the entity-meta ("underscore") class. More...
class	RelationStandalone
	Carries to-many relation information when used in the entity-meta ("underscore") class. More...
class	Query
	Query allows to find data matching user defined criteria for a entity type. Created by QueryBuilder and typically used with supplying a Cursor. More...
class	QueryBuilderBase
	A QueryBuilderBase is used to create database queries using an API (no string based query language). Building the queries involves calling functions to add conditions for the query. In the end a Query object is build, which then can be used to actually run the query (potentially multiple times). For generated code, you can also use the templated subclass QueryBuilder instead to have type safety at compile time. More...
class	QueryBuilder
	See QueryBuilderBase for general information on query builders; this templated class allows to work with generated entity types conveniently. To specify actual conditions, use obx_qb_*() methods with queryBuilder.cPtr() as the first argument. More...
class	QueryBase
	Query allows to find data matching user defined criteria for a entity type. Created by QueryBuilder and typically used with supplying a Cursor. More...
class	BoxTypeless
	Like Box, but without template type. Serves as the basis for Box, but can also be used as "lower-level" box with some restrictions on the functionality. More...
class	ExpiredObjects
	Removal of expired objects; see OBXPropertyFlags_EXPIRATION_TIME. More...
class	TreeOptions
	Structural/behavioral options for a tree passed during tree creation. More...
struct	AsyncTreePutResult
	Parameter to AsyncTreePutCallback, which is passed to Tree::putAsync(). More...
struct	AsyncTreeGetResult
class	Tree
	Top level tree API representing a tree structure/schema associated with a store. More...
class	LeavesInfo
	Information about a set of leaf nodes that is returned by TreeCursor::getLeavesInfo(). Contains meta data about (data) leaves: full path in the tree, ID, and property type. More...
class	TreeCursor
	Primary tree interface against the database. Offers tree path based get/put functionality. Not-thread safe: use a TreeCursor instance from one thread only; i.e. the underlying transaction is bound to a thread. More...

Typedefs
using	ObxLogCallback = std::function< void(OBXLogLevel logLevel, const char *text, size_t textSize)>
using	AsyncStatusCallback = std::function< void(obx_err err)>
using	AsyncTreePutCallback = std::function< void(const AsyncTreePutResult &result)>
using	AsyncTreeGetCallback = std::function< void(const AsyncTreeGetResult &result)>

Enumerations
enum class	TxMode { READ , WRITE }
	Transactions can be started in read (only) or write mode. More...
enum class	TreePutResult { Undefined , Success , PathNotFound , DidNotPut }
	Regular results in the sense of "not throwing an exception" for put operations via TreeCursor. More...