goccm

package module
v1.1.3 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2023 License: MIT Imports: 1 Imported by: 38

README

Golang Concurrency Manager

run tests codecov goreportcard

Golang Concurrency Manager package limits the number of goroutines that are allowed to run concurrently.

Installation

Run the following command to install this package:

$ go get -u github.com/zenthangplus/goccm
Example
package main

import (
    "fmt"
    "github.com/zenthangplus/goccm"
    "time"
)

func main() {
    // Limit 3 goroutines to run concurrently.
    c := goccm.New(3)

    for i := 1; i <= 10; i++ {

        // This function has to call before any goroutine
        c.Wait()

        go func(i int) {
            fmt.Printf("Job %d is running\n", i)
            time.Sleep(2 * time.Second)

            // This function has to when a goroutine has finished
            // Or you can use `defer c.Done()` at the top of goroutine.
            c.Done()
        }(i)
    }

    // This function has to call to ensure all goroutines have finished
    // after close the main program.
    c.WaitAllDone()
}
List of supported functions
package main

import "github.com/zenthangplus/goccm"

func main() {
    // Create the concurrency manager
    // The first argument is the maximum number of goroutines to run concurrently.
    c := goccm.New(10)

    // Wait until a slot is available for the new goroutine.
    c.Wait()

    // Mark a goroutine as finished
    c.Done()

    // Wait for all goroutines are done
    c.WaitAllDone()

    // Close the manager manually
    c.Close()

    // Returns the number of goroutines which are running
    c.RunningCount()
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(maxGoRoutines int) *concurrencyManager

New concurrencyManager

Types

type ConcurrencyManager

type ConcurrencyManager interface {
	// Wait until a slot is available for the new goroutine.
	Wait()

	// Done Mark a goroutine as finished
	Done()

	// Close the manager manually
	Close()

	// WaitAllDone Wait for all goroutines are done
	WaitAllDone()

	// RunningCount Returns the number of goroutines which are running
	RunningCount() int32
}

ConcurrencyManager Interface

Jump to

Keyboard shortcuts

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