grpcserver

Documentation

Overview

Package grpcserver implements handy wrap around gRPC server to group common settings and tasks inside single entity.

Index

• type Server
  • func New(address, crtPath, keyPath string, opts ...grpc.ServerOption) (*Server, error)
  • func (s *Server) Instance() *grpc.Server
  • func (s *Server) Notify() <-chan error
  • func (s *Server) Shutdown()
  • func (s *Server) Start()

Types

type Server

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

Server wraps gRPC server entity and handy means to simplify work with it.

func New

func New(address, crtPath, keyPath string, opts ...grpc.ServerOption) (*Server, error)

NewSecureServer creates new instance of gRPC server operating over SSL.

func (*Server) Instance

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

Instance grants access to the underlying gRPC server. Should be used to attach new API services.

func (*Server) Notify

func (s *Server) Notify() <-chan error

Notify reports errors received during start and work of the server. Usually such errors are not recoverable.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown gracefully stops the server.

func (*Server) Start

func (s *Server) Start()

Start launches the gRPC server.