| ▼Nobx | |
| Ninternal | |
| CAbstractCustomMsgClient | Typically used together with CustomMsgClientDelegate e.g. to ensure a matching interface. Subclasses represent a custom client |
| CAbstractCustomMsgConnection | Typically used together with CustomMsgServerDelegate e.g. to ensure a matching interface. Subclasses represent a connection of a custom server |
| CAbstractCustomMsgServer | Typically used together with CustomMsgServerDelegate e.g. to ensure a matching interface. Subclasses represent a custom server |
| CAsyncBox | AsyncBox provides asynchronous ("happening on the background") database manipulation |
| CAsyncTreeGetResult | |
| CAsyncTreePutResult | Parameter to AsyncTreePutCallback, which is passed to Tree::putAsync() |
| CBox | A Box offers database operations for objects of a specific type |
| CBoxTypeless | 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 |
| CBytesLazy | 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 |
| CClosable | |
| CCustomMsgClientDelegate | A helper class that delegates C style function pointers to C++ class method invocations via user data. Also, it provides makeFunctions() and registerProtocol() |
| CCustomMsgConnectionDelegate | 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 |
| CCustomMsgServerDelegate | A helper class that delegates C style function pointers to C++ class method invocations via user data. Also, it provides makeFunctions() and registerProtocol() |
| CDbException | 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) |
| CException | Base class for ObjectBox related exceptions. Note that there are currently 3 main sub types: IllegalArgumentException, IllegalStateException, and, for all other error types, DbException |
| CExpiredObjects | Removal of expired objects; see OBXPropertyFlags_EXPIRATION_TIME |
| CFeatureNotAvailableException | A functionality was invoked that is not part in this edition of ObjectBox |
| CIllegalArgumentException | Thrown when the passed arguments are illegal |
| CIllegalStateException | Thrown when a request does not make sense in the current state. For example, doing actions on a closed object |
| CLeavesInfo | 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 |
| CMaxDataSizeExceededException | 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 |
| COptions | 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 |
| CProperty | Carries property information when used in the entity-meta ("underscore") class |
| CProperty< EntityT, OBXPropertyType_ByteVector > | Carries property information when used in the entity-meta ("underscore") class |
| CProperty< EntityT, OBXPropertyType_FloatVector > | Carries property information when used in the entity-meta ("underscore") class |
| CProperty< EntityT, OBXPropertyType_String > | Carries property information when used in the entity-meta ("underscore") class |
| CProperty< EntityT, OBXPropertyType_StringVector > | Carries property information when used in the entity-meta ("underscore") class |
| CPropertyTypeless | Typeless property used as a base class for other types - sharing common conditions |
| CQuery | Query allows to find data matching user defined criteria for a entity type. Created by QueryBuilder and typically used with supplying a Cursor |
| CQueryBase | Query allows to find data matching user defined criteria for a entity type. Created by QueryBuilder and typically used with supplying a Cursor |
| CQueryBuilder | 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 |
| CQueryBuilderBase | 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 |
| CRelationProperty | Carries property-based to-one relation information when used in the entity-meta ("underscore") class |
| CRelationStandalone | Carries to-many relation information when used in the entity-meta ("underscore") class |
| CShuttingDownException | 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() |
| CStore | A ObjectBox store represents a database storing data in a given directory on a local file system |
| CSync | ObjectBox Sync makes data available on other devices. Start building a sync client using client() and connect to a remote server |
| CSyncChange | 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 |
| CSyncChangeListener | Notifies of fine granular changes on the object level happening during sync |
| CSyncClient | Sync client is used to provide ObjectBox Sync client capabilities to your application |
| CSyncClientCompletionListener | Listens to sync complete event on a sync client |
| CSyncClientConnectionListener | Listens to sync client connection events |
| CSyncClientErrorListener | Listens to sync error event on a sync client |
| CSyncClientListener | Listens to all possible sync events. See each base abstract class for detailed information |
| CSyncClientLoginListener | Listens to login events on a sync client |
| CSyncClientTimeListener | List |
| CSyncCredentials | Credentials for logging into a Sync Server that are passed to SyncClient. Typically created using a factory method, e.g. SyncCredentials::none() or SyncCredentials::jwtIdToken(...) |
| CSyncObjectsMessageBuilder | 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() |
| CSyncObjectsMessageListener | |
| CSyncServer | 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/ |
| CTransaction | 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" |
| CTree | Top level tree API representing a tree structure/schema associated with a store |
| CTreeCursor | 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 |
| CTreeOptions | Structural/behavioral options for a tree passed during tree creation |
1.9.8