router

Documentation

Overview

Package router provides the top-level router

Index

• type Router
  • func New(c *config.Config, l *log.Logger) *Router
  • func (r *Router) AddRoutes(handle *handlers.Handler)
  • func (r *Router) Run()
  • func (r *Router) Stop(ctx context.Context) error

Types

type Router

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

Router is the top-level router instance wrapping it's dependencies TODO <2020/12/09>: Think about a better way to pass in the broadcatser hub

func New

func New(c *config.Config, l *log.Logger) *Router

New creates a new router instance and returns it

func (*Router) AddRoutes

func (r *Router) AddRoutes(handle *handlers.Handler)

AddRoutes adds all routes to the router instance and registers the handlers

func (*Router) Run

func (r *Router) Run()

Run starts the HTTP Server or returns an error

func (*Router) Stop

func (r *Router) Stop(ctx context.Context) error

Stop gracefully stops the router