onstartup

Documentation

Index

• type Option
  • func WithCaption(value string) Option
  • func WithReadyTimeout(value time.Duration) Option
• type Process
  • func NewProcess(job mrworker.Job, opts ...Option) *Process
  • func (p *Process) Caption() string
  • func (p *Process) ReadyTimeout() time.Duration
  • func (p *Process) Shutdown(ctx context.Context) error
  • func (p *Process) Start(ctx context.Context, ready func()) error

Types

type Option

type Option func(p *Process)

Option - настройка объекта Process.

func WithCaption

func WithCaption(value string) Option

WithCaption - устанавливает опцию caption для Process.

func WithReadyTimeout

func WithReadyTimeout(value time.Duration) Option

WithReadyTimeout - устанавливает опцию readyTimeout для Process.

type Process

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

Process - сервис выполнения работы в момент старта приложения. Его полезно использовать, когда работу нужно выполнить после гарантированного запуска остальных процессов.

func NewProcess

func NewProcess(job mrworker.Job, opts ...Option) *Process

NewProcess - создаёт объект Process.

func (*Process) Caption

func (p *Process) Caption() string

Caption - возвращает название сервиса.

func (*Process) ReadyTimeout

func (p *Process) ReadyTimeout() time.Duration

ReadyTimeout - возвращает максимальное время, за которое должен быть запущен сервис.

func (*Process) Shutdown

func (p *Process) Shutdown(ctx context.Context) error

Shutdown - корректная остановка сервиса выполнения работы при старте приложения.

func (*Process) Start

func (p *Process) Start(ctx context.Context, ready func()) error

Start - запуск сервиса выполнения работы при старте приложения.