server

Documentation

Index

• Constants
• func ConfigAdd(path string)
• func Error(err error) error
• func ToStruct(v map[string]interface{}) *st.Struct
• func ToValue(v interface{}) *st.Value
• type KeepAliveOtions
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type Plugin
• type Server
  • func NewServer(ctx context.Context, plugins ...Plugin) *Server
  • func NewServerWithConfigPath(ctx context.Context, path string) (*Server, error)
  • func NewServerWithOptions(ctx context.Context, opt *Options, plugins ...Plugin) *Server
  • func (s *Server) Serve(ctx context.Context)
  • func (s *Server) Server() *grpc.Server
  • func (s *Server) ServiceRegistrar() grpc.ServiceRegistrar
  • func (s *Server) Shutdown(ctx context.Context)
• type TLSAutoOptions
• type TLSFileOptions
• type TLSOptions

Constants

const (
	PluginsRoot = root + ".plugins"
)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Error

func Error(err error) error

Error converts errors to grpc errors

func ToStruct

func ToStruct(v map[string]interface{}) *st.Struct

ToStruct converts a map[string]interface{} to a ptypes.Struct

func ToValue

func ToValue(v interface{}) *st.Value

ToValue converts an interface{} to a ptypes.Value

Types

type KeepAliveOtions

type KeepAliveOtions struct {
	Time                  time.Duration // Ping interval in seconds
	Timeout               time.Duration // Timeout for a ping response in seconds
	MaxConnectionIdle     time.Duration // Max idle time in seconds before closing the connection
	MaxConnectionAge      time.Duration // Max connection age in seconds before closing
	MaxConnectionAgeGrace time.Duration // Grace period in seconds before forcing connection closure
}

type Options

type Options struct {
	Port                  int
	MaxConcurrentStreams  int64
	InitialWindowSize     int32
	InitialConnWindowSize int32
	TLS                   TLSOptions `config:"tls"`
	KeepAlive             KeepAliveOtions
}

Options grpc server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type Plugin

type Plugin func(ctx context.Context) []grpc.ServerOption

Plugin defines a grpc server Plugin function to execute.

type Server

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

Server represents a grpc server.

func NewServer

func NewServer(ctx context.Context, plugins ...Plugin) *Server

NewServer returns a new grpc server with default options.

func NewServerWithConfigPath

func NewServerWithConfigPath(ctx context.Context, path string) (*Server, error)

NewServerWithConfigPath returns a new grpc server with options from config path.

func NewServerWithOptions

func NewServerWithOptions(ctx context.Context, opt *Options, plugins ...Plugin) *Server

NewServerWithOptions returns a new grpc server with options.

func (*Server) Serve

func (s *Server) Serve(ctx context.Context)

Serve starts grpc server.

func (*Server) Server

func (s *Server) Server() *grpc.Server

Server returns the wrapped grpc server instance.

func (*Server) ServiceRegistrar

func (s *Server) ServiceRegistrar() grpc.ServiceRegistrar

ServiceRegistrar returns grpc service register.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context)

Shutdown stops grpc server gracefully.

type TLSAutoOptions

type TLSAutoOptions struct {
	Host string
}

type TLSFileOptions

type TLSFileOptions struct {
	Cert string
	Key  string
	CA   string `config:"ca"`
}

type TLSOptions

type TLSOptions struct {
	Enabled bool
	Type    string
	Auto    TLSAutoOptions
	File    TLSFileOptions
}