https://github.com/andrewhamon/quartz

⌚️ Crystal clear timers
https://github.com/andrewhamon/quartz

Last synced: 2 months ago
JSON representation

⌚️ Crystal clear timers

• Host: GitHub
• URL: https://github.com/andrewhamon/quartz
• Owner: andrewhamon
• License: mit
• Created: 2016-12-12T05:19:49.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-12T06:48:01.000Z (almost 8 years ago)
• Last Synced: 2024-06-22T02:09:25.115Z (3 months ago)
• Language: Crystal
• Homepage:
• Size: 5.86 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - quartz - Crystal clear timers (Scheduling)

README

        
# Quartz [![Build Status](https://travis-ci.org/andrewhamon/quartz.svg?branch=master)](https://travis-ci.org/andrewhamon/quartz)

Dead simple timers in Crystal

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  quartz:

    github: andrewhamon/quartz

    version: ~> 0.1.1

```

## Usage

```crystal

require "quartz"

# Execute a block after 3 seconds

Quartz::Timer.new(3) do

  puts "3 seconds"

end

# Execute block every second

Quartz::PeriodicTimer.new(1) do

  puts "tick"

end

# Make sure you yield in some way so that the timers get scheduled

sleep(5)

```

## WARNING: Make sure you understand Crystal's concurrency model

Crystal is concurrent, but not (yet) parallel. Crystal fibers don't run immediately after being spawned, the main fiber must yield control, either explicitly by sleeping or implicitly by doing blocking IO.

See [the Crystal docs](https://crystal-lang.org/docs/guides/concurrency.html) for a more detailed explanation.

This has a number of consequences for timers such as this library:

- The countdown for a timer doesn't start when the timer is instantiated, only when the fiber it spawns runs. This could be an arbitrarily long time after the timer is instantiated.

- The block you pass your timer might never get called, if the main fiber terminates too early or if it never yields control.

- Different timers might fire in a different order than expected. A shorter timer could fire after a longer timer

- Timers are not precise.

tl;dr if you have precise timing requirements, you should look elsewhere

## Contributing

1. Fork it ( https://github.com/andrewhamon/quartz/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request to the develop branch

## Contributors

- [andrewhamon](https://github.com/andrewhamon) Andrew Hamon - creator, maintainer