ctxsync

README

Package cloudeng.io/sync/ctxsync

import cloudeng.io/sync/ctxsync

Package ctxsync provides context aware synchronisation primitives.

Types

Type WaitGroup

type WaitGroup struct {
	sync.WaitGroup
}

WaitGroup represents a context aware sync.WaitGroup

Methods

func (wg *WaitGroup) Wait(ctx context.Context)

Wait blocks until the WaitGroup reaches zero or the context is canceled, whichever comes first.

Examples

ExampleWaitGroup

Documentation

Overview

Package ctxsync provides context aware synchronisation primitives.

Index

• type WaitGroup
  • func (wg *WaitGroup) Wait(ctx context.Context)

Examples

• WaitGroup

Types

type WaitGroup

type WaitGroup struct {
	sync.WaitGroup
}

WaitGroup represents a context aware sync.WaitGroup

Example

package main

import (
	"context"
	"fmt"
	"time"

	"cloudeng.io/sync/ctxsync"
)

func main() {
	var wg ctxsync.WaitGroup
	wg.Add(1)
	ctx, cancel := context.WithCancel(context.Background())
	go func() {
		time.Sleep(time.Second)
		cancel()
	}()
	wg.Wait(ctx)
	fmt.Println(ctx.Err())
}

Output:

context canceled

func (*WaitGroup) Wait

func (wg *WaitGroup) Wait(ctx context.Context)

Wait blocks until the WaitGroup reaches zero or the context is canceled, whichever comes first.