grpcgateway

Documentation

Index

• type Config
  • func DefaultConfig(key string) *Config
  • func StdConfig(key string, optionFunc ...OptionFunc) *Config
  • func (c *Config) Build() *Server
  • func (c *Config) Path() string
• type Handler
• type OptionFunc
  • func WithMuxOption(opts ...runtime.ServeMuxOption) OptionFunc
  • func WithRegisterHandler(handlers ...Handler) OptionFunc
  • func WithWrap(wrap Wrap) OptionFunc
• type Server
  • func (server *Server) Name() string
  • func (server *Server) Serve(ctx context.Context) error
  • func (server *Server) Shutdown(ctx context.Context) error
• type Wrap

Types

type Config

type Config struct {
	Target string `config:"target" desc:"target gprc server addr"`
	Addr   string `config:"addr" desc:"format: host:port"`
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig(key string) *Config

func StdConfig

func StdConfig(key string, optionFunc ...OptionFunc) *Config

func (*Config) Build

func (c *Config) Build() *Server

func (*Config) Path

func (c *Config) Path() string

type Handler

type Handler Wrap

type OptionFunc

type OptionFunc func(*Config)

func WithMuxOption

func WithMuxOption(opts ...runtime.ServeMuxOption) OptionFunc

func WithRegisterHandler

func WithRegisterHandler(handlers ...Handler) OptionFunc

func WithWrap

func WithWrap(wrap Wrap) OptionFunc

type Server

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

func (*Server) Name

func (server *Server) Name() string

func (*Server) Serve

func (server *Server) Serve(ctx context.Context) error

func (*Server) Shutdown

func (server *Server) Shutdown(ctx context.Context) error

type Wrap

type Wrap func(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error