service

Documentation

Index

• type Closer
• type HTTPServer
• type Initialiser
• type Service
  • func New(cfg *config.Configuration, mongoClient *mongo.Client) *Service
  • func (svc *Service) Close(ctx context.Context) error
  • func (svc *Service) Run(ctx context.Context, recipeData map[string]models.Recipe, svcErrors chan error) (err error)

Types

type Closer

type Closer interface {
	Close(ctx context.Context) error
}

Closer defines the required methods for a closable resource

type HTTPServer

type HTTPServer interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

HTTPServer defines the required methods from the HTTP server

type Initialiser

type Initialiser interface {
	DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer
}

Initialiser defines the methods to initialise external services

type Service

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

Service contains all the configs, server and clients to run the Dataset API

func New

func New(cfg *config.Configuration, mongoClient *mongo.Client) *Service

New creates a new service

func (*Service) Close

func (svc *Service) Close(ctx context.Context) error

Close gracefully shuts the service down in the required order, with timeout

func (*Service) Run

func (svc *Service) Run(ctx context.Context, recipeData map[string]models.Recipe, svcErrors chan error) (err error)

Run the service