deferred_task

package module
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2026 License: MIT Imports: 12 Imported by: 0

README

Compogo Deferred Task

Go Reference

Менеджер отложенных задач для фреймворка Compogo.

Позволяет выполнять задачи после заданной задержки с двумя стратегиями:

  • One — однократное выполнение
  • Repeated — периодическое выполнение (через Repeater)

Установка

go get github.com/Compogo/deferred_task

Быстрый старт

package main

import (
    "context"
    "time"

    "github.com/Compogo/compogo"
	deferredTask "github.com/Compogo/deferred_task"
)

func main() {
    app := compogo.NewApp("myapp",
        compogo.WithComponents(&deferredTask.Component),
    )

    app.AddComponents(&compogo.Component{
        Name: "my_service",
        Init: compogo.StepFunc(func(container compogo.Container) error {
            return container.Invoke(func(m deferredTask.Manager) error {
                // Задача выполнится через 5 секунд (один раз)
                return m.AddTask(deferred_task.NewTask("cleanup", 5*time.Second, func(ctx context.Context) error {
					println("Cleanup done!")
					return nil
				}, deferredTask.One))
            })
        }),
    })

    if err := app.Serve(); err != nil {
        panic(err)
    }
}

Использование

Однократная задача (One)
task := deferred_task.NewTask("once", 10*time.Second, func(ctx context.Context) error {
    // Выполнится через 10 секунд один раз
    return nil
}, deferred_task.One)

m.AddTask(task)
Периодическая задача (Repeated)
task := deferred_task.NewTask("repeated", 5*time.Second, func(ctx context.Context) error {
    // Выполнится через 5 секунд, затем будет повторяться каждые 5 секунд
    return nil
}, deferred_task.Repeated)

m.AddTask(task)
Удаление задачи
// По объекту
m.RemoveTask(task)

// По имени
m.RemoveTaskByName("cleanup")
Проверка наличия задачи
if m.HasTask(task) {
    // задача существует
}

if m.HasTaskByName("cleanup") {
    // задача с именем "cleanup" существует
}
Добавление нескольких задач
m.AddTasks(task1, task2, task3)

Graceful shutdown

Менеджер автоматически отменяет все ожидающие задачи при завершении приложения через Stop-компонент.

Стратегии

One

Задача выполняется один раз после задержки.

[Добавление] → [Ожидание N секунд] → [Выполнение] → [Готово]
Repeated

Задача выполняется один раз после задержки, затем добавляется в Repeater для периодического выполнения.

[Добавление] → [Ожидание N секунд] → [Выполнение] → [Повторять каждые N секунд]

Зависимости

Лицензия

MIT License

Copyright (c) 2026 Compogo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Component = compogo.Component{
	Dependencies: compogo.Components{
		&runner.Component,
		&repeater.Component,
	},
	Init: compogo.StepFunc(func(container compogo.Container) error {
		return container.Provides(
			newManager,
			func(m *manager) Manager { return m },
		)
	}),
	Stop: compogo.StepFunc(func(container compogo.Container) error {
		return container.Invoke(func(m Manager) error {
			return m.Close()
		})
	}),
}

Component — компонент менеджера отложенных задач для Compogo. Регистрирует менеджер в DI-контейнере.

Пример:

app.AddComponents(&deferred_task.Component)

var m deferred_task.Manager
container.Invoke(func(manager deferred_task.Manager) { m = manager })

task := deferred_task.NewTask("cleanup", time.Minute, cleanupFunc, deferred_task.One)
m.AddTask(task)

Functions

This section is empty.

Types

type Manager

type Manager interface {
	io.Closer
	AddTasks(...*Task) error
	AddTask(*Task) error
	RemoveTaskByName(string) error
	RemoveTask(*Task) error
	HasTask(*Task) bool
	HasTaskByName(string) bool
}

Manager — менеджер отложенных задач. Управляет задачами, которые должны быть выполнены после задержки.

Поддерживает:

  • Добавление и удаление задач
  • Однократное и повторное выполнение
  • Graceful shutdown через io.Closer

type Strategy

type Strategy uint8

Strategy — стратегия выполнения отложенной задачи.

const (
	// One — задача выполняется один раз после задержки.
	One Strategy = iota

	// Repeated — задача выполняется повторно через repeater.
	Repeated
)

type Task

type Task struct {
	*repeater.Task
	// contains filtered or unexported fields
}

Task — отложенная задача. Расширяет repeater.Task, добавляя стратегию выполнения (однократно или повторно).

func NewTask

func NewTask(name string, delay time.Duration, processFunc runner.ProcessFunc, strategy Strategy, middlewares ...runner.Middleware) *Task

NewTask создаёт новую отложенную задачу.

Параметры:

  • name — имя задачи
  • delay — задержка перед выполнением
  • processFunc — функция выполнения
  • strategy — стратегия (One или Repeated)
  • middlewares — опциональные middleware

Пример:

task := deferred_task.NewTask("cleanup", time.Minute, func(ctx context.Context) error {
    // очистка кэша
    return nil
}, deferred_task.One)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL