2
0
mirror of https://github.com/hibiken/asynq.git synced 2024-12-25 15:22:18 +08:00

[ci skip] Update readme and changelog

This commit is contained in:
Ken Hibino 2020-02-12 18:11:59 -08:00
parent cd55a0e316
commit bf31fcc3ec
3 changed files with 22 additions and 2 deletions

View File

@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
### Changed
- `Handler` interface has changed. `ProcessTask` method takes two arguments `context.Context` and `*asynq.Task`
### Added
- `Client` can optionally schedule task with `asynq.Timeout(duration)` to specify timeout duration for task. Default is no timeout.
- `asynqmon cancel [task id]` will send a cancelation signal to the goroutine processing the speicified task.
## [0.3.0] - 2020-02-04 ## [0.3.0] - 2020-02-04
### Added ### Added

View File

@ -11,8 +11,6 @@ It is backed by Redis and it is designed to have a low barrier to entry. It shou
**Important Note**: Current major version is zero (v0.x.x) to accomodate rapid development and fast iteration while getting early feedback from users. The public API could change without a major version update before v1.0.0 release. **Important Note**: Current major version is zero (v0.x.x) to accomodate rapid development and fast iteration while getting early feedback from users. The public API could change without a major version update before v1.0.0 release.
[Quick Tour of Asynq (YouTube video)](https://www.youtube.com/watch?v=FzMJdddNcmA&t=62s)
![Gif](/docs/assets/demo.gif) ![Gif](/docs/assets/demo.gif)
## Installation ## Installation

View File

@ -13,6 +13,7 @@ Asynqmon is a command line tool to monitor the tasks managed by `asynq` package.
- [Enqueue](#enqueue) - [Enqueue](#enqueue)
- [Delete](#delete) - [Delete](#delete)
- [Kill](#kill) - [Kill](#kill)
- [Cancel](#cancel)
- [Config File](#config-file) - [Config File](#config-file)
## Installation ## Installation
@ -133,6 +134,18 @@ Example:
Running the above command will move all **Retry** tasks to **Dead** state. Running the above command will move all **Retry** tasks to **Dead** state.
### Cancel
Command `cancel` takes a task ID and sends a cancelation signal to the goroutine processing the specified task.
You can obtain the task ID by running `ls` command.
The task should be in "in-progress" state.
Handler implementation needs to be context aware in order to actually stop processing.
Example:
asynqmon cancel bnogo8gt6toe23vhef0g
## Config File ## Config File
You can use a config file to set default values for the flags. You can use a config file to set default values for the flags.