api

Documentation

Index

• func WithExportPluginSystem(e *plugin.ExportPluginSystem) option
• func WithSourcePluginSystem(e *plugin.SourcePluginSystem) option
• type API
  • func New(opts ...option) *API
  • func (a *API) Start(ctx context.Context)
  • func (a *API) Stop(ctx context.Context)

Functions

func WithExportPluginSystem

func WithExportPluginSystem(e *plugin.ExportPluginSystem) option

func WithSourcePluginSystem

func WithSourcePluginSystem(e *plugin.SourcePluginSystem) option

Types

type API

type API struct {
	*http.Server
	// contains filtered or unexported fields
}

ApiServer object

func New

func New(opts ...option) *API

New returns an instance of a configured API

func (*API) Start

func (a *API) Start(ctx context.Context)

Start is a blocking event that starts the server on the configured port

func (*API) Stop

func (a *API) Stop(ctx context.Context)

Stop sends a termination signal to the api server