grapiserver

Documentation

Index

• type Address
• type Config
• type Engine
  • func New(opts ...Option) *Engine
  • func (e *Engine) Serve(ctx context.Context) error
• type HTTPServerConfig
• type HTTPServerMiddleware
• type Option
  • func WithAddr(network, addr string) Option
  • func WithDefaultLogger() Option
  • func WithGatewayAddr(network, addr string) Option
  • func WithGatewayDialOptions(opts ...grpc.DialOption) Option
  • func WithGatewayMuxOptions(opts ...runtime.ServeMuxOption) Option
  • func WithGatewayServerConfig(cfg *HTTPServerConfig) Option
  • func WithGatewayServerMiddlewares(middlewares ...HTTPServerMiddleware) Option
  • func WithGatewayServerStreamInterceptors(interceptors ...grpc.StreamClientInterceptor) Option
  • func WithGatewayServerUnaryInterceptors(interceptors ...grpc.UnaryClientInterceptor) Option
  • func WithGrpcAddr(network, addr string) Option
  • func WithGrpcInternalAddr(network, addr string) Option
  • func WithGrpcServerOptions(opts ...grpc.ServerOption) Option
  • func WithGrpcServerStreamInterceptors(interceptors ...grpc.StreamServerInterceptor) Option
  • func WithGrpcServerUnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor) Option
  • func WithPassedHeader(decider PassedHeaderDeciderFunc) Option
  • func WithServers(svrs ...Server) Option
• type PassedHeaderDeciderFunc
• type Server

Types

type Address

type Address struct {
	Network string
	Addr    string
}

Address represents a network end point address.

type Config

type Config struct {
	GrpcAddr                        *Address
	GrpcInternalAddr                *Address
	GatewayAddr                     *Address
	Servers                         []Server
	GrpcServerUnaryInterceptors     []grpc.UnaryServerInterceptor
	GrpcServerStreamInterceptors    []grpc.StreamServerInterceptor
	GatewayServerUnaryInterceptors  []grpc.UnaryClientInterceptor
	GatewayServerStreamInterceptors []grpc.StreamClientInterceptor
	GrpcServerOption                []grpc.ServerOption
	GatewayDialOption               []grpc.DialOption
	GatewayMuxOptions               []runtime.ServeMuxOption
	GatewayServerConfig             *HTTPServerConfig
	MaxConcurrentStreams            uint32
	GatewayServerMiddlewares        []HTTPServerMiddleware
}

Config contains configurations of gRPC and Gateway server.

type Engine

type Engine struct {
	*Config
}

Engine is the framework instance.

func New

func New(opts ...Option) *Engine

New creates a server intstance.

func (*Engine) Serve

func (e *Engine) Serve(ctx context.Context) error

Serve starts gRPC and Gateway servers.

type HTTPServerConfig

type HTTPServerConfig struct {
	TLSConfig         *tls.Config
	ReadTimeout       time.Duration
	ReadHeaderTimeout time.Duration
	WriteTimeout      time.Duration
	IdleTimeout       time.Duration
	MaxHeaderBytes    int
	TLSNextProto      map[string]func(*http.Server, *tls.Conn, http.Handler)
	ConnState         func(net.Conn, http.ConnState)
}

type HTTPServerMiddleware

type HTTPServerMiddleware func(http.Handler) http.Handler

HTTPServerMiddleware is an interface of http server middleware

type Option

type Option func(*Config)

Option configures a gRPC and a gateway server.

func WithAddr

func WithAddr(network, addr string) Option

WithAddr returns an Option that sets an network address for a gRPC and a gateway server.

func WithDefaultLogger

func WithDefaultLogger() Option

WithDefaultLogger returns an Option that sets default grpclogger.LoggerV2 object.

func WithGatewayAddr

func WithGatewayAddr(network, addr string) Option

WithGatewayAddr returns an Option that sets an network address for a gateway server.

func WithGatewayDialOptions

func WithGatewayDialOptions(opts ...grpc.DialOption) Option

WithGatewayDialOptions returns an Option that sets grpc.DialOption(s) to a gRPC clinet used by a gateway server.

func WithGatewayMuxOptions

func WithGatewayMuxOptions(opts ...runtime.ServeMuxOption) Option

WithGatewayMuxOptions returns an Option that sets runtime.ServeMuxOption(s) to a gateway server.

func WithGatewayServerConfig

func WithGatewayServerConfig(cfg *HTTPServerConfig) Option

WithGatewayServerConfig returns an Option that specifies http.Server configuration to a gateway server.

func WithGatewayServerMiddlewares

func WithGatewayServerMiddlewares(middlewares ...HTTPServerMiddleware) Option

WithGatewayServerMiddlewares returns an Option that sets middleware(s) for http.Server to a gateway server.

func WithGatewayServerStreamInterceptors

func WithGatewayServerStreamInterceptors(interceptors ...grpc.StreamClientInterceptor) Option

WithGatewayServerStreamInterceptors returns an Option that sets stream interceptor(s) for a gRPC client used by a gateway server.

func WithGatewayServerUnaryInterceptors

func WithGatewayServerUnaryInterceptors(interceptors ...grpc.UnaryClientInterceptor) Option

WithGatewayServerUnaryInterceptors returns an Option that sets unary interceptor(s) for a gRPC client used by a gateway server.

func WithGrpcAddr

func WithGrpcAddr(network, addr string) Option

WithGrpcAddr returns an Option that sets an network address for a gRPC server.

func WithGrpcInternalAddr

func WithGrpcInternalAddr(network, addr string) Option

WithGrpcInternalAddr returns an Option that sets an network address connected by a gateway server.

func WithGrpcServerOptions

func WithGrpcServerOptions(opts ...grpc.ServerOption) Option

WithGrpcServerOptions returns an Option that sets grpc.ServerOption(s) to a gRPC server.

func WithGrpcServerStreamInterceptors

func WithGrpcServerStreamInterceptors(interceptors ...grpc.StreamServerInterceptor) Option

WithGrpcServerStreamInterceptors returns an Option that sets stream interceptor(s) for a gRPC server.

func WithGrpcServerUnaryInterceptors

func WithGrpcServerUnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor) Option

WithGrpcServerUnaryInterceptors returns an Option that sets unary interceptor(s) for a gRPC server.

func WithPassedHeader

func WithPassedHeader(decider PassedHeaderDeciderFunc) Option

WithPassedHeader returns an Option that sets configurations about passed headers for a gateway server.

func WithServers

func WithServers(svrs ...Server) Option

WithServers returns an Option that sets gRPC service server implementation(s).

type PassedHeaderDeciderFunc

type PassedHeaderDeciderFunc func(string) bool

PassedHeaderDeciderFunc returns true if given header should be passed to gRPC server metadata.

type Server

type Server interface {
	RegisterWithServer(*grpc.Server)
	RegisterWithHandler(context.Context, *runtime.ServeMux, *grpc.ClientConn) error
}

Server is an interface for representing gRPC server implementations.