httputil

Documentation

Overview

Package httputil contains a HTTP/HTTPS Server which can be stopped via signals or a Shutdown() call.

Index

• Constants
• Variables
• func CheckLocalRedirect(urlString string) error
• func RandomFileServer(paths []string, errHandler func(err error)) http.Handler
• func SingleFileServer(path string, errHandler func(err error)) http.Handler
• type HTTPServer
  • func (hs *HTTPServer) RunHTTPSServer(keypath string, certFile string, keyFile string, laddr string, ...) error
  • func (hs *HTTPServer) RunHTTPServer(laddr string, wgStatus *sync.WaitGroup) error
  • func (hs *HTTPServer) Shutdown()

Constants

const SigShutdown = 1

SigShutdown is used to signal a request for shutdown

Variables

var ErrSigShutdown = errors.New("Server was shut down")

ErrSigShutdown indicates that a signal was received

Functions

func CheckLocalRedirect

func CheckLocalRedirect(urlString string) error

CheckLocalRedirect checks if a given redirect URL is a local redirect. The function returns an error in all other cases.

func RandomFileServer

func RandomFileServer(paths []string, errHandler func(err error)) http.Handler

RandomFileServer returns a handler that serves all HTTP requests with the contents of a random file. The file is picked from a predefined list.

func SingleFileServer

func SingleFileServer(path string, errHandler func(err error)) http.Handler

SingleFileServer returns a handler that serves all HTTP requests with the contents of a single file.

Types

type HTTPServer

type HTTPServer struct {
	LastError error // Last recorded error
	Running   bool  // Flag if the server is running
	// contains filtered or unexported fields
}

HTTPServer data structure

func (*HTTPServer) RunHTTPSServer

func (hs *HTTPServer) RunHTTPSServer(keypath string, certFile string, keyFile string,
	laddr string, wgStatus *sync.WaitGroup) error

RunHTTPSServer starts a HTTPS Server which can be stopped via ^C (Control-C). It is assumed that all routes have been added prior to this call.

keypath should be set to a path containing the TLS certificate and key. certFile should be the file containing the TLS certificate. keyFile should be the file containing the private key for the TLS connection. laddr should be the local address which should be given to net.Listen. wgStatus is an optional wait group which will be notified once the server is listening and once the server has shutdown.

This function will not return unless the server is shutdown.

func (*HTTPServer) RunHTTPServer

func (hs *HTTPServer) RunHTTPServer(laddr string, wgStatus *sync.WaitGroup) error

RunHTTPServer starts a HTTP Server which can be stopped via ^C (Control-C). It is assumed that all routes have been added prior to this call.

laddr should be the local address which should be given to net.Listen. wgStatus is an optional wait group which will be notified once the server is listening and once the server has shutdown.

This function will not return unless the server is shutdown.

func (*HTTPServer) Shutdown

func (hs *HTTPServer) Shutdown()

Shutdown sends a shutdown signal.