server

Documentation

Index

• type HTTPServer
  • func (*HTTPServer) Close()
  • func (s *HTTPServer) Start() error
• type HTTPTestServer
  • func (s *HTTPTestServer) Start() error
• type Runner
  • func CreateHTTPServerRunner(routerFactory router.RouterFactory) Runner
  • func CreateHTTPTestServerRunner(routerFactory router.RouterFactory) Runner
  • func (s Runner) Run() error
• type Server

Types

type HTTPServer

type HTTPServer struct {
	http.Server
}

HTTPServer is a wrapper for an http server that implements the server interface.

func (*HTTPServer) Close

func (*HTTPServer) Close()

Close does nothing but exists to satisfy the server interface.

func (*HTTPServer) Start

func (s *HTTPServer) Start() error

Start starts the http server. Always returns a non-nil error.

type HTTPTestServer

type HTTPTestServer struct {
	*httptest.Server
}

HTTPTestServer is a wrapper for an httptest server that implements the server interface.

func (*HTTPTestServer) Start

func (s *HTTPTestServer) Start() error

Start start the server. Always returns a nil error.

type Runner

type Runner struct {
	Server Server
}

func CreateHTTPServerRunner

func CreateHTTPServerRunner(routerFactory router.RouterFactory) Runner

CreateHTTPServerRunner creates a new Runner using an HTTPServer.

func CreateHTTPTestServerRunner

func CreateHTTPTestServerRunner(routerFactory router.RouterFactory) Runner

CreateHTTPTestServerRunner creates a new Runner using an HTTPTestServer.

func (Runner) Run

func (s Runner) Run() error

Run runs the server and returns any errors.

type Server

type Server interface {
	// Start starts the server and returns any errors encountered while it is running.
	Start() error

	// Close closes the server.
	Close()
}