utils

Documentation

Index

• Variables
• func GetQuitChannel() chan os.Signal
• func ParseInt(v string) (r uint64, err error)
• func ParseSource(v string) (ret net.IP, err error)
• func WaitForQuit() (r os.Signal)
• type ReadResetCloser
  • func GetReader(fin *os.File, tp types.Type) (r ReadResetCloser, err error)
  • func NewFileReadResetCloser(fin *os.File) ReadResetCloser
  • func OpenBufferedFileReader(p string, buffer int) (r ReadResetCloser, err error)
  • func OpenFileReader(p string) (r ReadResetCloser, err error)
• type State
  • func NewState(pth string, perm os.FileMode) (s *State, err error)
  • func (s *State) Read(f interface{}) (err error)
  • func (s *State) Write(f interface{}) (err error)

Variables

var (
	ErrInvalidStatePath = errors.New("Invalid state file path")
	ErrNoState          = errors.New("No state available")
)

Functions

func GetQuitChannel

func GetQuitChannel() chan os.Signal

GetQuitChannel registers and returns a channel that will be notified upon receipt of the following signals: SIGHUP, SIGINT, SIGQUIT, SIGTERM

func ParseInt

func ParseInt(v string) (r uint64, err error)

func ParseSource

func ParseSource(v string) (ret net.IP, err error)

ParseSource attempts to parse a string as a source override The priority logic is:

1. IP address
2. Numeric ID
3. hexadecimal hash

func WaitForQuit

func WaitForQuit() (r os.Signal)

WaitForQuit waits until it receives one of the following signals: SIGHUP, SIGINT, SIGQUIT, SIGTERM It returns the received signal.

Types

type ReadResetCloser

type ReadResetCloser interface {
	Read([]byte) (int, error)
	Close() error
	Reset() error
}

func GetReader

func GetReader(fin *os.File, tp types.Type) (r ReadResetCloser, err error)

func NewFileReadResetCloser

func NewFileReadResetCloser(fin *os.File) ReadResetCloser

func OpenBufferedFileReader

func OpenBufferedFileReader(p string, buffer int) (r ReadResetCloser, err error)

func OpenFileReader

func OpenFileReader(p string) (r ReadResetCloser, err error)

type State

type State struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewState

func NewState(pth string, perm os.FileMode) (s *State, err error)

func (*State) Read

func (s *State) Read(f interface{}) (err error)

func (*State) Write

func (s *State) Write(f interface{}) (err error)