syncs

package

v0.7.4 Latest Latest Go to latest Published: Mar 12, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gookit/goutil

Links

Open Source Insights

Documentation ¶

Overview ¶

Package syncs provides synchronization primitives util functions.

Index ¶

func ContextValue(key, value any) context.Context
func Go(f func() error) error
func SignalHandler(ctx context.Context, signals ...os.Signal) (execute func() error, interrupt func(error))
func WaitCloseSignals(onClose func(sig os.Signal), sigCh ...chan os.Signal)
type ErrGroup
- func NewCtxErrGroup(ctx context.Context, limit ...int) (*ErrGroup, context.Context)
- func NewErrGroup(limit ...int) *ErrGroup
type SafeMap
- func NewSafeMap[K comparable, V any]() *SafeMap[K, V]
type SignalError
- func (e SignalError) Error() string
type WaitGroup
- func (wg *WaitGroup) Go(fn func())

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ContextValue ¶ added in v0.7.2

func ContextValue(key, value any) context.Context

ContextValue create a new context with given value

func Go ¶

func Go(f func() error) error

Go is a basic promise implementation: it wraps calls a function in a goroutine and returns a channel which will later return the function's return value.

if panic happen, it will be recovered and return as error

func SignalHandler ¶

func SignalHandler(ctx context.Context, signals ...os.Signal) (execute func() error, interrupt func(error))

SignalHandler returns an actor, i.e. an execute and interrupt func, that terminates with SignalError when the process receives one of the provided signals, or the parent context is canceled.

from https://github.com/oklog/run/blob/master/actors.go

func WaitCloseSignals ¶

func WaitCloseSignals(onClose func(sig os.Signal), sigCh ...chan os.Signal)

WaitCloseSignals for some huang program.

Usage:

// do something. eg: start a http server

syncs.WaitCloseSignals(func(sig os.Signal) {
	// do something on shutdown. eg: close db, flush logs
})

Types ¶

type ErrGroup ¶ added in v0.6.13

type ErrGroup struct {
	*errgroup.Group
}

ErrGroup is a collection of goroutines working on subtasks that are part of the same overall task.

Refers:

https://github.com/neilotoole/errgroup
https://github.com/fatih/semgroup

func NewCtxErrGroup ¶ added in v0.6.13

func NewCtxErrGroup(ctx context.Context, limit ...int) (*ErrGroup, context.Context)

NewCtxErrGroup instance

func NewErrGroup ¶ added in v0.6.13

func NewErrGroup(limit ...int) *ErrGroup

NewErrGroup instance

func (*ErrGroup) Add ¶ added in v0.6.13

func (g *ErrGroup) Add(handlers ...func() error)

Add one or more handler at once

func (*ErrGroup) Go ¶ added in v0.7.4

func (g *ErrGroup) Go(fn func() error)

Go add a handler function. if panic occurs, will catch it and return as error

func (*ErrGroup) TryGo ¶ added in v0.7.4

func (g *ErrGroup) TryGo(fn func() error) bool

TryGo calls the given function in a new goroutine only if the number of active goroutines in the group is currently below the configured limit.

The return value reports whether the goroutine was started.

If panic occurs, will catch it and return as error

type SafeMap ¶ added in v0.7.4

type SafeMap[K comparable, V any] struct {
	// contains filtered or unexported fields
}

SafeMap is a goroutine-safe map.

func NewSafeMap ¶ added in v0.7.4

func NewSafeMap[K comparable, V any]() *SafeMap[K, V]

NewSafeMap create a new SafeMap instance.

func (*SafeMap[K, V]) Clear ¶ added in v0.7.4

func (m *SafeMap[K, V]) Clear()

Clear do clear all map values.

func (*SafeMap[K, V]) Delete ¶ added in v0.7.4

func (m *SafeMap[K, V]) Delete(key K)

Delete value from map.

func (*SafeMap[K, V]) Get ¶ added in v0.7.4

func (m *SafeMap[K, V]) Get(key K) (value V, ok bool)

Get value from map.

func (*SafeMap[K, V]) Len ¶ added in v0.7.4

func (m *SafeMap[K, V]) Len() int

Len get map length.

func (*SafeMap[K, V]) Range ¶ added in v0.7.4

func (m *SafeMap[K, V]) Range(fn func(key K, value V))

Range iterate map values.

func (*SafeMap[K, V]) Set ¶ added in v0.7.4

func (m *SafeMap[K, V]) Set(key K, value V)

Set value to map.

type SignalError ¶

type SignalError struct {
	Signal os.Signal
}

SignalError is returned by the signal handler's execute function when it terminates due to a received signal.

func (SignalError) Error ¶

func (e SignalError) Error() string

Error implements the error interface.

type WaitGroup ¶ added in v0.7.0

type WaitGroup struct {
	sync.WaitGroup
}

WaitGroup is a wrapper of sync.WaitGroup.

Usage:

wg := syncs.WaitGroup{}
wg.Go(func() {
	time.Sleep(time.Second)
})
wg.Wait()

func (*WaitGroup) Go ¶ added in v0.7.0

func (wg *WaitGroup) Go(fn func())

Go runs the given function in a new goroutine. will auto call Add and Done.

Source Files ¶

View all Source files

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