VictoriaMetrics/vendor/google.golang.org/grpc/internal/internal.go

227 lines
10 KiB
Go
Raw Normal View History

/*
* Copyright 2016 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
// Package internal contains gRPC-internal code, to avoid polluting
// the godoc of the top-level grpc package. It must not import any grpc
// symbols to avoid circular dependencies.
package internal
import (
"context"
"time"
"google.golang.org/grpc/connectivity"
2020-06-25 22:40:43 +02:00
"google.golang.org/grpc/serviceconfig"
)
var (
// WithHealthCheckFunc is set by dialoptions.go
2023-09-07 12:34:14 +02:00
WithHealthCheckFunc any // func (HealthChecker) DialOption
// HealthCheckFunc is used to provide client-side LB channel health checking
HealthCheckFunc HealthChecker
// BalancerUnregister is exported by package balancer to unregister a balancer.
BalancerUnregister func(name string)
// KeepaliveMinPingTime is the minimum ping interval. This must be 10s by
// default, but tests may wish to set it lower for convenience.
KeepaliveMinPingTime = 10 * time.Second
2023-09-07 12:34:14 +02:00
// KeepaliveMinServerPingTime is the minimum ping interval for servers.
// This must be 1s by default, but tests may wish to set it lower for
// convenience.
KeepaliveMinServerPingTime = time.Second
2022-03-16 12:55:03 +01:00
// ParseServiceConfig parses a JSON representation of the service config.
2023-09-07 12:34:14 +02:00
ParseServiceConfig any // func(string) *serviceconfig.ParseResult
2020-06-25 22:40:43 +02:00
// EqualServiceConfigForTesting is for testing service config generation and
2022-03-16 12:55:03 +01:00
// parsing. Both a and b should be returned by ParseServiceConfig.
2020-06-25 22:40:43 +02:00
// This function compares the config without rawJSON stripped, in case the
// there's difference in white space.
EqualServiceConfigForTesting func(a, b serviceconfig.Config) bool
2020-10-16 14:06:20 +02:00
// GetCertificateProviderBuilder returns the registered builder for the
// given name. This is set by package certprovider for use from xDS
// bootstrap code while parsing certificate provider configs in the
// bootstrap file.
2023-09-07 12:34:14 +02:00
GetCertificateProviderBuilder any // func(string) certprovider.Builder
2020-12-03 19:16:30 +01:00
// GetXDSHandshakeInfoForTesting returns a pointer to the xds.HandshakeInfo
// stored in the passed in attributes. This is set by
// credentials/xds/xds.go.
2024-01-26 22:56:37 +01:00
GetXDSHandshakeInfoForTesting any // func (*attributes.Attributes) *unsafe.Pointer
2021-02-01 18:39:00 +01:00
// GetServerCredentials returns the transport credentials configured on a
// gRPC server. An xDS-enabled server needs to know what type of credentials
// is configured on the underlying gRPC server. This is set by server.go.
2023-09-07 12:34:14 +02:00
GetServerCredentials any // func (*grpc.Server) credentials.TransportCredentials
2023-03-25 02:08:06 +01:00
// CanonicalString returns the canonical string of the code defined here:
// https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
CanonicalString any // func (codes.Code) string
2023-12-12 23:35:31 +01:00
// IsRegisteredMethod returns whether the passed in method is registered as
// a method on the server.
IsRegisteredMethod any // func(*grpc.Server, string) bool
// ServerFromContext returns the server from the context.
ServerFromContext any // func(context.Context) *grpc.Server
2022-10-18 09:56:38 +02:00
// AddGlobalServerOptions adds an array of ServerOption that will be
2022-07-13 15:43:46 +02:00
// effective globally for newly created servers. The priority will be: 1.
// user-provided; 2. this method; 3. default values.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
AddGlobalServerOptions any // func(opt ...ServerOption)
2022-10-18 09:56:38 +02:00
// ClearGlobalServerOptions clears the array of extra ServerOption. This
2022-07-13 15:43:46 +02:00
// method is useful in testing and benchmarking.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2022-10-18 09:56:38 +02:00
ClearGlobalServerOptions func()
// AddGlobalDialOptions adds an array of DialOption that will be effective
2022-07-13 15:43:46 +02:00
// globally for newly created client channels. The priority will be: 1.
// user-provided; 2. this method; 3. default values.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
AddGlobalDialOptions any // func(opt ...DialOption)
2023-03-25 02:08:06 +01:00
// DisableGlobalDialOptions returns a DialOption that prevents the
// ClientConn from applying the global DialOptions (set via
// AddGlobalDialOptions).
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
DisableGlobalDialOptions any // func() grpc.DialOption
2022-10-18 09:56:38 +02:00
// ClearGlobalDialOptions clears the array of extra DialOption. This
2022-07-13 15:43:46 +02:00
// method is useful in testing and benchmarking.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2022-10-18 09:56:38 +02:00
ClearGlobalDialOptions func()
2023-02-08 17:55:14 +01:00
// JoinDialOptions combines the dial options passed as arguments into a
// single dial option.
2023-09-07 12:34:14 +02:00
JoinDialOptions any // func(...grpc.DialOption) grpc.DialOption
2022-10-07 00:01:21 +02:00
// JoinServerOptions combines the server options passed as arguments into a
// single server option.
2023-09-07 12:34:14 +02:00
JoinServerOptions any // func(...grpc.ServerOption) grpc.ServerOption
2022-07-13 15:43:46 +02:00
2022-10-18 09:56:38 +02:00
// WithBinaryLogger returns a DialOption that specifies the binary logger
// for a ClientConn.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
WithBinaryLogger any // func(binarylog.Logger) grpc.DialOption
2022-10-18 09:56:38 +02:00
// BinaryLogger returns a ServerOption that can set the binary logger for a
// server.
2023-07-07 09:04:32 +02:00
//
// This is used in the 1.0 release of gcp/observability, and thus must not be
// deleted or changed.
2023-09-07 12:34:14 +02:00
BinaryLogger any // func(binarylog.Logger) grpc.ServerOption
// SubscribeToConnectivityStateChanges adds a grpcsync.Subscriber to a provided grpc.ClientConn
SubscribeToConnectivityStateChanges any // func(*grpc.ClientConn, grpcsync.Subscriber)
2022-10-18 09:56:38 +02:00
2022-07-13 15:43:46 +02:00
// NewXDSResolverWithConfigForTesting creates a new xds resolver builder using
// the provided xds bootstrap config instead of the global configuration from
// the supported environment variables. The resolver.Builder is meant to be
// used in conjunction with the grpc.WithResolvers DialOption.
//
// Testing Only
//
// This function should ONLY be used for testing and may not work with some
// other features, including the CSDS service.
2023-09-07 12:34:14 +02:00
NewXDSResolverWithConfigForTesting any // func([]byte) (resolver.Builder, error)
2022-07-13 15:43:46 +02:00
// RegisterRLSClusterSpecifierPluginForTesting registers the RLS Cluster
// Specifier Plugin for testing purposes, regardless of the XDSRLS environment
// variable.
//
// TODO: Remove this function once the RLS env var is removed.
RegisterRLSClusterSpecifierPluginForTesting func()
// UnregisterRLSClusterSpecifierPluginForTesting unregisters the RLS Cluster
// Specifier Plugin for testing purposes. This is needed because there is no way
// to unregister the RLS Cluster Specifier Plugin after registering it solely
// for testing purposes using RegisterRLSClusterSpecifierPluginForTesting().
//
// TODO: Remove this function once the RLS env var is removed.
UnregisterRLSClusterSpecifierPluginForTesting func()
// RegisterRBACHTTPFilterForTesting registers the RBAC HTTP Filter for testing
// purposes, regardless of the RBAC environment variable.
//
// TODO: Remove this function once the RBAC env var is removed.
RegisterRBACHTTPFilterForTesting func()
// UnregisterRBACHTTPFilterForTesting unregisters the RBAC HTTP Filter for
// testing purposes. This is needed because there is no way to unregister the
// HTTP Filter after registering it solely for testing purposes using
// RegisterRBACHTTPFilterForTesting().
//
// TODO: Remove this function once the RBAC env var is removed.
UnregisterRBACHTTPFilterForTesting func()
2023-03-25 02:08:06 +01:00
// ORCAAllowAnyMinReportingInterval is for examples/orca use ONLY.
2023-09-07 12:34:14 +02:00
ORCAAllowAnyMinReportingInterval any // func(so *orca.ServiceOptions)
// GRPCResolverSchemeExtraMetadata determines when gRPC will add extra
// metadata to RPCs.
GRPCResolverSchemeExtraMetadata string = "xds"
2023-10-31 20:19:51 +01:00
// EnterIdleModeForTesting gets the ClientConn to enter IDLE mode.
2023-12-12 23:35:31 +01:00
EnterIdleModeForTesting any // func(*grpc.ClientConn)
2023-10-31 20:19:51 +01:00
// ExitIdleModeForTesting gets the ClientConn to exit IDLE mode.
ExitIdleModeForTesting any // func(*grpc.ClientConn) error
2023-12-12 23:35:31 +01:00
ChannelzTurnOffForTesting func()
2024-01-26 22:56:37 +01:00
// TriggerXDSResourceNameNotFoundForTesting triggers the resource-not-found
// error for a given resource type and name. This is usually triggered when
// the associated watch timer fires. For testing purposes, having this
// function makes events more predictable than relying on timer events.
TriggerXDSResourceNameNotFoundForTesting any // func(func(xdsresource.Type, string), string, string) error
// TriggerXDSResourceNotFoundClient invokes the testing xDS Client singleton
// to invoke resource not found for a resource type name and resource name.
TriggerXDSResourceNameNotFoundClient any // func(string, string) error
// FromOutgoingContextRaw returns the un-merged, intermediary contents of metadata.rawMD.
FromOutgoingContextRaw any // func(context.Context) (metadata.MD, [][]string, bool)
)
// HealthChecker defines the signature of the client-side LB channel health checking function.
//
// The implementation is expected to create a health checking RPC stream by
// calling newStream(), watch for the health status of serviceName, and report
// it's health back by calling setConnectivityState().
//
// The health checking protocol is defined at:
// https://github.com/grpc/grpc/blob/master/doc/health-checking.md
2023-09-07 12:34:14 +02:00
type HealthChecker func(ctx context.Context, newStream func(string) (any, error), setConnectivityState func(connectivity.State, error), serviceName string) error
const (
// CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
CredsBundleModeFallback = "fallback"
// CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
// mode.
CredsBundleModeBalancer = "balancer"
// CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
// that supports backend returned by grpclb balancer.
CredsBundleModeBackendFromBalancer = "backend-from-balancer"
)
2022-04-26 14:24:23 +02:00
// RLSLoadBalancingPolicyName is the name of the RLS LB policy.
//
// It currently has an experimental suffix which would be removed once
// end-to-end testing of the policy is completed.
const RLSLoadBalancingPolicyName = "rls_experimental"