deadline

Documentation

Overview

Package deadline implements Deadline pattern.

Index

• Variables
• type Deadline
  • func New(timeout time.Duration) *Deadline
  • func (d *Deadline) Go(fn func(<-chan struct{}) error) error

Variables

var ErrTimeout = errors.New("time out executing function")

ErrTimeout is the error for deadline timeout.

Types

type Deadline

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

Deadline represents the deadline.

func New

func New(timeout time.Duration) *Deadline

New returns a new Deadline with the provided timeout.

func (*Deadline) Go

func (d *Deadline) Go(fn func(<-chan struct{}) error) error

Go executes the provided function with a done channel as parameter to signal the timeout.