httpserver

Documentation

Overview

Package httpserver provides http server as module.

Index

• type Opt
  • func WithAddr(addr string) Opt
  • func WithHandler(h http.Handler) Opt
  • func WithServer(srv *http.Server) Opt
  • func WithShutdownTimeout(d time.Duration) Opt
• type Server
  • func New(opts ...Opt) *Server
  • func (s *Server) Init() error
  • func (s *Server) Name() string
  • func (s *Server) Run() error
  • func (s *Server) Stop() error
  • func (s *Server) URL() string

Examples

• New

Types

type Opt

type Opt func(s *Server) error

func WithAddr

func WithAddr(addr string) Opt

WithAddr sets http.Server.Addr.

func WithHandler

func WithHandler(h http.Handler) Opt

WithHandler sets http.Server.Handler.

func WithServer

func WithServer(srv *http.Server) Opt

WithServer sets http.Server for module.

func WithShutdownTimeout

func WithShutdownTimeout(d time.Duration) Opt

WithShutdownTimeout sets timeout for graceful shutdown.

type Server

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

func New

func New(opts ...Opt) *Server

New creates Server module with given options.

Example

package main

import (
	"fmt"
	"net/http"
	"time"

	"github.com/elisasre/go-common/service/module/httpserver"
)

func main() {
	httpserver.New(
		httpserver.WithServer(&http.Server{ReadHeaderTimeout: time.Second}),
		httpserver.WithAddr("127.0.0.1:0"),
		httpserver.WithHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
			fmt.Fprint(w, "Hello")
		})),
	)
}

func (*Server) Init

func (s *Server) Init() error

Init starts net.Listener after applying all options. Options are applied in same order as they were provided.

func (*Server) Name

func (s *Server) Name() string

func (*Server) Run

func (s *Server) Run() error

Run starts serving http request and can be called after initialization.

func (*Server) Stop

func (s *Server) Stop() error

Stop calls shutdown for server.

func (*Server) URL

func (s *Server) URL() string

URL returns server's URL and can be called after initialization.