api

Documentation

Index

• type API
  • func New(srv *service.Service, version string) *API
  • func (a *API) Start(apiPort string, tlsCertificate, tlsKey, tlsCaCert string, remaining int, ...) error
  • func (a *API) Stop() error

Types

type API

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

API is the struct that manages the api

func New

func New(srv *service.Service, version string) *API

New returns the API struct

func (*API) Start

func (a *API) Start(apiPort string, tlsCertificate, tlsKey, tlsCaCert string, remaining int, requireClientCertificate bool, outputPaths, errorOutputPaths []string, debug bool) error

Start the API

func (*API) Stop

func (a *API) Stop() error

Stop the API