const (
ContextKeyRequestMethod contextKey = iota
)
func EncodeKeyValue(key, val string) (string, string)
EncodeKeyValue sanitizes a key-value pair for use in gRPC metadata headers.
func Interceptor(
ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler,
) (resp interface{}, err error)
Interceptor is a grpc UnaryInterceptor that injects the method name into context so it can be consumed by Go kit gRPC middlewares. The Interceptor typically is added at creation time of the grpc-go server. Like this: `grpc.NewServer(grpc.UnaryInterceptor(kitgrpc.Interceptor))`
Client wraps a gRPC connection and provides a method that implements endpoint.Endpoint.
type Client struct {
// contains filtered or unexported fields
}
func NewClient(
cc *grpc.ClientConn,
serviceName string,
method string,
enc EncodeRequestFunc,
dec DecodeResponseFunc,
grpcReply interface{},
options ...ClientOption,
) *Client
NewClient constructs a usable Client for a single remote endpoint. Pass an zero-value protobuf message of the RPC response type as the grpcReply argument.
func (c Client) Endpoint() endpoint.Endpoint
Endpoint returns a usable endpoint that will invoke the gRPC specified by the client.
ClientFinalizerFunc can be used to perform work at the end of a client gRPC request, after the response is returned. The principal intended use is for error logging. Additional response parameters are provided in the context under keys with the ContextKeyResponse prefix. Note: err may be nil. There maybe also no additional response parameters depending on when an error occurs.
type ClientFinalizerFunc func(ctx context.Context, err error)
ClientOption sets an optional parameter for clients.
type ClientOption func(*Client)
func ClientAfter(after ...ClientResponseFunc) ClientOption
ClientAfter sets the ClientResponseFuncs that are applied to the incoming gRPC response prior to it being decoded. This is useful for obtaining response metadata and adding onto the context prior to decoding.
func ClientBefore(before ...ClientRequestFunc) ClientOption
ClientBefore sets the RequestFuncs that are applied to the outgoing gRPC request before it's invoked.
func ClientFinalizer(f ...ClientFinalizerFunc) ClientOption
ClientFinalizer is executed at the end of every gRPC request. By default, no finalizer is registered.
ClientRequestFunc may take information from context and use it to construct metadata headers to be transported to the server. ClientRequestFuncs are executed after creating the request but prior to sending the gRPC request to the server.
type ClientRequestFunc func(context.Context, *metadata.MD) context.Context
func SetRequestHeader(key, val string) ClientRequestFunc
SetRequestHeader returns a ClientRequestFunc that sets the specified metadata key-value pair.
ClientResponseFunc may take information from a gRPC metadata header and/or trailer and make the responses available for consumption. ClientResponseFuncs are only executed in clients, after a request has been made, but prior to it being decoded.
type ClientResponseFunc func(ctx context.Context, header metadata.MD, trailer metadata.MD) context.Context
DecodeRequestFunc extracts a user-domain request object from a gRPC request. It's designed to be used in gRPC servers, for server-side endpoints. One straightforward DecodeRequestFunc could be something that decodes from the gRPC request message to the concrete request type.
type DecodeRequestFunc func(context.Context, interface{}) (request interface{}, err error)
DecodeResponseFunc extracts a user-domain response object from a gRPC response object. It's designed to be used in gRPC clients, for client-side endpoints. One straightforward DecodeResponseFunc could be something that decodes from the gRPC response message to the concrete response type.
type DecodeResponseFunc func(context.Context, interface{}) (response interface{}, err error)
EncodeRequestFunc encodes the passed request object into the gRPC request object. It's designed to be used in gRPC clients, for client-side endpoints. One straightforward EncodeRequestFunc could something that encodes the object directly to the gRPC request message.
type EncodeRequestFunc func(context.Context, interface{}) (request interface{}, err error)
EncodeResponseFunc encodes the passed response object to the gRPC response message. It's designed to be used in gRPC servers, for server-side endpoints. One straightforward EncodeResponseFunc could be something that encodes the object directly to the gRPC response message.
type EncodeResponseFunc func(context.Context, interface{}) (response interface{}, err error)
Handler which should be called from the gRPC binding of the service implementation. The incoming request parameter, and returned response parameter, are both gRPC types, not user-domain.
type Handler interface {
ServeGRPC(ctx context.Context, request interface{}) (context.Context, interface{}, error)
}
Server wraps an endpoint and implements grpc.Handler.
type Server struct {
// contains filtered or unexported fields
}
func NewServer(
e endpoint.Endpoint,
dec DecodeRequestFunc,
enc EncodeResponseFunc,
options ...ServerOption,
) *Server
NewServer constructs a new server, which implements wraps the provided endpoint and implements the Handler interface. Consumers should write bindings that adapt the concrete gRPC methods from their compiled protobuf definitions to individual handlers. Request and response objects are from the caller business domain, not gRPC request and reply types.
func (s Server) ServeGRPC(ctx context.Context, req interface{}) (retctx context.Context, resp interface{}, err error)
ServeGRPC implements the Handler interface.
ServerFinalizerFunc can be used to perform work at the end of an gRPC request, after the response has been written to the client.
type ServerFinalizerFunc func(ctx context.Context, err error)
ServerOption sets an optional parameter for servers.
type ServerOption func(*Server)
func ServerAfter(after ...ServerResponseFunc) ServerOption
ServerAfter functions are executed on the gRPC response writer after the endpoint is invoked, but before anything is written to the client.
func ServerBefore(before ...ServerRequestFunc) ServerOption
ServerBefore functions are executed on the gRPC request object before the request is decoded.
func ServerErrorHandler(errorHandler transport.ErrorHandler) ServerOption
ServerErrorHandler is used to handle non-terminal errors. By default, non-terminal errors are ignored.
func ServerErrorLogger(logger log.Logger) ServerOption
ServerErrorLogger is used to log non-terminal errors. By default, no errors are logged. Deprecated: Use ServerErrorHandler instead.
func ServerFinalizer(f ...ServerFinalizerFunc) ServerOption
ServerFinalizer is executed at the end of every gRPC request. By default, no finalizer is registered.
ServerRequestFunc may take information from the received metadata header and use it to place items in the request scoped context. ServerRequestFuncs are executed prior to invoking the endpoint.
type ServerRequestFunc func(context.Context, metadata.MD) context.Context
ServerResponseFunc may take information from a request context and use it to manipulate the gRPC response metadata headers and trailers. ResponseFuncs are only executed in servers, after invoking the endpoint but prior to writing a response.
type ServerResponseFunc func(ctx context.Context, header *metadata.MD, trailer *metadata.MD) context.Context
func SetResponseHeader(key, val string) ServerResponseFunc
SetResponseHeader returns a ResponseFunc that sets the specified metadata key-value pair.
func SetResponseTrailer(key, val string) ServerResponseFunc
SetResponseTrailer returns a ResponseFunc that sets the specified metadata key-value pair.