go-tools

module
v0.0.0-...-3aa5266 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2019 License: MIT

README

go-tools

A collection of tools for Golang, focusing on concurrency and goroutines

Godoc Go Report Card Build Status License

The multithreading library currently supports a ThreadTracker struct that allows you to easily manage goroutines.

  • Create new goroutines.
  • Wait for all goroutines to finish.
  • Set deferred functions to be executed after goroutines finish.
  • Easily handle panics inside goroutines with a panic handler.
  • Stop the threadTracker from receiving new functions.
  • Fetch the number of currently active goroutines.

Install

Install the package with:

go get github.com/nikhilsaraf/go-tools/multithreading

Import it with:

import "github.com/nikhilsaraf/go-tools/multithreading"

and use multithreading as the package name inside the code.

Example

package main

import (
  "fmt"
  "github.com/nikhilsaraf/go-tools/multithreading"
)

func main() {
  // create thread tracker instance
  threadTracker := multithreading.MakeThreadTracker()

  // start thread functions
  for i := 0; i < 10; i++ {
    err := threadTracker.TriggerGoroutine(func(inputs []interface{}) {
      // pass `i` as a value to the goroutine and read from `inputs`.
      // this is needed to "bind" the variable to this goroutine.
      value := inputs[0].(int)
      
      fmt.Printf("Goroutine #%d\n", value)
    }, []interface{}{i})

    if err != nil {
      panic(err)
    }
  }

  // wait for all threads to finish
  threadTracker.Wait()
  fmt.Printf("done\n")
}

Sample Output:

Goroutine #1
Goroutine #2
Goroutine #9
Goroutine #0
Goroutine #3
Goroutine #7
Goroutine #6
Goroutine #4
Goroutine #8
Goroutine #5
done

Test Examples

thread_tracker_test.go

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL