CBLBase.h

Go to the documentation of this file.

//
// CBLBase.h
//
// Copyright (c) 2018 Couchbase, Inc All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
 
#pragma once
#ifdef CMAKE
#include "cbl_config.h"
#endif
 
#include "CBL_Edition.h"
#include "CBL_Compat.h"
#include "fleece/Fleece.h"
#include <stdbool.h>
#include <stdint.h>
 
CBL_CAPI_BEGIN
 
typedef CBL_ENUM(uint8_t, CBLErrorDomain) {
    kCBLDomain = 1,         
    kCBLPOSIXDomain,        
    kCBLSQLiteDomain,       
    kCBLFleeceDomain,       
    kCBLNetworkDomain,      
    kCBLWebSocketDomain,    
};
 
typedef CBL_ENUM(int32_t, CBLErrorCode) {
    kCBLErrorAssertionFailed = 1,    
    kCBLErrorUnimplemented,          
    kCBLErrorUnsupportedEncryption,  
    kCBLErrorBadRevisionID,          
    kCBLErrorCorruptRevisionData,    
    kCBLErrorNotOpen,                
    kCBLErrorNotFound,               
    kCBLErrorConflict,               
    kCBLErrorInvalidParameter,       
    kCBLErrorUnexpectedError, /*10*/ 
    kCBLErrorCantOpenFile,           
    kCBLErrorIOError,                
    kCBLErrorMemoryError,            
    kCBLErrorNotWriteable,           
    kCBLErrorCorruptData,            
    kCBLErrorBusy,                   
    kCBLErrorNotInTransaction,       
    kCBLErrorTransactionNotClosed,   
    kCBLErrorUnsupported,            
    kCBLErrorNotADatabaseFile,/*20*/ 
    kCBLErrorWrongFormat,            
    kCBLErrorCrypto,                 
    kCBLErrorInvalidQuery,           
    kCBLErrorMissingIndex,           
    kCBLErrorInvalidQueryParam,      
    kCBLErrorRemoteError,            
    kCBLErrorDatabaseTooOld,         
    kCBLErrorDatabaseTooNew,         
    kCBLErrorBadDocID,               
    kCBLErrorCantUpgradeDatabase,/*30*/ 
};
 
typedef CBL_ENUM(int32_t,  CBLNetworkErrorCode) {
    kCBLNetErrDNSFailure = 1,            
    kCBLNetErrUnknownHost,               
    kCBLNetErrTimeout,                   
    kCBLNetErrInvalidURL,                
    kCBLNetErrTooManyRedirects,          
    kCBLNetErrTLSHandshakeFailed,        
    kCBLNetErrTLSCertExpired,            
    kCBLNetErrTLSCertUntrusted,          
    kCBLNetErrTLSClientCertRequired,     
    kCBLNetErrTLSClientCertRejected,     
    kCBLNetErrTLSCertUnknownRoot,        
    kCBLNetErrInvalidRedirect,           
    kCBLNetErrUnknown,                   
    kCBLNetErrTLSCertRevoked,            
    kCBLNetErrTLSCertNameMismatch,       
};
 
 
typedef struct {
    CBLErrorDomain domain;         
    int            code;           
    unsigned       internal_info;  // do not use or modify
} CBLError;
 
FLSliceResult CBLError_Message(const CBLError* _cbl_nullable outError) CBLAPI;
 
typedef int64_t CBLTimestamp;
 
 
CBLTimestamp CBL_Now(void) CBLAPI;
 
typedef struct CBLRefCounted CBLRefCounted;
 
CBLRefCounted* CBL_Retain(CBLRefCounted* _cbl_nullable) CBLAPI;
 
void CBL_Release(CBLRefCounted* _cbl_nullable) CBLAPI;
 
unsigned CBL_InstanceCount(void) CBLAPI;
 
void CBL_DumpInstances(void) CBLAPI;
 
// Declares retain/release functions for TYPE. For internal use only.
#define CBL_REFCOUNTED(TYPE, NAME) \
    static inline const TYPE CBL##NAME##_Retain(const TYPE _cbl_nullable t) \
                                            {return (const TYPE)CBL_Retain((CBLRefCounted*)t);} \
    static inline void CBL##NAME##_Release(const TYPE _cbl_nullable t) {CBL_Release((CBLRefCounted*)t);}
 
typedef struct CBLDatabase   CBLDatabase;
typedef struct CBLScope CBLScope;
typedef struct CBLCollection    CBLCollection;
typedef struct CBLDocument   CBLDocument;
typedef struct CBLBlob      CBLBlob;
typedef struct CBLQuery      CBLQuery;
 
typedef struct CBLResultSet  CBLResultSet;
typedef struct CBLQueryIndex      CBLQueryIndex;
 
#ifdef COUCHBASE_ENTERPRISE
typedef struct CBLIndexUpdater      CBLIndexUpdater;
#endif
typedef struct CBLReplicator CBLReplicator;
#ifdef COUCHBASE_ENTERPRISE
 
typedef struct CBLEncryptable CBLEncryptable;
#endif
 
typedef struct CBLListenerToken CBLListenerToken;
 
void CBLListener_Remove(CBLListenerToken* _cbl_nullable) CBLAPI;
 
 
CBL_CAPI_END