grpc

Documentation

Overview

Package grpc provides a grpc server

Index

• func AuthTLS(t *tls.Config) server.Option
• func Code(err error) codes.Code
• func Codec(contentType string, c grpc.Codec) server.Option
• func ErrorDesc(err error) string
• func Errorf(c codes.Code, format string, a ...interface{}) error
• func NewServer(opts ...server.Option) server.Server
• func TransportConfig(sc *grpcTransport.ServerConfig) server.Option
• type Debug

Functions

func AuthTLS

func AuthTLS(t *tls.Config) server.Option

AuthTLS should be used to setup a secure authentication using TLS

func Code

func Code(err error) codes.Code

Code returns the error code for err if it was produced by the rpc system. Otherwise, it returns codes.Unknown.

func Codec

func Codec(contentType string, c grpc.Codec) server.Option

gRPC Codec to be used to encode/decode requests for a given content type

func ErrorDesc

func ErrorDesc(err error) string

ErrorDesc returns the error description of err if it was produced by the rpc system. Otherwise, it returns err.Error() or empty string when err is nil.

func Errorf

func Errorf(c codes.Code, format string, a ...interface{}) error

Errorf returns an error containing an error code and a description; Errorf returns nil if c is OK.

func NewServer

func NewServer(opts ...server.Option) server.Server

func TransportConfig

func TransportConfig(sc *grpcTransport.ServerConfig) server.Option

TransportConfig should be used to setup a gRPC transport (http2 server) config

Types

type Debug

type Debug struct {
	debug.DebugHandler
}

We use this to wrap any debug handlers so we preserve the signature Debug.{Method}