server

README

Server

This is the first module (outermost layer) where the code becomes aware of the web framework.

Keeping this isolated allows us to easily upgrade and switch to something else if needed.

Documentation

Index

• type Components
  • func NewComponents(config *config.App) (*Components, error)
  • func (c *Components) Run()
• type Setup
  • func NewSetup(httpClient *http.Client, esClient *elasticsearch.Client, config *config.App) Setup

Types

type Components

type Components struct {
	Config *config.App
	// contains filtered or unexported fields
}

func NewComponents

func NewComponents(config *config.App) (*Components, error)

func (*Components) Run

func (c *Components) Run()

type Setup

type Setup interface {

	// Check returns an error if all the necessary setup is not complete
	Check(ctx context.Context) error

	// RunIfNeeded attempts to run the subroutines necessary, no more no less
	RunIfNeeded(ctx context.Context) error
}

Setup abstracts away:

1. Setting up the environment for running Tasques 2. Checking that things are set up

func NewSetup

func NewSetup(httpClient *http.Client, esClient *elasticsearch.Client, config *config.App) Setup

NewSetup returns a Setup implementation