timer

Documentation

Index

• func Deadline(correction float32, threshold time.Duration) func(time.Time, bool) time.Time
• func Stopwatch(fn func()) time.Duration
• func Timeout(correction float32, threshold time.Duration) func(time.Duration, bool) time.Duration

Functions

func Deadline

func Deadline(correction float32, threshold time.Duration) func(time.Time, bool) time.Time

Deadline return a time corrector.

It useful for go.octolab.org/toolkit/protocol/http/header.Deadline and go.octolab.org/toolkit/protocol/http/middleware.Deadline.

mux := http.NewServeMux()

sla := middleware.Deadline(time.Second, timer.Deadline(0.95, time.Millisecond))
handler := http.HandlerFunc(func(http.ResponseWriter, *http.Request) {})
mux.Handle("/", sla(handler))

log.Fatal(http.ListenAndServe(":80", mux))

It also useful for the built-in context package.

func(rw http.ResponseWriter, req *http.Request) {
	ctx := req.Context()

	corrector := timer.Deadline(0.95, time.Millisecond)
	ctx, cancel := context.WithDeadline(req.Context(), corrector(ctx.Deadline()))
	defer cancel()

	select {
	case <-ctx.Done():
		message := http.StatusText(http.StatusRequestTimeout)
		http.Error(rw, message, http.StatusRequestTimeout)
	case result := <-rpc.Call(ctx):
		unsafe.Ignore(json.NewEncoder(rw).Encode(result))
	}
}

func Stopwatch

func Stopwatch(fn func()) time.Duration

Stopwatch calculates the fn execution time.

var result interface{}

duration := fn.Stopwatch(func() { result = do.some("heavy") })

func Timeout

func Timeout(correction float32, threshold time.Duration) func(time.Duration, bool) time.Duration

Timeout return a duration corrector.

It useful for go.octolab.org/toolkit/protocol/http/header.Timeout and go.octolab.org/toolkit/protocol/http/middleware.Timeout.

mux := http.NewServeMux()

sla := middleware.Timeout(time.Second, timer.Timeout(0.95, time.Millisecond))
handler := http.HandlerFunc(func(http.ResponseWriter, *http.Request) {})
mux.Handle("/", sla(handler))

log.Fatal(http.ListenAndServe(":80", mux))