api

package

v0.0.1-alpha.7 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func WithExportPluginSystem(e *plugin.ExportPluginSystem) option

func WithSourcePluginSystem(e *plugin.SourcePluginSystem) option

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

ApiServer object

func New(opts ...option) *API

New returns an instance of a configured API

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

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

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

Stop sends a termination signal to the api server