throttle

README

Throttle

A golang package that gives you the ability to throttle concurrent functions around a limited resource.

Package Usage

import (
  "fmt"
  "time"

  "github.com/prophittcorey/throttle"
)

func main() {
	executor := throttle.New(runtime.NumCPU())

	start := time.Now()

	for i := 1; i < 100; i++ {
		executor.Run(func() {
			time.Sleep(1 * time.Second)
		})
	}

	executor.Wait()

	fmt.Printf("Finished in %s\n", time.Since(start))
}

License

The source code for this repository is licensed under the MIT license, which you can find in the LICENSE file.

Documentation

Overview

Package throttle implements a data structure to help limit concurrency around a fixed resource limit without excessive blocking.

Index

• type Executor
  • func New(resourcelimit int) *Executor
  • func (q *Executor) Run(f func())

Types

type Executor

type Executor struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

Executor is the monitor for executing functions. The executor will ensure only a fixed number of functions are fun concurrently and will block as needed.

func New

func New(resourcelimit int) *Executor

New creates a new Executor that is ready to be used.

func (*Executor) Run

func (q *Executor) Run(f func())

Run executes a function and ensures concurrency is throttled.