server

Documentation

Index

• Variables
• func HealthHandler(w http.ResponseWriter, _ *http.Request)
• type HTTPServer
  • func ForPort(port string) (*HTTPServer, error)
  • func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)
  • func (s *HTTPServer) Address() string
  • func (s *HTTPServer) Running() bool
  • func (s *HTTPServer) SetupHandler(path string, handler http.Handler)
  • func (s *HTTPServer) Shutdown() error
  • func (s *HTTPServer) Start() error
  • func (s *HTTPServer) StartAndAnnounce(name string) error
  • func (s *HTTPServer) Stopped() bool
• type SSLConfig
  • func NewSSLConfig() SSLConfig
  • func (opts *SSLConfig) Available() bool

Variables

var (

	// Host is a default bind address for HTTP servers
	Host string = "localhost"
	// SSL is a default configuration for HTTP servers
	SSL *SSLConfig
	// MaxConn is a default configuration for maximum connections
	MaxConn int
)

Functions

func HealthHandler

func HealthHandler(w http.ResponseWriter, _ *http.Request)

HealthHandler always reponds with 200 status

Types

type HTTPServer

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

HTTPServer is wrapper over http.Server

func ForPort

func ForPort(port string) (*HTTPServer, error)

ForPort creates new or returns the existing server for the specified port

func NewServer

func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)

NewServer builds HTTPServer from config params

func (*HTTPServer) Address

func (s *HTTPServer) Address() string

Address returns server scheme://host:port

func (*HTTPServer) Running

func (s *HTTPServer) Running() bool

Running returns true if server has been started

func (*HTTPServer) SetupHandler

func (s *HTTPServer) SetupHandler(path string, handler http.Handler)

SetupHandler adds new handler to mux

func (*HTTPServer) Shutdown

func (s *HTTPServer) Shutdown() error

Shutdown shuts down server gracefully.

func (*HTTPServer) Start

func (s *HTTPServer) Start() error

Start server

func (*HTTPServer) StartAndAnnounce

func (s *HTTPServer) StartAndAnnounce(name string) error

StartAndAnnounce prints server info and starts server

func (*HTTPServer) Stopped

func (s *HTTPServer) Stopped() bool

Stopped return true iff server has been stopped by user

type SSLConfig

type SSLConfig struct {
	CertPath string
	KeyPath  string
}

SSLConfig contains SSL parameters

func NewSSLConfig

func NewSSLConfig() SSLConfig

NewSSLConfig build a new SSLConfig struct

func (*SSLConfig) Available

func (opts *SSLConfig) Available() bool

Available returns true iff certificate and private keys are set