sync

Documentation

Index

• Constants
• func Times(n uint32) interface{ ... }
• type SignalTrap
  • func Termination() SignalTrap
  • func (trap SignalTrap) Wait(ctx context.Context) error

Constants

const ErrSignalTrapped errors.Message = "signal trapped"

ErrSignalTrapped is returned by the SignalTrap.Wait when the expected signals caught.

Functions

func Times

func Times(n uint32) interface{ Do(func()) }

Times add possibility to Do some action the N times.

barrier := sync.Times(100)

func Call(action func() error) {
	barrier.Do(func () {
		if err := action(); err != nil {
			logger.WithError(err).Error("send the error to the Sentry only 100 times")
		}
	})
}

Types

type SignalTrap

type SignalTrap chan os.Signal

SignalTrap wraps os.Signal channel to provide high level API above it.

trap := make(chan os.Signal)
signal.Notify(trap, os.Interrupt)
SignalTrap(trap).Wait(context.Background())

func Termination

func Termination() SignalTrap

Termination returns trap for termination signals.

server := new(http.Server)
go safe.Do(server.ListenAndServe, func(err error) { log.Println(err) })

err := sync.Termination().Wait(context.Background())
if err == sync.ErrSignalTrapped {
	log.Println("shutting down the server", server.Shutdown(context.Background()))
}

func (SignalTrap) Wait

func (trap SignalTrap) Wait(ctx context.Context) error

Wait blocks until one of the expected signals caught or the Context closed. It unregisters from the notification and closes itself.