Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (39 sloc) 1.54 KB
// Package bgworker provides interface for bgworker plugins. A bgworker plugin
// has to implement the following function.
// NewBgWorker(config map[string]interface{}) (BgWorker, error)
// Background workers run under the marketstore server by implementing the
// interface, started at the very beginning of the server lifecycle before the
// query interface is started, but internal state shuold be fledged. The server
// does not handle panics that happen within the plugin. A plugin can recover
// from panics, but be careful not to screw the server state if touching
// internal API. It is often better to just let it go.
// Configuration is as follows.
// bgworkers:
// - module:
// name: datafeed
// config: <according to the plulgin>
package bgworker
import "fmt"
// BgWorker implements Run(). It will be running under a separate goroutine.
type BgWorker interface {
// SymbolLoader is an interface to retrieve symbol object from plugin
type SymbolLoader interface {
LoadSymbol(symbolName string) (interface{}, error)
// Load loads new BgWorker instance using loader, and initializes it with config.
func Load(loader SymbolLoader, config map[string]interface{}) (BgWorker, error) {
symbolName := "NewBgWorker"
sym, err := loader.LoadSymbol(symbolName)
if err != nil {
return nil, fmt.Errorf("Unable to load %s", symbolName)
newFunc, ok := sym.(func(map[string]interface{}) (BgWorker, error))
if !ok {
return nil, fmt.Errorf("%s does not comply function spec", symbolName)
return newFunc(config)
You can’t perform that action at this time.