package resolver

Import Path
	google.golang.org/grpc/internal/resolver (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	   #d config_selector.go
		Package resolver provides internal resolver-related functionality.
Package-Level Type Names (total 8, in which 7 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ClientInterceptor (interface)
		ClientInterceptor is an interceptor for gRPC client streams.

		Methods (only one, which is exported)
			( ClientInterceptor) NewStream(ctx context.Context, ri RPCInfo, done func(), newStream func(ctx context.Context, done func()) (ClientStream, error)) (ClientStream, error)
				NewStream produces a ClientStream for an RPC which may optionally use
				the provided function to produce a stream for delegation.  Note:
				RPCInfo.Context should not be used (will be nil).

				done is invoked when the RPC is finished using its connection, or could
				not be assigned a connection.  RPC operations may still occur on
				ClientStream after done is called, since the interceptor is invoked by
				application-layer operations.  done must never be nil when called.


	 type ClientStream (interface)
		ClientStream is the same as grpc.ClientStream, but defined here for circular
		dependency reasons.

		Methods (total 6, all are exported)
			( ClientStream) CloseSend() error
				CloseSend closes the send direction of the stream. It closes the stream
				when non-nil error is met. It is also not safe to call CloseSend
				concurrently with SendMsg.

			( ClientStream) Context() context.Context
				Context returns the context for this stream.

				It should not be called until after Header or RecvMsg has returned. Once
				called, subsequent client-side retries are disabled.

			( ClientStream) Header() (metadata.MD, error)
				Header returns the header metadata received from the server if there
				is any. It blocks if the metadata is not ready to read.

			( ClientStream) RecvMsg(m interface{}) error
				RecvMsg blocks until it receives a message into m or the stream is
				done. It returns io.EOF when the stream completes successfully. On
				any other error, the stream is aborted and the error contains the RPC
				status.

				It is safe to have a goroutine calling SendMsg and another goroutine
				calling RecvMsg on the same stream at the same time, but it is not
				safe to call RecvMsg on the same stream in different goroutines.

			( ClientStream) SendMsg(m interface{}) error
				SendMsg is generally called by generated code. On error, SendMsg aborts
				the stream. If the error was generated by the client, the status is
				returned directly; otherwise, io.EOF is returned and the status of
				the stream may be discovered using RecvMsg.

				SendMsg blocks until:
				  - There is sufficient flow control to schedule m with the transport, or
				  - The stream is done, or
				  - The stream breaks.

				SendMsg does not wait until the message is received by the server. An
				untimely stream closure may result in lost messages. To ensure delivery,
				users should ensure the RPC completed successfully using RecvMsg.

				It is safe to have a goroutine calling SendMsg and another goroutine
				calling RecvMsg on the same stream at the same time, but it is not safe
				to call SendMsg on the same stream in different goroutines. It is also
				not safe to call CloseSend concurrently with SendMsg.

			( ClientStream) Trailer() metadata.MD
				Trailer returns the trailer metadata from the server, if there is any.
				It must only be called after stream.CloseAndRecv has returned, or
				stream.Recv has returned a non-nil error (including io.EOF).

		Implemented By (at least 3, in which 1 are exported)
			 google.golang.org/grpc.ClientStream (interface)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*google.golang.org/grpc.addrConnStream
			*google.golang.org/grpc.clientStream
		Implements (at least 2, both are exported)
			 ClientStream : google.golang.org/grpc.ClientStream
			 ClientStream : google.golang.org/grpc.Stream
		As Outputs Of (at least 2, in which 1 are exported)
			func ClientInterceptor.NewStream(ctx context.Context, ri RPCInfo, done func(), newStream func(ctx context.Context, done func()) (ClientStream, error)) (ClientStream, error)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.newClientStreamWithParams(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, mc serviceconfig.MethodConfig, onCommit, doneFunc func(), opts ...grpc.CallOption) (_ ClientStream, err error)

	 type ConfigSelector (interface)
		ConfigSelector controls what configuration to use for every RPC.

		Methods (only one, which is exported)
			( ConfigSelector) SelectConfig(RPCInfo) (*RPCConfig, error)
				Selects the configuration for the RPC, or terminates it using the error.
				This error will be converted by the gRPC library to a status error with
				code UNKNOWN if it is not returned as a status error.

		Implemented By (at least 2, in which 1 are exported)
			*SafeConfigSelector
			/* at least one unexported ... *//* at least one unexported: */
			*google.golang.org/grpc.defaultConfigSelector
		As Outputs Of (at least one exported)
			func GetConfigSelector(state resolver.State) ConfigSelector
		As Inputs Of (at least 3, in which 2 are exported)
			func SetConfigSelector(state resolver.State, cs ConfigSelector) resolver.State
			func (*SafeConfigSelector).UpdateConfigSelector(cs ConfigSelector)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.(*ClientConn).applyServiceConfigAndBalancer(sc *grpc.ServiceConfig, configSelector ConfigSelector, addrs []resolver.Address)

	 type RPCConfig (struct)
		RPCConfig describes the configuration to use for each RPC.

		Fields (total 4, all are exported)
			Context context.Context
				The context to use for the remainder of the RPC; can pass info to LB
				policy or affect timeout or metadata.

			Interceptor ClientInterceptor
			MethodConfig serviceconfig.MethodConfig
				// configuration to use for this RPC

			OnCommitted func()
				// Called when the RPC has been committed (retries no longer possible)

		As Outputs Of (at least 2, both are exported)
			func ConfigSelector.SelectConfig(RPCInfo) (*RPCConfig, error)
			func (*SafeConfigSelector).SelectConfig(r RPCInfo) (*RPCConfig, error)

	 type RPCInfo (struct)
		RPCInfo contains RPC information needed by a ConfigSelector.

		Fields (total 2, both are exported)
			Context context.Context
				Context is the user's context for the RPC and contains headers and
				application timeout.  It is passed for interception purposes and for
				efficiency reasons.  SelectConfig should not be blocking.

			Method string
				// i.e. "/Service/Method"

		As Inputs Of (at least 3, all are exported)
			func ClientInterceptor.NewStream(ctx context.Context, ri RPCInfo, done func(), newStream func(ctx context.Context, done func()) (ClientStream, error)) (ClientStream, error)
			func ConfigSelector.SelectConfig(RPCInfo) (*RPCConfig, error)
			func (*SafeConfigSelector).SelectConfig(r RPCInfo) (*RPCConfig, error)

	 type SafeConfigSelector (struct)
		SafeConfigSelector allows for safe switching of ConfigSelector
		implementations such that previous values are guaranteed to not be in use
		when UpdateConfigSelector returns.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			cs ConfigSelector
			mu sync.RWMutex
		Methods (total 2, both are exported)
			(*SafeConfigSelector) SelectConfig(r RPCInfo) (*RPCConfig, error)
				SelectConfig defers to the current ConfigSelector in scs.

			(*SafeConfigSelector) UpdateConfigSelector(cs ConfigSelector)
				UpdateConfigSelector swaps to the provided ConfigSelector and blocks until
				all uses of the previous ConfigSelector have completed.

		Implements (at least one exported)
			*SafeConfigSelector : ConfigSelector

	 type ServerInterceptor (interface)
		ServerInterceptor is an interceptor for incoming RPC's on gRPC server side.

		Methods (only one, which is exported)
			( ServerInterceptor) AllowRPC(ctx context.Context) error
				AllowRPC checks if an incoming RPC is allowed to proceed based on
				information about connection RPC was received on, and HTTP Headers. This
				information will be piped into context.
				// TODO: Make this a real interceptor for filters such as rate limiting.


	/* one unexported ... *//* one unexported: */
	 type csKeyType string (basic type)

		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			const csKey


Package-Level Functions (total 2, both are exported)

	 func GetConfigSelector(state resolver.State) ConfigSelector
		GetConfigSelector retrieves the config selector from state, if present, and
		returns it or nil if absent.

	 func SetConfigSelector(state resolver.State, cs ConfigSelector) resolver.State
		SetConfigSelector sets the config selector in state and returns the new
		state.


Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const csKey csKeyType = "grpc.internal.resolver.configSelector"

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)