blob: 17a3fb9a25c56f282b15ec554d0ea995b1efa9d7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?php
declare(strict_types=1);
namespace OpenTelemetry\Context;
/**
* Immutable execution scoped propagation mechanism.
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#context
*/
interface ContextInterface
{
/**
* Creates a new context key.
*
* @param non-empty-string $key name of the key
* @return ContextKeyInterface created key
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#create-a-key
*/
public static function createKey(string $key): ContextKeyInterface;
/**
* Returns the current context.
*
* @return ContextInterface current context
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#get-current-context
*/
public static function getCurrent(): ContextInterface;
/**
* Attaches this context as active context.
*
* The returned scope has to be {@link ScopeInterface::detach()}ed. In most
* cases this should be done using a `try-finally` statement:
* ```php
* $scope = $context->activate();
* try {
* // ...
* } finally {
* $scope->detach();
* }
* ```
*
* @return ScopeInterface scope to detach the context and restore the previous
* context
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#attach-context
*/
public function activate(): ScopeInterface;
/**
* Returns a context with the given key set to the given value.
*
* @template T
* @param ContextKeyInterface<T> $key key to set
* @param T|null $value value to set
* @return ContextInterface a context with the given key set to `$value`
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#set-value
*/
public function with(ContextKeyInterface $key, $value): ContextInterface;
/**
* Returns a context with the given value set.
*
* @param ImplicitContextKeyedInterface $value value to set
* @return ContextInterface a context with the given `$value`
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#set-value
*/
public function withContextValue(ImplicitContextKeyedInterface $value): ContextInterface;
/**
* Returns the value assigned to the given key.
*
* @template T
* @param ContextKeyInterface<T> $key key to get
* @return T|null value assigned to `$key`, or null if no such value exists
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/context/README.md#get-value
*/
public function get(ContextKeyInterface $key);
}
|
