Zack Williams | e940c7a | 2019-08-21 14:25:39 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2018 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 envconfig contains grpc settings configured by environment variables. |
| 20 | package envconfig |
| 21 | |
| 22 | import ( |
| 23 | "os" |
| 24 | "strings" |
| 25 | ) |
| 26 | |
| 27 | const ( |
| 28 | prefix = "GRPC_GO_" |
| 29 | retryStr = prefix + "RETRY" |
| 30 | requireHandshakeStr = prefix + "REQUIRE_HANDSHAKE" |
| 31 | ) |
| 32 | |
| 33 | // RequireHandshakeSetting describes the settings for handshaking. |
| 34 | type RequireHandshakeSetting int |
| 35 | |
| 36 | const ( |
| 37 | // RequireHandshakeOn indicates to wait for handshake before considering a |
| 38 | // connection ready/successful. |
| 39 | RequireHandshakeOn RequireHandshakeSetting = iota |
| 40 | // RequireHandshakeOff indicates to not wait for handshake before |
| 41 | // considering a connection ready/successful. |
| 42 | RequireHandshakeOff |
| 43 | ) |
| 44 | |
| 45 | var ( |
| 46 | // Retry is set if retry is explicitly enabled via "GRPC_GO_RETRY=on". |
| 47 | Retry = strings.EqualFold(os.Getenv(retryStr), "on") |
| 48 | // RequireHandshake is set based upon the GRPC_GO_REQUIRE_HANDSHAKE |
| 49 | // environment variable. |
| 50 | // |
| 51 | // Will be removed after the 1.18 release. |
| 52 | RequireHandshake = RequireHandshakeOn |
| 53 | ) |
| 54 | |
| 55 | func init() { |
| 56 | switch strings.ToLower(os.Getenv(requireHandshakeStr)) { |
| 57 | case "on": |
| 58 | fallthrough |
| 59 | default: |
| 60 | RequireHandshake = RequireHandshakeOn |
| 61 | case "off": |
| 62 | RequireHandshake = RequireHandshakeOff |
| 63 | } |
| 64 | } |