cCommand

Documentation

Index

• Constants
• Variables
• type CommandComponent
  • func (i *CommandComponent) Inject(instance any) bool
  • func (i *CommandComponent) InjectConf(config cComponents.ConfigInterface) bool
  • func (i *CommandComponent) Listen() []*cComponents.ConfigListener
  • func (i *CommandComponent) Load()
• type CommandConf
  • func (i *CommandConf) ConfigName() string
• type CommandConf_Command
  • func (i *CommandConf_Command) Incr()
  • func (i *CommandConf_Command) Runnable() bool
  • func (i *CommandConf_Command) SetID(id cron.EntryID)
  • func (i *CommandConf_Command) TryLock() bool
  • func (i *CommandConf_Command) Unlock()
• type CommandContainer
  • func (i *CommandContainer) Get(name string) any
  • func (i *CommandContainer) Is(instance any) bool
  • func (i *CommandContainer) Range(f func(instance any))
  • func (i *CommandContainer) Remove(name string) bool
  • func (i *CommandContainer) Save(instance any) bool
  • func (i *CommandContainer) UpdateCommands()
• type CommandInterface
• type CommandMode

Constants

const (
	CommandConfigName = "CommandConf"
)

Variables

var Component = &CommandComponent{}

Types

type CommandComponent

type CommandComponent struct{}

func (*CommandComponent) Inject

func (i *CommandComponent) Inject(instance any) bool

func (*CommandComponent) InjectConf

func (i *CommandComponent) InjectConf(config cComponents.ConfigInterface) bool

func (*CommandComponent) Listen

func (i *CommandComponent) Listen() []*cComponents.ConfigListener

func (*CommandComponent) Load

func (i *CommandComponent) Load()

type CommandConf

type CommandConf struct {
	Enable      bool                   `json:"enable"`
	CommandLine bool                   `json:"command_line"`
	Commands    []*CommandConf_Command `json:"commands"`
}

func (*CommandConf) ConfigName

func (i *CommandConf) ConfigName() string

type CommandConf_Command

type CommandConf_Command struct {

	// 配置项
	Mode    CommandMode `json:"mode"`    // 执行模式
	Instant bool        `json:"instant"` // 是否立即执行, sync 模式忽略此参数, 异步模式先执行一次, 再启动定时任务
	Wait    int         `json:"wait"`    // 每次执行等待时长
	Try     int         `json:"try"`     // 执行次数
	Cron    string      `json:"cron"`    // 定时器
	App     string      `json:"app"`
	Command string      `json:"command"`
	Method  string      `json:"method"`
	Options []string    `json:"options"` // 调用参数, 按顺序传入
	// contains filtered or unexported fields
}

func (*CommandConf_Command) Incr

func (i *CommandConf_Command) Incr()

func (*CommandConf_Command) Runnable

func (i *CommandConf_Command) Runnable() bool

func (*CommandConf_Command) SetID

func (i *CommandConf_Command) SetID(id cron.EntryID)

func (*CommandConf_Command) TryLock

func (i *CommandConf_Command) TryLock() bool

func (*CommandConf_Command) Unlock

func (i *CommandConf_Command) Unlock()

type CommandContainer

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

func (*CommandContainer) Get

func (i *CommandContainer) Get(name string) any

func (*CommandContainer) Is

func (i *CommandContainer) Is(instance any) bool

func (*CommandContainer) Range

func (i *CommandContainer) Range(f func(instance any))

func (*CommandContainer) Remove

func (i *CommandContainer) Remove(name string) bool

func (*CommandContainer) Save

func (i *CommandContainer) Save(instance any) bool

func (*CommandContainer) UpdateCommands

func (i *CommandContainer) UpdateCommands()

type CommandInterface

type CommandInterface interface {
	CommandName() (app, name string)
}

type CommandMode

type CommandMode int

const (
	CommandMode_Single CommandMode = iota // 异步串行
	CommandMode_Multi                     // 异步并行
	CommandMode_Sync                      // 同步单次执行
	CommandMode_Line                      // 命令行执行
)