grpcz

Documentation

Index

• func ServerWithGatewayHandler(grpcServer *grpc.Server, grpcGatewayHandler http.Handler, ...) http.Handler
• type ServerWithGateway
  • func NewServerWithGateway(grpcServer *grpc.Server, grpcGatewayMux *http.ServeMux, ...) *ServerWithGateway
  • func (s *ServerWithGateway) Serve(ctx context.Context, l net.Listener) error
• type ServerWithGatewayOption
  • func WithContinueSignalHandler(continueSignalHandler func(sig os.Signal) bool) ServerWithGatewayOption
  • func WithHTTPServer(httpServer *http.Server) ServerWithGatewayOption
  • func WithShutdownErrorHandler(shutdownErrorHandler func(err error)) ServerWithGatewayOption
  • func WithShutdownTimeout(shutdownTimeout time.Duration) ServerWithGatewayOption
  • func WithSignalChannel(signalChannel chan os.Signal) ServerWithGatewayOption

Functions

func ServerWithGatewayHandler

func ServerWithGatewayHandler(grpcServer *grpc.Server, grpcGatewayHandler http.Handler, http2Server *http2.Server) http.Handler

Types

type ServerWithGateway

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

func NewServerWithGateway

func NewServerWithGateway(
	grpcServer *grpc.Server,
	grpcGatewayMux *http.ServeMux,
	opts ...ServerWithGatewayOption,
) *ServerWithGateway

NewServerWithGateway returns grpc server instance with general shutdown handling.

Example:

server := grpcz.NewServerWithGateway(
	grpcServer,
	mux,
	grpcz.WithSignalChannel(contextz.MustSignalChannel(ctx)),
	grpcz.WithContinueSignalHandler(func(sig os.Signal) bool {
		l.With(rec.String("signal", sig.String())).F().Debugf("caught signal: %s", sig)
		return sig == syscall.SIGHUP
	}),
	grpcz.WithShutdownErrorHandler(func(err error) {
		l.With(rec.Error(err), rec.ErrorStacktrace(err)).F().Errorf("shutdown error: %v", err)
	}),
)

func (*ServerWithGateway) Serve

func (s *ServerWithGateway) Serve(
	ctx context.Context,
	l net.Listener,
) error

ListenAndServe serve gRPC Server with gRPC Gateway.

type ServerWithGatewayOption

type ServerWithGatewayOption func(s *ServerWithGateway)

func WithContinueSignalHandler

func WithContinueSignalHandler(continueSignalHandler func(sig os.Signal) bool) ServerWithGatewayOption

func WithHTTPServer

func WithHTTPServer(httpServer *http.Server) ServerWithGatewayOption

WithHTTPServer

If *http.Server has (*http.Server).Handler, it is ignored by grpcz.ServerWithGateway.

func WithShutdownErrorHandler

func WithShutdownErrorHandler(shutdownErrorHandler func(err error)) ServerWithGatewayOption

func WithShutdownTimeout

func WithShutdownTimeout(shutdownTimeout time.Duration) ServerWithGatewayOption

func WithSignalChannel

func WithSignalChannel(signalChannel chan os.Signal) ServerWithGatewayOption