https://github.com/icpd/weightask

Tasks with weights
https://github.com/icpd/weightask

Last synced: 11 days ago
JSON representation

Tasks with weights

• Host: GitHub
• URL: https://github.com/icpd/weightask
• Owner: icpd
• License: mit
• Created: 2023-08-10T15:29:49.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-16T15:48:44.000Z (11 months ago)
• Last Synced: 2024-10-10T22:35:14.694Z (27 days ago)
• Language: Go
• Homepage:
• Size: 27.3 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Weight Task

## Introduction

This Go-based project provides a system for managing and executing tasks based on their weight. Specifically, it concurrently executes a collection of tasks and returns the result of the one with the highest weight.

## How It Works

In the context of the Weight Task Processor, a "Task" is defined as any operation with a defined Weight and an Execute function. Here's what these mean:

- **Weight**: An integer indicating relative importance. Higher numbers indicate higher weight.  

- **PerformTask**: The function that performs the given task.    

Task processing involves two major steps:  

1. **Adding Tasks**: Tasks to be executed are added into the Weight Task Processor using the AddTask method. Each task is an instance of a struct that implements the Task interface.

2. **Processing Tasks**: The ProcessTasks function executes all tasks concurrently and retrieves the result from the task with the highest weight. If multiple tasks share the same highest weight, it will return the first result.  

## How to Use

Here's a basic example of how to use the Weight Task Processor:  

1. Implement the Task interface in your task struct.

2. Initiate a new instance of NewTaskController via NewTaskController().

3. Add tasks into the Tasker via AddTask.

4. Call the ProcessTasks method to begin executing tasks. This will return the result of the highest weight task that is valid. If no tasks are valid, it will return an error.

```go

package main

import (

	"context"

	"fmt"

	"time"

	"github.com/icpd/weightask"

)

type MyTask struct {

	weight int

	v      string

}

func (t MyTask) Weight() int {

	return t.weight

}

func (t MyTask) PerformTask() (any, error) {

	time.Sleep(time.Second * time.Duration(t.weight))

	return t.v, nil

}

func main() {

	tc := weightask.NewTaskController()

	// add tasks

	tc.AddTask(&MyTask{weight: 1, v: "task 1"})

	tc.AddTask(&MyTask{weight: 2, v: "task 2"})

	tc.AddTask(&MyTask{weight: 3, v: "task 3"})

	// process tasks

	res, err := tc.ProcessTasks(context.Background())

	if err != nil {

		fmt.Println("Error:", err)

		return

	}

	fmt.Println("Result:", res) // Result: task 3

}

```