mux

README

Mux

mux package provides protocol multiplexing for HTTP & gRPC servers.

Usage

Refer _example/ for usage reference.

Documentation

Index

• func Serve(ctx context.Context, listenAddr string, opts ...Option) error
• type Option
  • func WithGRPC(server *grpc.Server) Option
  • func WithGracePeriod(d time.Duration) Option
  • func WithHTTP(h http.Handler) Option

Functions

func Serve

func Serve(ctx context.Context, listenAddr string, opts ...Option) error

Serve starts a TCP listener and serves the registered protocol servers and blocks until server exits. Context can be cancelled to perform graceful shutdown. Use WithHTTP() and WithGRPC() to register protocol servers.

Types

type Option

type Option func(m *muxServer) error

Option values can be used with Serve() for customisation.

func WithGRPC

func WithGRPC(server *grpc.Server) Option

WithGRPC registers the gRPC-server for use in Serve().

func WithGracePeriod

func WithGracePeriod(d time.Duration) Option

WithGracePeriod sets the wait duration for graceful shutdown.

func WithHTTP

func WithHTTP(h http.Handler) Option

WithHTTP registers the http-server for use in Serve().