| 1 | /**
|
| 2 | * Copyright 2018, OpenCensus Authors
|
| 3 | *
|
| 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
| 5 | * you may not use this file except in compliance with the License.
|
| 6 | * You may obtain a copy of the License at
|
| 7 | *
|
| 8 | * http://www.apache.org/licenses/LICENSE-2.0
|
| 9 | *
|
| 10 | * Unless required by applicable law or agreed to in writing, software
|
| 11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 13 | * See the License for the specific language governing permissions and
|
| 14 | * limitations under the License.
|
| 15 | */
|
| 16 | import { SpanContext } from '../model/types';
|
| 17 | /**
|
| 18 | * An transport and environment neutral API for getting request headers.
|
| 19 | */
|
| 20 | export interface HeaderGetter {
|
| 21 | getHeader(name: string): string | string[] | undefined;
|
| 22 | }
|
| 23 | /**
|
| 24 | * A transport and environment neutral API for setting headers.
|
| 25 | */
|
| 26 | export interface HeaderSetter {
|
| 27 | setHeader(name: string, value: string): void;
|
| 28 | }
|
| 29 | /**
|
| 30 | * Propagation interface
|
| 31 | */
|
| 32 | export interface Propagation {
|
| 33 | extract(getter: HeaderGetter): SpanContext | null;
|
| 34 | inject(setter: HeaderSetter, spanContext: SpanContext): void;
|
| 35 | generate(): SpanContext;
|
| 36 | }
|