blob: 302262613a029886fc6e52b3f96b9af93d3630d8 [file] [log] [blame]
khenaidoo5fc5cea2021-08-11 17:39:16 -04001/*
2 *
3 * Copyright 2020 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19// Package metadata contains functions to set and get metadata from addresses.
20//
21// This package is experimental.
22package metadata
23
24import (
25 "google.golang.org/grpc/metadata"
26 "google.golang.org/grpc/resolver"
27)
28
29type mdKeyType string
30
31const mdKey = mdKeyType("grpc.internal.address.metadata")
32
33// Get returns the metadata of addr.
34func Get(addr resolver.Address) metadata.MD {
35 attrs := addr.Attributes
36 if attrs == nil {
37 return nil
38 }
39 md, _ := attrs.Value(mdKey).(metadata.MD)
40 return md
41}
42
43// Set sets (overrides) the metadata in addr.
44//
45// When a SubConn is created with this address, the RPCs sent on it will all
46// have this metadata.
47func Set(addr resolver.Address, md metadata.MD) resolver.Address {
48 addr.Attributes = addr.Attributes.WithValues(mdKey, md)
49 return addr
50}