stopfd

Documentation

Overview

Package stopfd provides an type that can be used to signal the stop of a dispatcher.

Index

• type StopFD
  • func New() (StopFD, error)
  • func (sf *StopFD) StateFields() []string
  • func (sf *StopFD) StateLoad(ctx context.Context, stateSourceObject state.Source)
  • func (sf *StopFD) StateSave(stateSinkObject state.Sink)
  • func (sf *StopFD) StateTypeName() string
  • func (sf *StopFD) Stop()

Types

type StopFD

type StopFD struct {
	EFD int
}

StopFD is an eventfd used to signal the stop of a dispatcher.

+stateify savable

func New

func New() (StopFD, error)

New returns a new, initialized StopFD.

func (*StopFD) StateFields

func (sf *StopFD) StateFields() []string

func (*StopFD) StateLoad

func (sf *StopFD) StateLoad(ctx context.Context, stateSourceObject state.Source)

+checklocksignore

func (*StopFD) StateSave

func (sf *StopFD) StateSave(stateSinkObject state.Sink)

+checklocksignore

func (*StopFD) StateTypeName

func (sf *StopFD) StateTypeName() string

func (*StopFD) Stop

func (sf *StopFD) Stop()

Stop writes to the eventfd and notifies the dispatcher to stop. It does not block.