tdsync

Documentation

Overview

Package tdsync contains some useful synchronization utilities.

Index

• type CancellableGroup
  • func NewCancellableGroup(parent context.Context) *CancellableGroup
  • func (g *CancellableGroup) Cancel()
  • func (g *CancellableGroup) Go(f func(groupCtx context.Context) error)
  • func (g *CancellableGroup) Wait() error
• type LogGroup
  • func NewLogGroup(parent context.Context, log *zap.Logger) *LogGroup
  • func (g *LogGroup) Cancel()
  • func (g *LogGroup) Go(taskName string, f func(groupCtx context.Context) error)
  • func (g *LogGroup) SetClock(c clock.Clock)
  • func (g *LogGroup) Wait() error
• type Ready
  • func NewReady() *Ready
  • func (r *Ready) Ready() <-chan struct{}
  • func (r *Ready) Signal()
• type ResetReady
  • func NewResetReady() *ResetReady
  • func (r *ResetReady) Ready() <-chan struct{}
  • func (r *ResetReady) Reset()
  • func (r *ResetReady) Signal()

Types

type CancellableGroup

type CancellableGroup struct {
	// contains filtered or unexported fields
}

CancellableGroup is simple wrapper around errgroup.Group to make group cancellation easier. Unlike WaitGroup and errgroup.Group this is not allowed to use zero value.

func NewCancellableGroup

func NewCancellableGroup(parent context.Context) *CancellableGroup

NewCancellableGroup creates new CancellableGroup.

func (*CancellableGroup) Cancel

func (g *CancellableGroup) Cancel()

Cancel cancels all goroutines in group.

Note: context cancellation error will be returned by Wait().

func (*CancellableGroup) Go

func (g *CancellableGroup) Go(f func(groupCtx context.Context) error)

Go calls the given function in a new goroutine.

The first call to return a non-nil error cancels the group; its error will be returned by Wait.

func (*CancellableGroup) Wait

func (g *CancellableGroup) Wait() error

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

type LogGroup

type LogGroup struct {
	// contains filtered or unexported fields
}

LogGroup is simple wrapper around CancellableGroup to log task state. Unlike WaitGroup and errgroup.Group this is not allowed to use zero value.

func NewLogGroup

func NewLogGroup(parent context.Context, log *zap.Logger) *LogGroup

NewLogGroup creates new LogGroup.

func (*LogGroup) Cancel

func (g *LogGroup) Cancel()

Cancel cancels all goroutines in group.

Note: context cancellation error will be returned by Wait().

func (*LogGroup) Go

func (g *LogGroup) Go(taskName string, f func(groupCtx context.Context) error)

Go calls the given function in a new goroutine.

The first call to return a non-nil error cancels the group; its error will be returned by Wait.

func (*LogGroup) SetClock

func (g *LogGroup) SetClock(c clock.Clock)

SetClock sets Clock to use.

func (*LogGroup) Wait

func (g *LogGroup) Wait() error

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

type Ready

type Ready struct {
	// contains filtered or unexported fields
}

Ready is simple signal primitive which sends signal once. This is not allowed to use zero value.

func NewReady

func NewReady() *Ready

NewReady creates new Ready.

func (*Ready) Ready

func (r *Ready) Ready() <-chan struct{}

Ready returns waiting channel.

func (*Ready) Signal

func (r *Ready) Signal()

Signal sends ready signal. Can be called multiple times.

type ResetReady

type ResetReady struct {
	// contains filtered or unexported fields
}

ResetReady is like Ready, but can be Reset.

func NewResetReady

func NewResetReady() *ResetReady

NewResetReady creates new ResetReady.

func (*ResetReady) Ready

func (r *ResetReady) Ready() <-chan struct{}

Ready returns waiting channel.

func (*ResetReady) Reset

func (r *ResetReady) Reset()

Reset resets underlying Ready.

func (*ResetReady) Signal

func (r *ResetReady) Signal()

Signal sends ready signal. Can be called multiple times.