lightning

Documentation

Index

• type Lightning
  • func New(globalCfg *config.GlobalConfig) *Lightning
  • func (l *Lightning) GoServe() error
  • func (l *Lightning) RunOnce(taskCtx context.Context, taskCfg *config.Config, glue glue.Glue) error
  • func (l *Lightning) RunServer() error
  • func (l *Lightning) Stop()

Types

type Lightning

type Lightning struct {
	// contains filtered or unexported fields
}

func New

func New(globalCfg *config.GlobalConfig) *Lightning

func (*Lightning) GoServe

func (l *Lightning) GoServe() error

func (*Lightning) RunOnce

func (l *Lightning) RunOnce(taskCtx context.Context, taskCfg *config.Config, glue glue.Glue) error

RunOnce is used by binary lightning and host when using lightning as a library.

• for binary lightning, taskCtx could be context.Background which means taskCtx wouldn't be canceled directly by its cancel function, but only by Lightning.Stop or HTTP DELETE using l.cancel. and glue could be nil to let lightning use a default glue later.
• for lightning as a library, taskCtx could be a meaningful context that get canceled outside, and glue could be a caller implemented glue.

func (*Lightning) RunServer

func (l *Lightning) RunServer() error

func (*Lightning) Stop

func (l *Lightning) Stop()