application

Documentation

Overview

Copyright 2021 Axis Communications AB.

For a full list of individual contributors, please see the commit history.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Application
  • func Get(ctx context.Context, cfg config.Config, logger *log.Entry) (*Application, error)
  • func (app *Application) LoadV1Routes()
  • func (app *Application) Start(ctx context.Context) error
  • func (app *Application) Stop(ctx context.Context) error

Types

type Application

type Application struct {
	Database drivers.Database
	Config   config.Config
	Router   *mux.Router
	Server   server.Server
	V1       *v1api.V1Application
	Logger   *log.Entry
}

func Get

func Get(ctx context.Context, cfg config.Config, logger *log.Entry) (*Application, error)

Get a new Goer application.

func (*Application) LoadV1Routes

func (app *Application) LoadV1Routes()

LoadV1Routes loads routes for the /v1/ endpoint.

func (*Application) Start

func (app *Application) Start(ctx context.Context) error

Start connects to the database and starts the webserver. This is a blocking function, waiting for the webserver to shut down.

func (*Application) Stop

func (app *Application) Stop(ctx context.Context) error

Stop the application and close the database connection.