http

Documentation

Index

• func ErrCodeFromStatus(code int) string
• func ListenAndServeDebug() error
• func NewSessionManager() *scs.SessionManager
• func StatusCode(err error) int
• type Error
• type Server
  • func NewServer() *Server
  • func (s *Server) CreateSession(ctx context.Context, user *todo.User) error
  • func (s *Server) DestroySession(ctx context.Context) error
  • func (s *Server) Listen() (err error)
  • func (s *Server) Port() int
  • func (s *Server) RenewSession(ctx context.Context) error
  • func (s *Server) Scheme() string
  • func (s *Server) Shutdown() error
  • func (s *Server) URL() string

Functions

func ErrCodeFromStatus

func ErrCodeFromStatus(code int) string

ErrCodeFromStatus returns the corresponding error code for an HTTP status code.

func ListenAndServeDebug

func ListenAndServeDebug() error

func NewSessionManager

func NewSessionManager() *scs.SessionManager

func StatusCode

func StatusCode(err error) int

StatusCode returns the HTTP status code for an error code.

Types

type Error

type Error struct {
	Message string `json:"error"`
}

type Server

type Server struct {

	// config values
	Addr               string
	Domain             string
	TLS                bool
	APIKey             string
	CORSAllowedOrigins string
	// AssetsDirectory is the path to the frontend HTML/CSS/JavaScript
	AssetsDirectory string

	Logger todo.Logger
	// LoggerMiddleware is exposed for testing purposes.
	LoggerMiddleware func(http.Handler) http.Handler
	SessionManager   *scs.SessionManager
	ItemListService  todo.ItemListService
	UserService      todo.UserService
	// contains filtered or unexported fields
}

func NewServer

func NewServer() *Server

func (*Server) CreateSession

func (s *Server) CreateSession(ctx context.Context, user *todo.User) error

func (*Server) DestroySession

func (s *Server) DestroySession(ctx context.Context) error

func (*Server) Listen

func (s *Server) Listen() (err error)

func (*Server) Port

func (s *Server) Port() int

Port returns the TCP port for the running server. This is useful in tests where we allocate a random port by using ":0".

func (*Server) RenewSession

func (s *Server) RenewSession(ctx context.Context) error

func (*Server) Scheme

func (s *Server) Scheme() string

func (*Server) Shutdown

func (s *Server) Shutdown() error

func (*Server) URL

func (s *Server) URL() string

URL returns the local base URL of the running server.