blob: 35e7a20a04baa42301bc4cad4f0630487d23bb52 [file] [log] [blame]
divyadesai19009132020-03-04 12:58:08 +00001/*
2 *
3 * Copyright 2019 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 serviceconfig defines types and methods for operating on gRPC
20// service configs.
21//
balaji.nagarajan8a2a7ee2026-06-19 22:31:13 +053022// # Experimental
23//
24// Notice: This package is EXPERIMENTAL and may be changed or removed in a
25// later release.
divyadesai19009132020-03-04 12:58:08 +000026package serviceconfig
27
divyadesai19009132020-03-04 12:58:08 +000028// Config represents an opaque data structure holding a service config.
29type Config interface {
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000030 isServiceConfig()
divyadesai19009132020-03-04 12:58:08 +000031}
32
33// LoadBalancingConfig represents an opaque data structure holding a load
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000034// balancing config.
divyadesai19009132020-03-04 12:58:08 +000035type LoadBalancingConfig interface {
36 isLoadBalancingConfig()
37}
38
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000039// ParseResult contains a service config or an error. Exactly one must be
40// non-nil.
41type ParseResult struct {
42 Config Config
43 Err error
divyadesai19009132020-03-04 12:58:08 +000044}