util

Documentation

Overview

Package util contains a range of utility code. This code should probably be put into a library to be shared between applications at some point.

Package util - contains a collection of different functions used across all Retrieval Getaways instances.

Utility function like ones to work with time, process lifetime and binary versioning.

Index

• func SetMockedClock(fakeTime int64)
• func SetRealClock()
• func SetUpCtrlCExit(gracefulExit func())
• type Clock
  • func GetTimeImpl() Clock
• type VersionInfo
  • func GetVersion() VersionInfo

Functions

func SetMockedClock

func SetMockedClock(fakeTime int64)

SetMockedClock sets a fake timer

func SetRealClock

func SetRealClock()

SetRealClock ensures the real clock is in use

func SetUpCtrlCExit

func SetUpCtrlCExit(gracefulExit func())

SetUpCtrlCExit - configure the program such that when Control-C is hit, gracefulExit is called, followed by program exit.

Types

type Clock

type Clock interface {
	Now() time.Time
}

Clock allows the time.Now to be mocked out for testing

func GetTimeImpl

func GetTimeImpl() Clock

GetTimeImpl returns the implementation of clock to use.

type VersionInfo

type VersionInfo struct {
	Version   string
	BuildDate string
}

VersionInfo holds the version information for the applicaiton.

func GetVersion

func GetVersion() VersionInfo

GetVersion returns the static build information.