vptimeout

Documentation

Overview

Package vptimeout implements utilities to handle timeout of functions, typically usefull when using 3rd party blocking funcs.

Index

• Constants
• func Run(f func() error, d time.Duration) error

Constants

const PackageCopyright = "Copyright (C)  2015, 2016  Christian Mauduit <ufoot@ufoot.org>" // PackageCopyright set by version.sh

PackageCopyright contains a short copyright notice.

const PackageEmail = "ufoot@ufoot.org" // PackageEmail set by version.sh

PackageEmail contains a contact email for the package.

const PackageLicense = "GNU GPL v3" // PackageLicense set by version.sh

PackageLicense contains a short license information.

const PackageName = "Vapor Toolkit" // PackageName set by version.sh

PackageName contains a readable name of the package, suitable for display.

const PackageTarname = "vapor" // PackageTarname set by version.sh

PackageTarname contains a short name of the package, suitable for a filename.

const PackageURL = "https://github.com/ufoot/vapor" // PackageURL set by version.sh

PackageURL contains the address of the project homepage.

const VersionMajor = 0 // VersionMajor set by version.sh

VersionMajor is the project major version.

const VersionMinor = 3 // VersionMinor set by version.sh

VersionMinor is the project minor version.

const VersionStamp = "c6a4298" // VersionStamp set by version.sh

VersionStamp is the project stamp, possibly changes for each build.

Functions

func Run

func Run(f func() error, d time.Duration) error

Run runs the function f, but will stop everyting if timeout is reached. If f takes longer than timeout, a timeout error will be returned, and the goroutine might keep going until it's done, but the result will be ignored.