Couchbase Lite C
Couchbase Lite C API
Loading...
Searching...
No Matches
CBLLog.h
Go to the documentation of this file.
1//
2// CBLLog.h
3//
4// Copyright © 2019 Couchbase. All rights reserved.
5//
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17//
18
19#pragma once
20#include "CBLBase.h"
21#include "CBLLogSinks.h"
22
24
29
44 CBLLogLevel level,
45 const char *format, ...) CBLAPI __printflike(3, 4);
46
54 CBLLogLevel level,
55 FLSlice message) CBLAPI;
56
59
62
67
72
77
82
86
90
92
95
117
121
125
127
129
#define CBLAPI
Definition CBL_Compat.h:105
#define _cbl_nullable
Definition CBL_Compat.h:92
#define CBL_CAPI_BEGIN
Definition CBL_Compat.h:107
#define CBL_CAPI_END
Definition CBL_Compat.h:108
#define __printflike(fmtarg, firstvararg)
Definition CBL_Compat.h:133
FLSlice FLString
Definition FLSlice.h:98
CBLLogDomain
Definition CBLLogSinks.h:43
CBLLogLevel
Definition CBLLogSinks.h:33
void(* CBLLogSinkCallback)(CBLLogDomain domain, CBLLogLevel level, FLString message)
A callback function for a custom log sink.
Definition CBLLogSinks.h:69
const CBLLogFileConfiguration *_cbl_nullable CBLLog_FileConfig(void)
Gets the current file logging configuration, or NULL if none is configured.
void CBLLog_SetCallbackLevel(CBLLogLevel)
Sets the detail level of logging.
CBLLogLevel CBLLog_CallbackLevel(void)
Gets the current log level for debug console logging.
void void CBL_LogMessage(CBLLogDomain domain, CBLLogLevel level, FLSlice message)
Writes a pre-formatted message to the log, exactly as given.
CBLLogCallback CBLLog_Callback(void)
Gets the current log callback.
bool CBLLog_SetFileConfig(CBLLogFileConfiguration, CBLError *_cbl_nullable outError)
Sets the file logging configuration, and begins logging to files.
CBLLogLevel CBLLog_ConsoleLevel(void)
Gets the current log level for debug console logging.
void CBLLog_SetCallback(CBLLogCallback _cbl_nullable callback)
Sets the callback for receiving log messages.
CBLLogSinkCallback CBLLogCallback
A logging callback that the application can register.
Definition CBLLog.h:61
void CBL_Log(CBLLogDomain domain, CBLLogLevel level, const char *format,...) __printflike(3
Formats and writes a message to the log, in the given domain at the given level.
void CBLLog_SetConsoleLevel(CBLLogLevel)
Sets the detail level of logging.
A struct holding information about an error.
Definition CBLBase.h:105
The properties for configuring logging to files.
Definition CBLLog.h:100
uint32_t maxRotateCount
Max number of older log files to keep (in addition to current one.) The default is kCBLDefaultLogFile...
Definition CBLLog.h:107
size_t maxSize
The size in bytes at which a file will be rotated out (best effort).
Definition CBLLog.h:111
bool usePlaintext
Whether or not to log in plaintext (as opposed to binary.) Plaintext logging is slower and bigger.
Definition CBLLog.h:115
CBLLogLevel level
The minimum level of message to write (Required).
Definition CBLLog.h:101
FLString directory
The directory where log files will be created (Required).
Definition CBLLog.h:103
A simple reference to a block of memory.
Definition FLSlice.h:45