cond

Documentation

Overview

Package cond implements a context-aware condition variable.

Index

• type Cond
  • func NewCond(l sync.Locker) *Cond
  • func (c *Cond) Broadcast()
  • func (c *Cond) Signal()
  • func (c *Cond) Wait(ctx context.Context) error

Types

type Cond

type Cond struct {
	L sync.Locker
	// contains filtered or unexported fields
}

Cond is a context-aware version of a sync.Cond. Like a sync.Cond, a Cond must not be copied after first use.

func NewCond

func NewCond(l sync.Locker) *Cond

NewCond returns a new Cond with Locker l.

func (*Cond) Broadcast

func (c *Cond) Broadcast()

Broadcast is identical to sync.Cond.Broadcast.

func (*Cond) Signal

func (c *Cond) Signal()

Signal is identical to sync.Cond.Signal.

func (*Cond) Wait

func (c *Cond) Wait(ctx context.Context) error

Wait behaves identically to sync.Cond.Wait, except that it respects the provided context. Specifically, if the context is cancelled, c.L is reacquired and ctx.Err() is returned. Example usage:

for !condition() {
    if err := cond.Wait(ctx); err != nil {
        // The context was cancelled. cond.L is locked at this point.
        return err
    }
    // Wait returned normally. cond.L is still locked at this point.
}