interface ScopeInterface

Hierarchy

interface \OpenTelemetry\Context\ScopeInterface

Expanded class hierarchy of ScopeInterface

All classes that implement ScopeInterface

4 files declare their use of ScopeInterface

Baggage.php in vendor/open-telemetry/api/Baggage/Baggage.php
Configurator.php in vendor/open-telemetry/api/Instrumentation/Configurator.php
SdkBuilder.php in vendor/open-telemetry/sdk/SdkBuilder.php
Span.php in vendor/open-telemetry/api/Trace/Span.php

File

vendor/open-telemetry/context/ScopeInterface.php, line 9

Namespace

OpenTelemetry\Context

View source

interface ScopeInterface {
    
    /** The associated context was already detached. */
    public const DETACHED = 1 << (PHP_INT_SIZE << 3) - 1;
    
    /** The associated context is not in the active execution context. */
    public const INACTIVE = 1 << (PHP_INT_SIZE << 3) - 2;
    
    /** The associated context is not the active context. */
    public const MISMATCH = 1 << (PHP_INT_SIZE << 3) - 3;
    
    /**
     * Detaches the context associated with this scope and restores the
     * previously associated context.
     *
     * @return int zero indicating an expected call, or a non-zero value
     *         indicating that the call was unexpected
     *
     * @see self::DETACHED
     * @see self::INACTIVE
     * @see self::MISMATCH
     *
     * @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#detach-context
     */
    public function detach() : int;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
ScopeInterface::detach	public	function	Detaches the context associated with this scope and restores the previously associated context.	2
ScopeInterface::DETACHED	public	constant	The associated context was already detached.
ScopeInterface::INACTIVE	public	constant	The associated context is not in the active execution context.
ScopeInterface::MISMATCH	public	constant	The associated context is not the active context.