https://github.com/metalim/csync

Go sync package with cancellable context
https://github.com/metalim/csync

Last synced: 6 days ago
JSON representation

Go sync package with cancellable context

• Host: GitHub
• URL: https://github.com/metalim/csync
• Owner: metalim
• License: mit
• Created: 2023-07-27T17:48:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-03T18:07:57.000Z (over 1 year ago)
• Last Synced: 2023-09-04T19:08:44.504Z (over 1 year ago)
• Language: Go
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# csync

[![go test workflow](https://github.com/metalim/csync/actions/workflows/tests.yml/badge.svg)](https://github.com/metalim/csync/actions/workflows/tests.yml)

[![go report](https://goreportcard.com/badge/github.com/metalim/csync)](https://goreportcard.com/report/github.com/metalim/csync)

[![codecov](https://codecov.io/gh/metalim/csync/graph/badge.svg?token=TDALV236YQ)](https://codecov.io/gh/metalim/csync)

[![go doc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/metalim/csync)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/mit/)

Go sync package with cancellable context

## Rationale

`sync.Mutex`, `sync.RWMutex` and `sync.WaitGroup` can block execution until another goroutine releases them. However locking can happen for a long time and we live in dynamic world, where we need to move forward even if some resources stay locked for a long time. Hence the creation of `csync` — package with similar primitives, where waiting can be cancelled by context.

## Primitives

`csync.WaitGroup`

`csync.Mutex`

`csync.RWMutex`

## Usage

```go

package main

import (

	"context"

	"log"

	"math/rand"

	"time"

	"github.com/metalim/csync"

)

const workers = 3

func main() {

	var wg csync.WaitGroup

	wg.Add(workers)

	for i := 0; i < workers; i++ {

		go func() {

			defer wg.Done()

			// do some work in 3rd party library without context support

			time.Sleep(time.Duration(rand.Intn(10)) * time.Second)

		}()

	}

	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)

	defer cancel()

	err := wg.Wait(ctx)

	if err != nil {

		log.Println(err)

	}

}

```