api
package v0.0.0-...-31c1c1e
Go to latest Published: Jul 1, 2022 License:Apache-2.0
Opens a new window with list of versions in this module.
Latest LatestThis package is not in the latest version of its module.
Opens a new window with license information.
Imports:33 Opens a new window with list of imports.
Imported by:0 Opens a new window with list of known importers.
Details
Validgo.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
Repository
Links
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
View Source
var ErrConfigReload =fmt.Errorf("configuration reload")
ErrConfigReload is an error returned to indicate that a reload ofthe configuration has been requested.
Functions¶
This section is empty.
Types¶
typeAPI¶
type API interface {// Start starts the API. This is blocking until the app has// been ended with Stop() or Destroy(). In this case a nil error// is returned. An ErrConfigReload error is returned if a// configuration reload has been requested.Start()error// Stop stops the API, some states may be kept intact such// that they can be reused after starting the API again.Stop()// Destroy is the same as Stop() but no state will be kept intact.Destroy()// Reload the configuration for the API. If there's an error the// previously loaded configuration is not altered.Reload()error}
The API interface is the implementation for the restreamer API.
Click to show internal directories.
Click to hide internal directories.