cron

Documentation

Index

• Constants
• type Option
  • func Log(opts ...log.ServerOption) Option
  • func WithConfig(config config.Config) Option
  • func WithServiceName(serviceName string) Option
• type Server
  • func New(name string, opts ...Option) *Server
  • func (e *Server) AddJob(jobs ...*xcron.Job) (keys []string, err error)
  • func (e *Server) Attempt() bool
  • func (e *Server) Config(cfg config.Config)
  • func (e *Server) Endpoint() *url.URL
  • func (e *Server) Group(group string, middlewares ...middleware.Middleware) *engine.RouterGroup
  • func (e *Server) Handle(path string, obj interface{})
  • func (e *Server) Name() string
  • func (e *Server) Options(opts ...Option)
  • func (e *Server) RemoveJob(key ...string)
  • func (s *Server) ServiceName() string
  • func (e *Server) Start(ctx context.Context) (err error)
  • func (e *Server) Stop(ctx context.Context) (err error)
  • func (e *Server) Type() string
  • func (e *Server) Use(middlewares ...middleware.Middleware)

Constants

const Type string = "cron"

Types

type Option

type Option func(*options)

Option 参数设置类型

func Log

func Log(opts ...log.ServerOption) Option

Log 设置日志配置

func WithConfig

func WithConfig(config config.Config) Option

WithConfig 设置Config

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceName 设置服务名称

type Server

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

func New

func New(name string, opts ...Option) *Server

New 实例化

func (*Server) AddJob

func (e *Server) AddJob(jobs ...*xcron.Job) (keys []string, err error)

func (*Server) Attempt

func (e *Server) Attempt() bool

Attempt 判断是否可以启动

func (*Server) Config

func (e *Server) Config(cfg config.Config)

func (*Server) Endpoint

func (e *Server) Endpoint() *url.URL

func (*Server) Group

func (e *Server) Group(group string, middlewares ...middleware.Middleware) *engine.RouterGroup

func (*Server) Handle

func (e *Server) Handle(path string, obj interface{})

func (*Server) Name

func (e *Server) Name() string

func (*Server) Options

func (e *Server) Options(opts ...Option)

Options 设置参数

func (*Server) RemoveJob

func (e *Server) RemoveJob(key ...string)

func (*Server) ServiceName

func (s *Server) ServiceName() string

ServiceName 服务名称

func (*Server) Start

func (e *Server) Start(ctx context.Context) (err error)

Start 开始

func (*Server) Stop

func (e *Server) Stop(ctx context.Context) (err error)

Shutdown 停止

func (*Server) Type

func (e *Server) Type() string

func (*Server) Use

func (e *Server) Use(middlewares ...middleware.Middleware)