crontab

Documentation

Index

• Variables
• type CompletedConfig
  • func (c CompletedConfig) New(ctx context.Context) (*CrontabSerivce, error)
  • func (c CompletedConfig) Validate() error
• type Config
  • func NewConfig(options ...ConfigOption) *Config
  • func (o *Config) ApplyOptions(options ...ConfigOption) *Config
  • func (c *Config) Complete() CompletedConfig
• type ConfigOption
  • func WithViper(v *viper.Viper) ConfigOption
• type ConfigOptionFunc
• type Crontab
  • func (*Crontab) Descriptor() ([]byte, []int)
  • func (x *Crontab) GetCheckInterval() *duration.Duration
  • func (x *Crontab) GetEnabled() bool
  • func (*Crontab) ProtoMessage()
  • func (x *Crontab) ProtoReflect() protoreflect.Message
  • func (x *Crontab) Reset()
  • func (x *Crontab) String() string
• type CrontabSerivce
  • func NewCrontabSerivce(checkInterval time.Duration) *CrontabSerivce
  • func (c *CrontabSerivce) Register(f func(context.Context, *logrus.Entry) error)
  • func (c *CrontabSerivce) Run(ctx context.Context) error
  • func (c *CrontabSerivce) Serve(ctx context.Context) error
  • func (c *CrontabSerivce) Shutdown()
• type EmptyConfigOption

Variables

var File_pkg_crontab_crontab_proto protoreflect.FileDescriptor

Types

type CompletedConfig

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

CompletedConfig ...

func (CompletedConfig) New

func (c CompletedConfig) New(ctx context.Context) (*CrontabSerivce, error)

func (CompletedConfig) Validate

func (c CompletedConfig) Validate() error

Validate checks Config.

type Config

type Config struct {
	Proto Crontab

	Validator *validator.Validate
	// contains filtered or unexported fields
}

Config ...

func NewConfig

func NewConfig(options ...ConfigOption) *Config

NewConfig returns a Config struct with the default values

func (*Config) ApplyOptions

func (o *Config) ApplyOptions(options ...ConfigOption) *Config

func (*Config) Complete

func (c *Config) Complete() CompletedConfig

Complete fills in any fields not set that are required to have valid data and can be derived from other fields. If you're going to `ApplyOptions`, do that first. It's mutating the receiver.

type ConfigOption

type ConfigOption interface {
	// contains filtered or unexported methods
}

A ConfigOption sets options.

func WithViper

func WithViper(v *viper.Viper) ConfigOption

type ConfigOptionFunc

type ConfigOptionFunc func(*Config)

ConfigOptionFunc wraps a function that modifies Client into an implementation of the ConfigOption interface.

type Crontab

type Crontab struct {
	Enabled       bool               `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	CheckInterval *duration.Duration `protobuf:"bytes,4,opt,name=check_interval,json=checkInterval,proto3" json:"check_interval,omitempty"`
	// contains filtered or unexported fields
}

func (*Crontab) Descriptor

func (*Crontab) Descriptor() ([]byte, []int)

Deprecated: Use Crontab.ProtoReflect.Descriptor instead.

func (*Crontab) GetCheckInterval

func (x *Crontab) GetCheckInterval() *duration.Duration

func (*Crontab) GetEnabled

func (x *Crontab) GetEnabled() bool

func (*Crontab) ProtoMessage

func (*Crontab) ProtoMessage()

func (*Crontab) ProtoReflect

func (x *Crontab) ProtoReflect() protoreflect.Message

func (*Crontab) Reset

func (x *Crontab) Reset()

func (*Crontab) String

func (x *Crontab) String() string

type CrontabSerivce

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

Crontab ...

func NewCrontabSerivce

func NewCrontabSerivce(
	checkInterval time.Duration,
) *CrontabSerivce

NewCrontab ...

func (*CrontabSerivce) Register

func (c *CrontabSerivce) Register(f func(context.Context, *logrus.Entry) error)

Register ...

func (*CrontabSerivce) Run

func (c *CrontabSerivce) Run(ctx context.Context) error

Run will initialize the backend. It must not block, but may run go routines in the background.

func (*CrontabSerivce) Serve

func (c *CrontabSerivce) Serve(ctx context.Context) error

Serve ...

func (*CrontabSerivce) Shutdown

func (c *CrontabSerivce) Shutdown()

Shutdown ...

type EmptyConfigOption

type EmptyConfigOption struct{}

EmptyConfigOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.