• Home
• aws.smithy.kotlin
• telemetry-api-jvm
• 1.3.23
• source code
• Context.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.aws.smithy.kotlin.runtime.telemetry.context.Context.kt Maven / Gradle / Ivy

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.telemetry.context

/**
 * Context is an opaque propagation mechanism for telemetry providers to carry execution
 * scoped values across API boundaries.
 */
public interface Context {
    public companion object {
        /**
         * A no-op [Context]
         */
        public val None: Context = object : AbstractContext() { }
    }

    /**
     * Make this the currently active context
     *
     * @return handle to a [Scope] that MUST be disposed of (via [Scope.close]) when the current context
     * is considered no longer active (returning the current active context to whatever it was previously if set).
     */
    public fun makeCurrent(): Scope
}