CBLLog.h

Go to the documentation of this file.

//
// CBLLog.h
//
// Copyright © 2019 Couchbase. 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
#include "CBLBase.h"
 
CBL_CAPI_BEGIN
 
 
typedef CBL_ENUM(uint8_t, CBLLogDomain) {
    kCBLLogDomainDatabase,
    kCBLLogDomainQuery,
    kCBLLogDomainReplicator,
    kCBLLogDomainNetwork
};
 
typedef CBL_ENUM(uint8_t, CBLLogLevel) {
    kCBLLogDebug,        
    kCBLLogVerbose,      
    kCBLLogInfo,         
    kCBLLogWarning,      
    kCBLLogError,        
    kCBLLogNone          
};
 
 
void CBL_Log(CBLLogDomain domain,
             CBLLogLevel level,
             const char *format, ...) CBLAPI __printflike(3, 4);
 
void CBL_LogMessage(CBLLogDomain domain,
                    CBLLogLevel level,
                    FLSlice message) CBLAPI;
 
 
 
typedef void (*CBLLogCallback)(CBLLogDomain domain,
                               CBLLogLevel level,
                               FLString message);
 
CBLLogLevel CBLLog_ConsoleLevel(void) CBLAPI;
 
void CBLLog_SetConsoleLevel(CBLLogLevel) CBLAPI;
 
CBLLogLevel CBLLog_CallbackLevel(void) CBLAPI;
 
void CBLLog_SetCallbackLevel(CBLLogLevel) CBLAPI;
 
CBLLogCallback CBLLog_Callback(void) CBLAPI;
 
void CBLLog_SetCallback(CBLLogCallback _cbl_nullable callback) CBLAPI;
 
typedef struct {
    CBLLogLevel level;       
    
    FLString directory;      
    
    uint32_t maxRotateCount;
    
    size_t maxSize;
    
    bool usePlaintext;
} CBLLogFileConfiguration;
 
const CBLLogFileConfiguration* _cbl_nullable CBLLog_FileConfig(void) CBLAPI;
 
bool CBLLog_SetFileConfig(CBLLogFileConfiguration, CBLError* _cbl_nullable outError) CBLAPI;
 
CBL_CAPI_END