package tdsync

Import Path
	github.com/gotd/td/internal/tdsync (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 5 packages

Involved Source Files

	    backoff.go
	  d cancel_group.go
		Package tdsync contains some useful synchronization utilities.

	    log_group.go
	    ready.go
	    reset_ready.go
	    supervisor.go
Package-Level Type Names (total 6, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type CancellableGroup (struct)
		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.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			cancel context.CancelFunc
			ctx context.Context
			group *errgroup.Group
		Methods (total 3, all are exported)
			(*CancellableGroup) Cancel()
				Cancel cancels all goroutines in group.
				
				Note: context cancellation error will be returned by Wait().

			(*CancellableGroup) Go(f func(ctx 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.

			(*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.

		As Outputs Of (at least one exported)
			func NewCancellableGroup(parent context.Context) *CancellableGroup

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

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			clock clock.Clock
			group CancellableGroup
			log *zap.Logger
		Methods (total 4, all are exported)
			(*LogGroup) Cancel()
				Cancel cancels all goroutines in group.
				
				Note: context cancellation error will be returned by Wait().

			(*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.

			(*LogGroup) SetClock(c clock.Clock)
				SetClock sets Clock to use.

			(*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.

		As Outputs Of (at least one exported)
			func NewLogGroup(parent context.Context, log *zap.Logger) *LogGroup

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

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			done int32
			wait chan struct{}
		Methods (total 3, in which 2 are exported)
			(*Ready) Ready() <-chan struct{}
				Ready returns waiting channel.

			(*Ready) Signal()
				Signal sends ready signal.
				Can be called multiple times.

			/* one unexported ... *//* one unexported: */
			(*Ready) reset()
		As Outputs Of (at least one exported)
			func NewReady() *Ready

	 type ResetReady (struct)
		ResetReady is like Ready, but can be Reset.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			lock sync.Mutex
			ready Ready
		Methods (total 3, all are exported)
			(*ResetReady) Ready() <-chan struct{}
				Ready returns waiting channel.

			(*ResetReady) Reset()
				Reset resets underlying Ready.

			(*ResetReady) Signal()
				Signal sends ready signal.
				Can be called multiple times.

		As Outputs Of (at least one exported)
			func NewResetReady() *ResetReady

	 type Supervisor (struct)
		Supervisor is simple task group primitive to control multiple
		long-live tasks.
		Unlike Groups, Supervisor does not cancel when one task is failed.
		Unlike WaitGroup and errgroup.Group this is not allowed to use zero value.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			cancel context.CancelFunc
			ctx context.Context
			onError func(err error)
			wg sync.WaitGroup
		Methods (total 4, all are exported)
			(*Supervisor) Cancel()
				Cancel cancels all goroutines in group.
				
				Note: context cancellation error can be returned by Wait().

			(*Supervisor) Go(task func(ctx context.Context) error)
				Go calls the given function in a new goroutine.

			(*Supervisor) 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.

			(*Supervisor) WithErrorHandler(h func(err error)) *Supervisor
				WithErrorHandler sets tasks error handler
				Must be called before any Go calls.

		As Outputs Of (at least 2, both are exported)
			func NewSupervisor(parent context.Context) *Supervisor
			func (*Supervisor).WithErrorHandler(h func(err error)) *Supervisor

	/* one unexported ... *//* one unexported: */
	 type syncBackoff (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			b backoff.BackOff
			mux sync.Mutex
		Methods (total 2, both are exported)
			(*syncBackoff) NextBackOff() time.Duration
			(*syncBackoff) Reset()
		Implements (at least one exported)
			*syncBackoff : github.com/cenkalti/backoff/v4.BackOff


Package-Level Functions (total 6, all are exported)

	 func NewCancellableGroup(parent context.Context) *CancellableGroup
		NewCancellableGroup creates new CancellableGroup.
		
		Example:
		
			g := NewCancellableGroup(ctx)
			g.Go(func(ctx context.Context) error {
				<-ctx.Done()
				return ctx.Err()
			})
			g.Cancel()
			g.Wait()

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

	 func NewReady() *Ready
		NewReady creates new Ready.

	 func NewResetReady() *ResetReady
		NewResetReady creates new ResetReady.

	 func NewSupervisor(parent context.Context) *Supervisor
		NewSupervisor creates new Supervisor.

	 func SyncBackoff(from backoff.BackOff) backoff.BackOff
		SyncBackoff decorates backoff.BackOff to be thread-safe.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.