rpc

Documentation

Index

• type Config
  • func (config *Config) Address() string
  • func (config *Config) Build() *Server
  • func (config *Config) WithHost(host string) *Config
  • func (config *Config) WithName(name string) *Config
  • func (config *Config) WithNetwork(network string) *Config
  • func (config *Config) WithPort(port int) *Config
  • func (config *Config) WithServerOption(options ...grpc.ServerOption) *Config
  • func (config *Config) WithStreamInterceptor(intes ...grpc.StreamServerInterceptor) *Config
  • func (config *Config) WithUnaryInterceptor(intes ...grpc.UnaryServerInterceptor) *Config
• type Server
  • func (s *Server) GracefulStop(ctx context.Context) error
  • func (s *Server) Info() *server.ServiceInfo
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown() error
  • func (s *Server) Stop() error

Types

type Config

type Config struct {
	Host    string
	Port    int
	Network string // Network network type, tcp4 by default

	Name string
	// contains filtered or unexported fields
}

Config ...

func (*Config) Address

func (config *Config) Address() string

func (*Config) Build

func (config *Config) Build() *Server

Build ...

func (*Config) WithHost

func (config *Config) WithHost(host string) *Config

WithHost ...

func (*Config) WithName

func (config *Config) WithName(name string) *Config

WithName ...

func (*Config) WithNetwork

func (config *Config) WithNetwork(network string) *Config

WithNetwork ...

func (*Config) WithPort

func (config *Config) WithPort(port int) *Config

WithPort ...

func (*Config) WithServerOption

func (config *Config) WithServerOption(options ...grpc.ServerOption) *Config

WithServerOption inject server option to grpc server User should not inject interceptor option, which is recommend by WithStreamInterceptor and WithUnaryInterceptor

func (*Config) WithStreamInterceptor

func (config *Config) WithStreamInterceptor(intes ...grpc.StreamServerInterceptor) *Config

WithStreamInterceptor inject stream interceptors to server option

func (*Config) WithUnaryInterceptor

func (config *Config) WithUnaryInterceptor(intes ...grpc.UnaryServerInterceptor) *Config

WithUnaryInterceptor inject unary interceptors to server option

type Server

type Server struct {
	*grpc.Server
	// contains filtered or unexported fields
}

Server ...

func (*Server) GracefulStop

func (s *Server) GracefulStop(ctx context.Context) error

GracefulStop implements server.Server interface it will stop echo server gracefully

func (*Server) Info

func (s *Server) Info() *server.ServiceInfo

func (*Server) Serve

func (s *Server) Serve() error

Serve implements server.Server interface.

func (*Server) Shutdown

func (s *Server) Shutdown() error

func (*Server) Stop

func (s *Server) Stop() error

Stop implements server.Server interface it will terminate echo server immediately