service

Documentation

Index

• type Command
• type NopCommand
  • func (c *NopCommand) ExecuteContext(ctx context.Context) error
• type NopRouter
  • func (r *NopRouter) RunWithContext(ctx context.Context) error
• type Router
• type Runner
  • func NewCommandRunner(command Command) Runner
  • func NewCustomRunner(fn RunnerRunFn) Runner
  • func NewRouterRunner(router Router) Runner
• type RunnerRunFn
• type Service
  • func New(ctn *di.Container, log *zap.Logger) *Service
  • func (s *Service) RegisterRunner(runners ...Runner)
  • func (s *Service) Run(ctx context.Context) int

Types

type Command

type Command interface {
	ExecuteContext(ctx context.Context) error
}

Command is a CLI command interface. The cobra.Command fits, see: https://github.com/spf13/cobra

type NopCommand

type NopCommand struct {
	Executed bool
}

NopCommand is a Command doing nothing.

func (*NopCommand) ExecuteContext

func (c *NopCommand) ExecuteContext(ctx context.Context) error

type NopRouter

type NopRouter struct{}

NopRouter is a Router doing nothing.

func (*NopRouter) RunWithContext

func (r *NopRouter) RunWithContext(ctx context.Context) error

type Router

type Router interface {
	RunWithContext(ctx context.Context) error
}

Router interface. The graceful.Graceful gin's wrapper fits: https://github.com/gin-contrib/graceful.

type Runner

type Runner interface {
	// Run runs the Runner.
	Run(ctx context.Context, ctn *di.Container) error
}

Runner is an interface for a service's runner, such as gin or something else.

func NewCommandRunner

func NewCommandRunner(command Command) Runner

NewCommandRunner creates new CLI command Service Runner.

func NewCustomRunner

func NewCustomRunner(fn RunnerRunFn) Runner

NewCustomRunner returns a Runner executing the custom function.

func NewRouterRunner

func NewRouterRunner(router Router) Runner

NewRouterRunner creates new Runner executing the given http Router.

type RunnerRunFn

type RunnerRunFn func(ctx context.Context, ctn *di.Container) error

RunnerRunFn is a custom function to run in runner.

type Service

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

Service is an application based on core2go kit.

func New

func New(ctn *di.Container, log *zap.Logger) *Service

New creates new Service instance with the specified DI container.

func (*Service) RegisterRunner

func (s *Service) RegisterRunner(runners ...Runner)

RegisterRunner register the Runner instances in the Service.

func (*Service) Run

func (s *Service) Run(ctx context.Context) int

Run starts the Service. Returns the exist code.