syncs

Documentation

Overview

Package syncs provides synchronization primitives util functions.

Index

• 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))
• type ErrGroup
  • func NewCtxErrGroup(ctx context.Context, limit ...int) (*ErrGroup, context.Context)
  • func NewErrGroup(limit ...int) *ErrGroup
  • func (g *ErrGroup) Add(handlers ...func() error)
• type SignalError
  • func (e SignalError) Error() string

Functions

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.

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))

WaitCloseSignals for some huang program.

Usage:

// do something. eg: start a http server

syncs.WaitCloseSignals(func(sig os.Signal) {
	// do something
})

Types

type ErrGroup

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

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

NewCtxErrGroup instance

func NewErrGroup

func NewErrGroup(limit ...int) *ErrGroup

NewErrGroup instance

func (*ErrGroup) Add

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

Add one or more handler at once

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.