LiteCore
Couchbase Lite cross-platform core implementation
|
Data Structures | |
struct | C4ExtraInfo |
Client-defined metadata that can be associated with some objects like C4Database. More... | |
Macros | |
#define | C4STR(STR) FLSTR(STR) |
#define | kC4SliceNull kFLSliceNull |
Typedefs | |
typedef FLSlice | C4Slice |
typedef FLHeapSlice | C4HeapSlice |
typedef FLSliceResult | C4SliceResult |
typedef C4Slice | C4String |
typedef C4HeapSlice | C4HeapString |
typedef C4SliceResult | C4StringResult |
typedef uint64_t | C4SequenceNumber |
A database sequence number, representing the order in which a revision was created. | |
typedef int64_t | C4Timestamp |
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.) A value of 0 represents "no expiration". | |
typedef struct C4BlobStore | C4BlobStore |
Opaque handle for an object that manages storage of blobs. | |
typedef struct C4Cert | C4Cert |
An X.509 certificate, or certificate signing request (CSR). | |
typedef struct C4Collection | C4Collection |
Opaque handle to a namespace of documents in an opened database. | |
typedef struct C4CollectionObserver | C4CollectionObserver |
A collection-observer reference. | |
typedef C4CollectionObserver | C4DatabaseObserver |
typedef struct C4Database | C4Database |
Opaque handle to an opened database. | |
typedef struct C4DocumentObserver | C4DocumentObserver |
A document-observer reference. | |
typedef struct C4DocEnumerator | C4DocEnumerator |
Opaque handle to a document enumerator. | |
typedef struct C4Index | C4Index |
Represents an existing index. | |
typedef struct C4IndexUpdater | C4IndexUpdater |
Describes a set of index values that need to be computed by the application. | |
typedef struct C4KeyPair | C4KeyPair |
An asymmetric key or key-pair (RSA, etc.) The private key may or may not be present. | |
typedef struct C4Listener | C4Listener |
A LiteCore network listener – supports the REST API, replication, or both. | |
typedef struct C4Query | C4Query |
Opaque handle to a compiled query. | |
typedef struct C4QueryObserver | C4QueryObserver |
A query-observer reference. | |
typedef struct C4ReadStream | C4ReadStream |
An open stream for reading data from a blob. | |
typedef struct C4Replicator | C4Replicator |
Opaque reference to a replicator. | |
typedef struct C4Socket | C4Socket |
Represents an open bidirectional stream of bytes or messages (typically a TCP socket.) | |
typedef struct C4WriteStream | C4WriteStream |
An open stream for writing data to a blob. | |
#define C4STR | ( | STR | ) | FLSTR(STR) |
#define kC4SliceNull kFLSliceNull |
typedef struct C4BlobStore C4BlobStore |
Opaque handle for an object that manages storage of blobs.
typedef struct C4Collection C4Collection |
Opaque handle to a namespace of documents in an opened database.
typedef struct C4CollectionObserver C4CollectionObserver |
A collection-observer reference.
typedef struct C4Database C4Database |
Opaque handle to an opened database.
typedef struct C4DocEnumerator C4DocEnumerator |
Opaque handle to a document enumerator.
typedef struct C4DocumentObserver C4DocumentObserver |
A document-observer reference.
typedef FLHeapSlice C4HeapSlice |
typedef C4HeapSlice C4HeapString |
typedef struct C4IndexUpdater C4IndexUpdater |
Describes a set of index values that need to be computed by the application.
An asymmetric key or key-pair (RSA, etc.) The private key may or may not be present.
typedef struct C4Listener C4Listener |
A LiteCore network listener – supports the REST API, replication, or both.
typedef struct C4QueryObserver C4QueryObserver |
A query-observer reference.
typedef struct C4ReadStream C4ReadStream |
An open stream for reading data from a blob.
typedef struct C4Replicator C4Replicator |
Opaque reference to a replicator.
typedef uint64_t C4SequenceNumber |
A database sequence number, representing the order in which a revision was created.
typedef FLSliceResult C4SliceResult |
Represents an open bidirectional stream of bytes or messages (typically a TCP socket.)
typedef C4SliceResult C4StringResult |
typedef int64_t C4Timestamp |
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.) A value of 0 represents "no expiration".
typedef struct C4WriteStream C4WriteStream |
An open stream for writing data to a blob.
CBL_CORE_API void c4_dumpInstances | ( | void | ) |
Logs information about object in memory.
Useful for debugging when c4_getObjectCount indicates there are leaks. (Note: In release builds this doesn't have much to say, because the instrumentation it needs is suppressed for performance purposes.)
CBL_CORE_API int c4_getObjectCount | ( | void | ) |
Returns the number of objects that have been created but not yet freed.
This can be used as a debugging/testing tool to detect leaks; for example, capture the value at the start of a test, then call again at the end and compare.
CBL_CORE_API void c4base_release | ( | void * | obj | ) |
CBL_CORE_API void * c4base_retain | ( | void * | obj | ) |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
CBL_CORE_API void c4dbobs_free | ( | C4CollectionObserver * | ) |
CBL_CORE_API void c4doc_release | ( | C4Document * | ) |
CBL_CORE_API C4Document * c4doc_retain | ( | C4Document * | ) |
CBL_CORE_API void c4docobs_free | ( | C4DocumentObserver * | ) |
CBL_CORE_API void c4enum_free | ( | C4DocEnumerator * | ) |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
CBL_CORE_API void c4listener_free | ( | C4Listener * | ) |
Closes and disposes a listener.
|
inlinestatic |
CBL_CORE_API void c4queryenum_release | ( | C4QueryEnumerator * | ) |
CBL_CORE_API C4QueryEnumerator * c4queryenum_retain | ( | C4QueryEnumerator * | ) |
CBL_CORE_API void c4queryobs_free | ( | C4QueryObserver * | ) |
CBL_CORE_API void c4raw_free | ( | C4RawDocument * | ) |
Frees the storage occupied by a raw document.
CBL_CORE_API void c4repl_free | ( | C4Replicator * | ) |
Frees a replicator reference.
Does not stop the replicator – if the replicator still has other internal references, it will keep going. If you need the replicator to stop, call c4repl_stop first.
|
inlinestatic |
CBL_CORE_API void c4socket_release | ( | C4Socket * | ) |
CBL_CORE_API C4Socket * c4socket_retain | ( | C4Socket * | ) |
CBL_CORE_API void c4stream_close | ( | C4ReadStream * | ) |
Closes a read-stream.
(A NULL parameter is allowed.)
CBL_CORE_API void c4stream_closeWriter | ( | C4WriteStream * | ) |
Closes a blob write-stream.
If c4stream_install was not already called (or was called but failed), the temporary file will be deleted without adding the blob to the store. (A NULL parameter is allowed, and is a no-op.)