grpc

README

GRPC server

Environment based configuration

• ADDR
  • Address golang listen address in the Dial format

Documentation

Index

• Constants
• Variables
• func AddExternalDependencyMetadataToContext(ctx context.Context, md metadata.MD) context.Context
• func ContextWithUTMFromMetadata(parentCtx context.Context, md metadata.MD) context.Context
• func Dial(addr string) (*grpc.ClientConn, error)
• func DialContext(_ context.Context, addr string) (*grpc.ClientConn, error)
• func EncodeContextWithUTMData(parentCtx context.Context) context.Context
• func ListenAndServe(gs *grpc.Server) error
• func Listener() (net.Listener, error)
• func NewClient(addr string) (*grpc.ClientConn, error)
• func Server(ab AuthBackend, logger grpc_logging.Logger) *grpc.Server
• type AuthBackend
• type Config

Constants

const (
	MetadataKeyBearerToken          = "bearer_token"
	MetadataKeyContentType          = "content-type"
	MetadataKeyExternalDependencies = "external_dependencies"
	MetadataKeyLocale               = "locale"
	MetadataKeyRequestID            = "req_id"
)

Variables

var InternalServerError = errors.New("internal server error")

Functions

func AddExternalDependencyMetadataToContext

func AddExternalDependencyMetadataToContext(ctx context.Context, md metadata.MD) context.Context

AddExternalDependencyMetadataToContext adds external dependencies to the context if they are present in the metadata.

func ContextWithUTMFromMetadata

func ContextWithUTMFromMetadata(parentCtx context.Context, md metadata.MD) context.Context

func Dial

func Dial(addr string) (*grpc.ClientConn, error)

Deprecated: Use NewClient instead.

func DialContext

func DialContext(_ context.Context, addr string) (*grpc.ClientConn, error)

Deprecated: Use NewClient instead.

func EncodeContextWithUTMData

func EncodeContextWithUTMData(parentCtx context.Context) context.Context

func ListenAndServe

func ListenAndServe(gs *grpc.Server) error

func Listener

func Listener() (net.Listener, error)

func NewClient

func NewClient(addr string) (*grpc.ClientConn, error)

func Server

func Server(ab AuthBackend, logger grpc_logging.Logger) *grpc.Server

Types

type AuthBackend

type AuthBackend interface {
	AuthorizeStream(ctx context.Context) (context.Context, error)
	AuthorizeUnary(ctx context.Context) (context.Context, error)
}

type Config

type Config struct {
	Address string `env:"GRPC_ADDR" envDefault:":3001"`
}