broadcast

Documentation

Index

• type Broadcast
  • func (c *Broadcast) Broadcast()
  • func (c *Broadcast) GetWaitCh() <-chan struct{}
  • func (c *Broadcast) HoldLock(cb func(broadcast func(), getWaitCh func() <-chan struct{}))
  • func (c *Broadcast) HoldLockMaybeAsync(cb func(broadcast func(), getWaitCh func() <-chan struct{}))

Types

type Broadcast

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

Broadcast implements notifying waiters via a channel.

The zero-value of this struct is valid.

func (*Broadcast) Broadcast

func (c *Broadcast) Broadcast()

Broadcast closes the broadcast channel, triggering waiters.

func (*Broadcast) GetWaitCh

func (c *Broadcast) GetWaitCh() <-chan struct{}

GetWaitCh returns a channel that is closed when Broadcast is called.

func (*Broadcast) HoldLock

func (c *Broadcast) HoldLock(cb func(broadcast func(), getWaitCh func() <-chan struct{}))

HoldLock locks the mutex and calls the callback.

func (*Broadcast) HoldLockMaybeAsync

func (c *Broadcast) HoldLockMaybeAsync(cb func(broadcast func(), getWaitCh func() <-chan struct{}))

HoldLockMaybeAsync locks the mutex and calls the callback if possible. If the mutex cannot be locked right now, starts a new Goroutine to wait for it.