Couchbase Lite C
Couchbase Lite C API
Loading...
Searching...
No Matches
CBLBase.h File Reference
#include "CBL_Edition.h"
#include "CBL_Compat.h"
#include "fleece/Fleece.h"
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  CBLError
 A struct holding information about an error. More...

Macros

#define CBL_REFCOUNTED(TYPE, NAME)

Typedefs

typedef int64_t CBLTimestamp
 A date/time representation used for document expiration (and in date/time queries.) Measured in milliseconds since the Unix epoch (1/1/1970, midnight UTC.)
typedef struct CBLRefCounted CBLRefCounted
typedef struct CBLDatabase CBLDatabase
 A connection to an open database.
typedef struct CBLScope CBLScope
 A collection's scope.
typedef struct CBLCollection CBLCollection
 A collection, a document container.
typedef struct CBLDocument CBLDocument
 An in-memory copy of a document.
typedef struct CBLBlob CBLBlob
 A binary data value associated with a CBLDocument.
typedef struct CBLQuery CBLQuery
 A compiled database query.
typedef struct CBLResultSet CBLResultSet
 An iterator over the rows resulting from running a query.
typedef struct CBLQueryIndex CBLQueryIndex
 A query index.
typedef struct CBLIndexUpdater CBLIndexUpdater
typedef struct CBLReplicator CBLReplicator
 A background task that syncs a CBLDatabase with a remote server or peer.
typedef struct CBLEncryptable CBLEncryptable
 An encryptable value.
typedef struct CBLCert CBLCert
 An opaque object representing the X.509 Certifcate.
typedef struct CBLListenerToken CBLListenerToken
 An opaque 'cookie' representing a registered listener callback.

Enumerations

enum  CBLErrorDomain : uint8_t {
  kCBLDomain = 1 , kCBLPOSIXDomain , kCBLSQLiteDomain , kCBLFleeceDomain ,
  kCBLNetworkDomain , kCBLWebSocketDomain , kCBLMbedTLSDomain
}
enum  CBLErrorCode : int32_t {
  kCBLErrorAssertionFailed = 1 , kCBLErrorUnimplemented , kCBLErrorUnsupportedEncryption , kCBLErrorBadRevisionID ,
  kCBLErrorCorruptRevisionData , kCBLErrorNotOpen , kCBLErrorNotFound , kCBLErrorConflict ,
  kCBLErrorInvalidParameter , kCBLErrorUnexpectedError , kCBLErrorCantOpenFile , kCBLErrorIOError ,
  kCBLErrorMemoryError , kCBLErrorNotWriteable , kCBLErrorCorruptData , kCBLErrorBusy ,
  kCBLErrorNotInTransaction , kCBLErrorTransactionNotClosed , kCBLErrorUnsupported , kCBLErrorNotADatabaseFile ,
  kCBLErrorWrongFormat , kCBLErrorCrypto , kCBLErrorInvalidQuery , kCBLErrorMissingIndex ,
  kCBLErrorInvalidQueryParam , kCBLErrorRemoteError , kCBLErrorDatabaseTooOld , kCBLErrorDatabaseTooNew ,
  kCBLErrorBadDocID , kCBLErrorCantUpgradeDatabase
}
enum  CBLNetworkErrorCode : int32_t {
  kCBLNetErrDNSFailure = 1 , kCBLNetErrUnknownHost , kCBLNetErrTimeout , kCBLNetErrInvalidURL ,
  kCBLNetErrTooManyRedirects , kCBLNetErrTLSHandshakeFailed , kCBLNetErrTLSCertExpired , kCBLNetErrTLSCertUntrusted ,
  kCBLNetErrTLSClientCertRequired , kCBLNetErrTLSClientCertRejected , kCBLNetErrTLSCertUnknownRoot , kCBLNetErrInvalidRedirect ,
  kCBLNetErrUnknown , kCBLNetErrTLSCertRevoked , kCBLNetErrTLSCertNameMismatch
}

Functions

FLSliceResult CBLError_Message (const CBLError *_cbl_nullable outError)
 Returns a message describing an error.
CBLTimestamp CBL_Now (void)
 Returns the current time, in milliseconds since 1/1/1970.
CBLRefCountedCBL_Retain (CBLRefCounted *_cbl_nullable)
 Increments an object's reference-count.
void CBL_Release (CBLRefCounted *_cbl_nullable)
 Decrements an object's reference-count, freeing the object if the count hits zero.
unsigned CBL_InstanceCount (void)
 Returns the total number of Couchbase Lite objects.
void CBL_DumpInstances (void)
 Logs the class and address of each Couchbase Lite object.
void CBLListener_Remove (CBLListenerToken *_cbl_nullable)
 Removes a listener callback, given the token that was returned when it was added.