grpcsync

Documentation

Overview

Package grpcsync implements additional synchronization primitives built upon the sync package.

Index

• func OnceFunc(f func()) func()
• type Event
  • func NewEvent() *Event
  • func (e *Event) Done() <-chan struct{}
  • func (e *Event) Fire() bool
  • func (e *Event) HasFired() bool

Functions

func OnceFunc

func OnceFunc(f func()) func()

OnceFunc returns a function wrapping f which ensures f is only executed once even if the returned function is executed multiple times.

Types

type Event

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

Event represents a one-time event that may occur in the future.

func NewEvent

func NewEvent() *Event

NewEvent returns a new, ready-to-use Event.

func (*Event) Done

func (e *Event) Done() <-chan struct{}

Done returns a channel that will be closed when Fire is called.

func (*Event) Fire

func (e *Event) Fire() bool

Fire causes e to complete. It is safe to call multiple times, and concurrently. It returns true iff this call to Fire caused the signaling channel returned by Done to close.

func (*Event) HasFired

func (e *Event) HasFired() bool

HasFired returns true if Fire has been called.