commonMain.kotbase.Logger.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of couchbase-lite Show documentation

Couchbase Lite Community Edition for Kotlin Multiplatform

There is a newer version: 3.1.3-1.1.0

/*
 * Copyright 2022-2023 Jeff Lockhart
 *
 * 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.
 */
package kotbase

/**
 * The logging interface for Couchbase Lite.  If an application wants
 * to receive log messages to an arbitrary endpoint, then it can by
 * implementing this interface.
 *
 * !!! There is, currently, no way to tell when the log level changes
 * for a custom logger.  Setting a more verbose log level will not
 * have any effect until the logger is polled for its level.
 */
public interface Logger {

    /**
     * Gets the level that will be logged via this logger.
     *
     * @return The maximum level to log
     */
    public val level: LogLevel

    /**
     * Performs the actual logging logic
     *
     * @param level   The level of the message to log
     * @param domain  The domain of the message to log
     * @param message The content of the message to log
     */
    public fun log(level: LogLevel, domain: LogDomain, message: String)
}