https://github.com/VividCortex/multitick

A multiplexor for aligned time.Time tickers in Go
https://github.com/VividCortex/multitick

Last synced: 3 months ago
JSON representation

A multiplexor for aligned time.Time tickers in Go

• Host: GitHub
• URL: https://github.com/VividCortex/multitick
• Owner: VividCortex
• License: mit
• Created: 2013-12-10T16:47:26.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-12-12T11:02:17.000Z (about 1 year ago)
• Last Synced: 2024-08-03T15:06:05.839Z (7 months ago)
• Language: Go
• Homepage:
• Size: 21.5 KB
• Stars: 70
• Watchers: 18
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - multitick - A multiplexor for aligned time.Time tickers in Go - ★ 57 (Utilities)
• awesome-go-extra - multitick - 12-10T16:47:26Z|2021-04-26T21:18:13Z| (Utilities / Fail injection)

README

        
multitick

=========

![build](https://github.com/VividCortex/multitick/workflows/build/badge.svg)

This package is a wrapper around a single `time.Ticker` in the Go language, which

provides a way for lots of listeners to subscribe to a single set of ticks.  If

a subscriber is busy and can't receive a tick, it will be discarded; the

implementation is non-blocking.  Additionally, ticks can be aligned to a

specific boundary easily, which eliminates annoying code from your programs.

We use this functionality at [VividCortex](https://vividcortex.com/) to help

coordinate worker goroutines, driving them by passing them ticker channels.

This makes the workers more testable, by avoiding nondeterministic use of

`time.Tick()` inside them.

Documentation

=============

Please read the generated [package

documentation](http://godoc.org/github.com/VividCortex/multitick).

Getting Started

===============

Install multitick in the usual way:

    go get github.com/VividCortex/multitick

And import it as usual:

    import (

        "github.com/VividCortex/multitick"

    )

To use multitick, create a ticker with the desired interval and offset.

For example, to create a once-per-second ticker that will send at 750

milliseconds past the clock tick,

    tick := multitick.NewTicker(time.Second, time.Millisecond*750)

If you want the ticker to start immediately instead of waiting, you can

pass a negative number as the second parameter.

Now subscribe to ticks. Here's an example of starting worker routines with

ticker channels:

    go someFunc(tick.Subscribe())

    go otherFunc(tick.Subscribe())

Contributing

============

We only accept pull requests for minor fixes or improvements. This includes:

* Small bug fixes

* Typos

* Documentation or comments

Please open issues to discuss new features. Pull requests for new features will be rejected,

so we recommend forking the repository and making changes in your fork for your use case.

License

=======

Copyright (c) 2013 VividCortex, licensed under the MIT license.

Please see the LICENSE file for details.