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 of the configuration has been requested.
Functions ¶
This section is empty.
Types ¶
type API ¶
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.