package
3.0.0-rc.3+incompatible
Repository: https://github.com/vitessio/vitess.git
Documentation: pkg.go.dev
# Functions
AddStatusFuncs merges the provided functions into the set of functions used to render /debug/status.
AddStatusPart adds a new section to status.
AddStatusSection registers a function that generates extra information for /debug/status.
CheckServiceMap returns if we should register a RPC service (and also logs how to enable / disable it).
Close runs any registered exit hooks in parallel.
FakeAuthStreamInterceptor fake interceptor to test plugin.
FakeAuthUnaryInterceptor fake interceptor to test plugin.
FireRunHooks fires the hooks registered by OnHook.
GetAuthenticator returns an AuthPlugin by name, or log.Fatalf.
GRPCCheckServiceMap returns if we should register a gRPC service (and also logs how to enable / disable it).
HandlePanic should be called using 'defer' in the RPC code that executes the command.
Init is the first phase of the server startup.
InitServiceMap will set the default value for a protocol/name to be served.
OnClose registers f to be run at the end of the app lifecycle.
OnRun registers f to be run right at the beginning of Run.
OnTerm registers a function to be run when the process receives a SIGTERM.
OnTermSync registers a function to be run when the process receives SIGTERM.
ParseFlags initializes flags and handles the common case when no positional arguments are expected.
ParseFlagsWithArgs initializes flags and returns the positional arguments.
RegisterAuthPlugin registers an implementation of AuthServer.
RegisterDefaultFlags registers the default flags for listening to a given port for standard connections.
RegisterDefaultSocketFileFlags registers the default flags for listening to a socket.
Run starts listening for RPC and HTTP requests, and blocks until it the process gets a signal.
RunDefault calls Run() with the parameters from the flags.
StatusURLPath returns the path to the status page.
WrapServerStream returns a ServerStream that has the ability to overwrite context.
# Constants
JQueryIncludes is the include to use to be able to use jquery and jquery-ui.
# Variables
AppVersion is the struct to store build info.
GRPCAuth which auth plugin to use (at the moment now only static is supported).
GRPCCA is the CA to use if TLS is enabled.
GRPCCert is the cert to use if TLS is enabled.
GRPCInitialConnWindowSize ServerOption that sets window size for a connection.
GRPCInitialWindowSize ServerOption that sets window size for stream.
EnforcementPolicy MinTime that sets the keepalive enforcement policy on the server.
GRPCKey is the key to use if TLS is enabled.
GRPCMaxConnectionAge is the maximum age of a client connection, before GoAway is sent.
GRPCMaxConnectionAgeGrace is an additional grace period after GRPCMaxConnectionAge, after which connections are forcibly closed.
GRPCPort is the port to listen on for gRPC.
GRPCServer is the global server to serve gRPC.
ListeningURL is filled in when calling Run, contains the server URL.
Port is part of the flags used when calling RegisterDefaultFlags.
SocketFile has the flag used when calling RegisterDefaultSocketFileFlags.
Version registers the command line flag to expose build info.
# Structs
StaticAuthConfigEntry is the container for server side credentials.
StaticAuthPlugin implements static username/password authentication for grpc.
WrappedServerStream is based on the service stream wrapper from: https://github.com/grpc-ecosystem/go-grpc-middleware.
# Interfaces
Authenticator provides an interface to implement auth in Vitess in grpc server.