grpc

Documentation

Index

• type Option
  • func WithGRPCServerOption(opt grpc.ServerOption) Option
  • func WithGracePeriod(t time.Duration) Option
  • func WithListen(s string) Option
  • func WithNetwork(s string) Option
  • func WithServer(f registerServerFunc) Option
  • func WithTLSConfig(cfg *tls.Config) Option
• type Server
  • func New(logger log.Logger, reg prometheus.Registerer, tracer opentracing.Tracer, ...) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Shutdown(err error)

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option overrides behavior of Server.

func WithGRPCServerOption

func WithGRPCServerOption(opt grpc.ServerOption) Option

WithGRPCServerOption allows adding raw grpc.ServerOption's to the instantiated gRPC server.

func WithGracePeriod

func WithGracePeriod(t time.Duration) Option

WithGracePeriod sets shutdown grace period for gRPC server. Server waits connections to drain for specified amount of time.

func WithListen

func WithListen(s string) Option

WithListen sets address to listen for gRPC server. Server accepts incoming connections on given address.

func WithNetwork

func WithNetwork(s string) Option

WithNetwork sets network to listen for gRPC server e.g tcp, udp or unix.

func WithServer

func WithServer(f registerServerFunc) Option

WithServer calls the passed gRPC registration functions on the created grpc.Server.

func WithTLSConfig

func WithTLSConfig(cfg *tls.Config) Option

WithTLSConfig sets TLS configuration for gRPC server.

type Server

type Server struct {
	// contains filtered or unexported fields
}

A Server defines parameters to serve RPC requests, a wrapper around grpc.Server.

func New

func New(logger log.Logger, reg prometheus.Registerer, tracer opentracing.Tracer, logOpts []grpc_logging.Option, tagsOpts []tags.Option, comp component.Component, probe *prober.GRPCProbe, opts ...Option) *Server

New creates a new gRPC Store API. If rulesSrv is not nil, it also registers Rules API to the returned server.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe listens on the TCP network address and handles requests on incoming connections.

func (*Server) Shutdown

func (s *Server) Shutdown(err error)

Shutdown gracefully shuts down the server by waiting, for specified amount of time (by gracePeriod) for connections to return to idle and then shut down.