api

Documentation

Index

• func StartAPI(registry *plugin.Registry, mountpoint string, socketPath string, ...) (chan<- context.Context, <-chan struct{}, error)

Functions

func StartAPI

func StartAPI(
	registry *plugin.Registry,
	mountpoint string,
	socketPath string,
	analyticsClient analytics.Client,
) (chan<- context.Context, <-chan struct{}, error)

StartAPI starts the api. It returns three values:

1. A channel to initiate the shutdown (stopCh). stopCh accepts a Context object that is used to cancel a stalled shutdown.

2. A read-only channel that signals whether the server was shutdown.

3. An error object