grpc

Documentation

Overview

Package grpc provides a grpc server

Index

• Constants
• func Codec(contentType string, c encoding.Codec) server.Option
• func MaxMsgSize(s int) server.Option
• func Options(opts ...grpc.ServerOption) server.Option
• func Reflection(r Reflector) server.Option
• func UnknownServiceHandler(h grpc.StreamHandler) server.Option
• type Reflector
• type Server
  • func NewServer(opts ...server.Option) *Server
  • func (g *Server) Deregister() error
  • func (g *Server) GRPCServer() *grpc.Server
  • func (g *Server) Handle(h server.Handler) error
  • func (g *Server) Health() bool
  • func (g *Server) Init(opts ...server.Option) error
  • func (g *Server) Live() bool
  • func (g *Server) Name() string
  • func (g *Server) NewHandler(h interface{}, opts ...server.HandlerOption) server.Handler
  • func (g *Server) NewSubscriber(topic string, sb interface{}, opts ...server.SubscriberOption) server.Subscriber
  • func (g *Server) Options() server.Options
  • func (g *Server) Ready() bool
  • func (g *Server) Register() error
  • func (g *Server) Start() error
  • func (g *Server) Stop() error
  • func (g *Server) String() string
  • func (g *Server) Subscribe(sb server.Subscriber) error

Constants

const (
	// ReflectV1ServiceName is the fully-qualified name of the v1 version of the reflection service.
	ReflectV1ServiceName = "grpc.reflection.v1.ServerReflection"
	// ReflectServiceURLPathV1 is the full path for reflection service endpoint
	ReflectServiceURLPathV1 = "/" + ReflectV1ServiceName + "/"
	// ReflectMethodName is the reflection service name
	ReflectMethodName = "ServerReflectionInfo"
)

const (
	DefaultContentType = "application/grpc"
)

Functions

func Codec

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

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

func MaxMsgSize

func MaxMsgSize(s int) server.Option

MaxMsgSize set the maximum message in bytes the server can receive and send. Default maximum message size is 4 MB.

func Options

func Options(opts ...grpc.ServerOption) server.Option

Options to be used to configure gRPC options

func Reflection

func Reflection(r Reflector) server.Option

Reflection enables reflection support in grpc server

func UnknownServiceHandler

func UnknownServiceHandler(h grpc.StreamHandler) server.Option

UnknownServiceHandler enables support for all services

Types

type Reflector

type Reflector interface {
	protodesc.Resolver
	reflection.ServiceInfoProvider
	reflection.ExtensionResolver
}

type Server

type Server struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewServer

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

func (*Server) Deregister

func (g *Server) Deregister() error

func (*Server) GRPCServer

func (g *Server) GRPCServer() *grpc.Server

func (*Server) Handle

func (g *Server) Handle(h server.Handler) error

func (*Server) Health

func (g *Server) Health() bool

func (*Server) Init

func (g *Server) Init(opts ...server.Option) error

func (*Server) Live

func (g *Server) Live() bool

func (*Server) Name

func (g *Server) Name() string

func (*Server) NewHandler

func (g *Server) NewHandler(h interface{}, opts ...server.HandlerOption) server.Handler

func (*Server) NewSubscriber

func (g *Server) NewSubscriber(topic string, sb interface{}, opts ...server.SubscriberOption) server.Subscriber

func (*Server) Options

func (g *Server) Options() server.Options

func (*Server) Ready

func (g *Server) Ready() bool

func (*Server) Register

func (g *Server) Register() error

func (*Server) Start

func (g *Server) Start() error

func (*Server) Stop

func (g *Server) Stop() error

func (*Server) String

func (g *Server) String() string

func (*Server) Subscribe

func (g *Server) Subscribe(sb server.Subscriber) error