server

Documentation

Index

• Constants
• func HealthCheckHandler(w http.ResponseWriter, r *http.Request)
• func NewRouter() *mux.Router
• func OpenAPIDocHandler(w http.ResponseWriter, r *http.Request)
• func Serve(ctx context.Context, s Scope, errChan chan<- error)
• type Scheduler
  • func (s *Scheduler) Add(ctx context.Context, name string, periodicity time.Duration, Func TaskFunc)
  • func (s *Scheduler) Start(ctx context.Context)
• type Scope
• type ServeCtxKeyType
• type Task
  • func (t *Task) Start()
• type TaskFunc

Constants

const (
	ServeCtxKeyEnvPort = ServeCtxKeyType("ServeCtxKeyEnvPort")

	DefaultPort = 8080
)

Functions

func HealthCheckHandler

func HealthCheckHandler(w http.ResponseWriter, r *http.Request)

func NewRouter

func NewRouter() *mux.Router

func OpenAPIDocHandler

func OpenAPIDocHandler(w http.ResponseWriter, r *http.Request)

func Serve

func Serve(ctx context.Context, s Scope, errChan chan<- error)

Types

type Scheduler

type Scheduler struct {
	WG    sync.WaitGroup
	Tasks []Task
}

func (*Scheduler) Add

func (s *Scheduler) Add(ctx context.Context, name string, periodicity time.Duration, Func TaskFunc)

func (*Scheduler) Start

func (s *Scheduler) Start(ctx context.Context)

type Scope

type Scope interface {
	Route(*mux.Router)
}

type ServeCtxKeyType

type ServeCtxKeyType string

type Task

type Task struct {
	Name        string
	Periodicity time.Duration
	Func        TaskFunc
	Ctx         context.Context
}

func (*Task) Start

func (t *Task) Start()

type TaskFunc

type TaskFunc func(context.Context) bool