api

Documentation

Index

• type API
  • func NewAPI(d daemon.Daemon, conf config.APIConfig) (*API, error)
  • func (a *API) Shutdown(ctx context.Context) error
  • func (a *API) Start(address string) error

Types

type API

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

API represent the Daemon REST API

func NewAPI

func NewAPI(d daemon.Daemon, conf config.APIConfig) (*API, error)

NewAPI return a new API instance, wrapped around given Daemon instance and with given config

func (*API) Shutdown

func (a *API) Shutdown(ctx context.Context) error

Shutdown terminate the API server cleanly

func (*API) Start

func (a *API) Start(address string) error

Start the API server