job

Documentation

Index

• Variables
• func Listen(name string, callback func()) (cancel func())
• func ListenBuffered(name string, callback func()) (cancel func())
• func Signal(name string)
• type ITrigger
• type Job
  • func Parse(data string) (j *Job, err error)
  • func (s *Job) Join(c context.Context) error
  • func (s *Job) Kill()
  • func (j *Job) Ready(ctx context.Context)
  • func (s *Job) Restart()
  • func (s *Job) Start() (w task.Worker, started bool)
  • func (s *Job) Status() task.StatusOrError
  • func (s *Job) Stop()
  • func (s *Job) Traverse(fn func(task.Worker) bool)
  • func (j *Job) UnmarshalJSON(data []byte) error
  • func (s *Job) Worker() task.Worker
• type LoggerOptions
• type Manifest
  • func (recipe *Manifest) Spawn() (j *Job, err error)
  • func (recipe *Manifest) SpawnAt(j *Job) (err error)
• type Trigger
  • func (t Trigger) MarshalJSON() ([]byte, error)
  • func (t *Trigger) UnmarshalJSON(data []byte) error
• type TriggerAlways
  • func (t TriggerAlways) Listen(callback func()) (remove func())
  • func (h *TriggerAlways) UnmarshalInline(text string) (err error)
• type TriggerAny
  • func (t TriggerAny) Listen(callback func()) (remove func())
• type TriggerBoot
  • func (t TriggerBoot) Listen(callback func()) (remove func())
  • func (h *TriggerBoot) UnmarshalInline(text string) (err error)
• type TriggerEvery
  • func (t TriggerEvery) Listen(callback func()) (remove func())
  • func (h *TriggerEvery) UnmarshalInline(text string) (err error)
• type TriggerNever
  • func (t TriggerNever) Listen(callback func()) (remove func())
  • func (h *TriggerNever) UnmarshalInline(text string) (err error)
• type TriggerOn
  • func (t TriggerOn) Listen(callback func()) (remove func())
  • func (h *TriggerOn) UnmarshalInline(text string) (err error)
  • func (h *TriggerOn) WithDefaults(i automarshal.ID)
• type TriggerOnce
  • func (t TriggerOnce) Listen(callback func()) (remove func())
  • func (h *TriggerOnce) UnmarshalInline(text string) (err error)
  • func (h *TriggerOnce) WithDefaults(i automarshal.ID)

Variables

var TriggerRegistry = automarshal.NewRegistry[Trigger, ITrigger]()

Functions

func Listen

func Listen(name string, callback func()) (cancel func())

func ListenBuffered

func ListenBuffered(name string, callback func()) (cancel func())

func Signal

func Signal(name string)

Types

type ITrigger

type ITrigger interface {
	Listen(callback func()) (remove func())
}

type Job

type Job struct {
	context.Context
	Manifest *Manifest
	ID       string
	Main     task.Task
	Cancel   context.CancelFunc
	Options  task.Options
	Logger   *clog.Logger
	Launch   *Trigger
	Drop     *Trigger

	Whiteboard atomic.Pointer[task.Whiteboard]
	// contains filtered or unexported fields
}

func Parse

func Parse(data string) (j *Job, err error)

func (*Job) Join

func (s *Job) Join(c context.Context) error

func (*Job) Kill

func (s *Job) Kill()

func (*Job) Ready

func (j *Job) Ready(ctx context.Context)

func (*Job) Restart

func (s *Job) Restart()

func (*Job) Start

func (s *Job) Start() (w task.Worker, started bool)

func (*Job) Status

func (s *Job) Status() task.StatusOrError

func (*Job) Stop

func (s *Job) Stop()

func (*Job) Traverse

func (s *Job) Traverse(fn func(task.Worker) bool)

func (*Job) UnmarshalJSON

func (j *Job) UnmarshalJSON(data []byte) error

func (*Job) Worker

func (s *Job) Worker() task.Worker

type LoggerOptions

type LoggerOptions = clog.Options

type Manifest

type Manifest struct {
	ID            string    `json:"id,omitempty"` // The task's ID.
	Main          task.Task `json:"main"`         // The main task to run.
	Launch        *Trigger  `json:"launch,omitempty"`
	Drop          *Trigger  `json:"drop,omitempty"`
	task.Options            // The task options.
	LoggerOptions           // The log configuration.
}

func (*Manifest) Spawn

func (recipe *Manifest) Spawn() (j *Job, err error)

func (*Manifest) SpawnAt

func (recipe *Manifest) SpawnAt(j *Job) (err error)

type Trigger

type Trigger struct {
	ITrigger
	automarshal.ID
}

func (Trigger) MarshalJSON

func (t Trigger) MarshalJSON() ([]byte, error)

func (*Trigger) UnmarshalJSON

func (t *Trigger) UnmarshalJSON(data []byte) error

type TriggerAlways

type TriggerAlways struct{}

func (TriggerAlways) Listen

func (t TriggerAlways) Listen(callback func()) (remove func())

func (*TriggerAlways) UnmarshalInline

func (h *TriggerAlways) UnmarshalInline(text string) (err error)

type TriggerAny

type TriggerAny struct {
	List []Trigger `json:"list"`
}

func (TriggerAny) Listen

func (t TriggerAny) Listen(callback func()) (remove func())

type TriggerBoot

type TriggerBoot struct {
}

func (TriggerBoot) Listen

func (t TriggerBoot) Listen(callback func()) (remove func())

func (*TriggerBoot) UnmarshalInline

func (h *TriggerBoot) UnmarshalInline(text string) (err error)

type TriggerEvery

type TriggerEvery struct {
	Duration util.ParsableDuration `json:"duration"`
}

func (TriggerEvery) Listen

func (t TriggerEvery) Listen(callback func()) (remove func())

func (*TriggerEvery) UnmarshalInline

func (h *TriggerEvery) UnmarshalInline(text string) (err error)

type TriggerNever

type TriggerNever struct{}

func (TriggerNever) Listen

func (t TriggerNever) Listen(callback func()) (remove func())

func (*TriggerNever) UnmarshalInline

func (h *TriggerNever) UnmarshalInline(text string) (err error)

type TriggerOn

type TriggerOn struct {
	Name string `json:"name"`
}

func (TriggerOn) Listen

func (t TriggerOn) Listen(callback func()) (remove func())

func (*TriggerOn) UnmarshalInline

func (h *TriggerOn) UnmarshalInline(text string) (err error)

func (*TriggerOn) WithDefaults

func (h *TriggerOn) WithDefaults(i automarshal.ID)

type TriggerOnce

type TriggerOnce struct {
	Name string `json:"name"`
}

func (TriggerOnce) Listen

func (t TriggerOnce) Listen(callback func()) (remove func())

func (*TriggerOnce) UnmarshalInline

func (h *TriggerOnce) UnmarshalInline(text string) (err error)

func (*TriggerOnce) WithDefaults

func (h *TriggerOnce) WithDefaults(i automarshal.ID)