signal

Documentation

Index

• type CancelSignal
  • func NewCloseSignal() *CancelSignal
  • func (v *CancelSignal) Cancel()
  • func (v *CancelSignal) Cancelled() bool
  • func (v *CancelSignal) FinishThread()
  • func (v *CancelSignal) WaitForCancel() <-chan struct{}
  • func (v *CancelSignal) WaitForDone()
  • func (v *CancelSignal) WaitThread()
• type Once
  • func (o *Once) Do(f func())
  • func (o *Once) Reset()

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 (v *CancelSignal) Cancel()

Cancel signals the goroutine to stop.

func (*CancelSignal) Cancelled

func (v *CancelSignal) Cancelled() bool

func (*CancelSignal) FinishThread

func (v *CancelSignal) FinishThread()

FinishThread signals that current goroutine has finished.

func (*CancelSignal) WaitForCancel

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

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

func (*CancelSignal) WaitForDone

func (v *CancelSignal) WaitForDone()

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

func (*CancelSignal) WaitThread

func (v *CancelSignal) WaitThread()

type Once

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

func (*Once) Do

func (o *Once) Do(f func())

func (*Once) Reset

func (o *Once) Reset()