server

Documentation

Index

• type HTTPListener
  • func New(opts ...Option) *HTTPListener
  • func (s *HTTPListener) Listen(ctx context.Context, handler http.Handler) error
• type Logger
• type Mux
• type Option
  • func WithIdleTimeout(timeout time.Duration) Option
  • func WithLogger(logger Logger) Option
  • func WithOnShutdown(f func()) Option
  • func WithPort(port int) Option
  • func WithReadTimeout(timeout time.Duration) Option
  • func WithShutdownTimeout(timeout time.Duration) Option
  • func WithWriteTimeout(timeout time.Duration) Option

Types

type HTTPListener

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

func New

func New(opts ...Option) *HTTPListener

func (*HTTPListener) Listen

func (s *HTTPListener) Listen(ctx context.Context, handler http.Handler) error

type Logger

type Logger interface {
	Debug(args ...interface{})
	Error(args ...interface{})
	Warn(args ...interface{})
}

type Mux

type Mux interface {
	http.Handler
	Handle(string, http.Handler)
}

type Option

type Option func(*options)

func WithIdleTimeout

func WithIdleTimeout(timeout time.Duration) Option

WithIdleTimeout sets the maximum amount of time to wait for the next request.

func WithLogger

func WithLogger(logger Logger) Option

func WithOnShutdown

func WithOnShutdown(f func()) Option

func WithPort

func WithPort(port int) Option

func WithReadTimeout

func WithReadTimeout(timeout time.Duration) Option

WithReadTimeout sets the maximum duration for reading the entire request, including the body.

func WithShutdownTimeout

func WithShutdownTimeout(timeout time.Duration) Option

WithShutdownTimeout sets the maximum duration for graceful shutdown (0 is no timeout).

func WithWriteTimeout

func WithWriteTimeout(timeout time.Duration) Option

WithWriteTimeout sets the maximum duration before timing out writes of the response.