CBLLogSinks.h

Go to the documentation of this file.

//
// CBLLogSink.h
//
// Copyright © 2024 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, CBLLogLevel) {
    kCBLLogDebug,               
    kCBLLogVerbose,             
    kCBLLogInfo,                
    kCBLLogWarning,             
    kCBLLogError,               
    kCBLLogNone                 
};
 
typedef CBL_ENUM(uint8_t, CBLLogDomain) {
    kCBLLogDomainDatabase,      
    kCBLLogDomainQuery,         
    kCBLLogDomainReplicator,    
    kCBLLogDomainNetwork,       
    kCBLLogDomainListener       
};
 
typedef CBL_OPTIONS(uint16_t, CBLLogDomainMask) {
    kCBLLogDomainMaskDatabase   = 1 << kCBLLogDomainDatabase,
    kCBLLogDomainMaskQuery      = 1 << kCBLLogDomainQuery,
    kCBLLogDomainMaskReplicator = 1 << kCBLLogDomainReplicator,
    kCBLLogDomainMaskNetwork    = 1 << kCBLLogDomainNetwork,
    kCBLLogDomainMaskListener   = 1 << kCBLLogDomainListener,
    kCBLLogDomainMaskAll        = 0xFF
};
 
typedef void (*CBLLogSinkCallback)(CBLLogDomain domain, CBLLogLevel level, FLString message);
 
typedef struct {
    CBLLogLevel level;                          
    CBLLogDomainMask domains;                   
} CBLConsoleLogSink;
 
typedef struct {
    CBLLogLevel level;                          
    CBLLogSinkCallback _cbl_nullable callback;  
    CBLLogDomainMask domains;                   
} CBLCustomLogSink;
 
typedef struct {
    CBLLogLevel level;                          
    FLString directory;                         
    
    uint32_t maxKeptFiles;
    
    size_t maxSize;
    
    bool usePlaintext;
} CBLFileLogSink;
 
void CBLLogSinks_SetConsole(CBLConsoleLogSink sink) CBLAPI;
 
CBLConsoleLogSink CBLLogSinks_Console(void) CBLAPI;
 
void CBLLogSinks_SetCustom(CBLCustomLogSink sink) CBLAPI;
 
CBLCustomLogSink CBLLogSinks_CustomSink(void) CBLAPI;
 
void CBLLogSinks_SetFile(CBLFileLogSink sink) CBLAPI;
 
CBLFileLogSink CBLLogSinks_File(void) CBLAPI;
 
CBL_CAPI_END