signal

Documentation

Index

• type CancelSignal
  • func NewCloseSignal() *CancelSignal
  • func (this *CancelSignal) Cancel()
  • func (this *CancelSignal) Done()
  • func (this *CancelSignal) WaitForCancel() <-chan struct{}
  • func (this *CancelSignal) WaitForDone() <-chan struct{}

Types

type CancelSignal

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

CancelSignal is a signal passed to goroutine, in order to cancel the goroutine on demand.

func NewCloseSignal

func NewCloseSignal() *CancelSignal

NewCloseSignal creates a new CancelSignal.

func (*CancelSignal) Cancel

func (this *CancelSignal) Cancel()

Cancel signals the goroutine to stop.

func (*CancelSignal) Done

func (this *CancelSignal) Done()

Done signals the caller that the goroutine has completely finished.

func (*CancelSignal) WaitForCancel

func (this *CancelSignal) WaitForCancel() <-chan struct{}

WaitForCancel should be monitored by the goroutine for when to stop.

func (*CancelSignal) WaitForDone

func (this *CancelSignal) WaitForDone() <-chan struct{}

WaitForDone is used by caller to wait for the goroutine finishes.