goroutine

README

goroutine

A goroutine wrapper for creating and running panic safe goroutines.

The purpose of this package is to provide a simple wrapper function for goroutines, which automatically handles panics in goroutines. Starting a new goroutine without taking care of recovering from a possible panic in that goroutine itself could crash the whole application.

The Go function runs an arbitrary function f in a separate goroutine, which handles the recovering from panic within that goroutine.

Installation

go get -u github.com/sknr/goroutine

Usage (with dot import)

Instead of running

go func() {
    panic("Panic raised in goroutine")
}()

simply call

Go(func() {
    panic("Panic raised in goroutine")
})

in order to create a panic safe goroutine.

Functions with multiple input params must be wrapped within an anonymous function.

Instead of running

go func(a, b int) {
    panic(a+b)
}(21,21)

simply call

Go(func() {
    func(a, b int) {
        panic(a+b)
    }(21,21)
})

Examples

package main

import (
    "fmt"
    . "github.com/sknr/goroutine"
    "log"
)

func init() {
    // Override the default recover function.
    SetDefaultRecoverFunc(func(v interface{}, done chan<- error) {
        log.Printf("%v", v)
        done <- fmt.Errorf("panic in goroutine successfully recovered")
    })
}

func main() {
    for i := -3; i <= 3; i++ {
        err := <-Go(func() {
            func(a, b int) {
                log.Println(a, "/", b, "=", a/b)
            }(10, i)
        })
        if err != nil {
            log.Println(err)
        }
    }
}

Set a new default recover function

In order to override the default recover function for new goroutines (created with Go(func()) or Goroutine(func())), simply set a custom recover function of type RecoverFunc with SetDefaultRecoverFunc

Create a new goroutine with a custom recover function

If you need different recover functions for different goroutines, you can simply call

Goroutine(func() {
    func(name string) {
        panic(fmt.Sprintln("Hallo", name))
    }("Welt")
}).WithRecoverFunc(func(v interface{}, done chan<- error) {
    log.Printf("Custom recover function in goroutine, with error: %v", v)
}).Go()

Documentation

Index

• Variables
• func Go(f func()) <-chan error
• func Goroutine(f func()) *goroutine
• func SetDefaultRecoverFunc(recF RecoverFunc)
• type RecoverFunc
  • func GetDefaultRecoverFunc() RecoverFunc

Variables

var (
	// ErrPanicRecovered is returned via done channel if a panic arises within the goroutine.
	ErrPanicRecovered = &goroutineError{msg: "panic recovered"}

	// ErrRecoverFunctionPanicked is returned via done channel if a panic arises within the
	// goroutine and also within the recover function.
	ErrRecoverFunctionPanicked = &goroutineError{msg: "recover function panicked"}
)

Functions

func Go

func Go(f func()) <-chan error

Go runs a function f in a separate goroutine, which does handle the recovering from panic within that goroutine. Starting a new goroutine without taking care of recovering from a possible panic in that goroutine itself could crash the whole application. Functions with more than one input param must be wrapped within a func(){} like in the example below. Instead of running:

go func(s string) {
  panic(s)
}("Hello World")

simply call:

Go(func() {
  func(s string) {
    panic(s)
  }("Hello World")
})

func Goroutine

func Goroutine(f func()) *goroutine

Goroutine creates a new panic safe goroutine, with the defaultRecoverFunc as recover function.

func SetDefaultRecoverFunc

func SetDefaultRecoverFunc(recF RecoverFunc)

SetDefaultRecoverFunc can be used to override the defaultRecoverFunc which is used by Go and Goroutine functions. Note: Calling panic() within the recover function recF, will cause the application to crash.

If you pass nil as a RecoverFunc, the panic will be silently recovered.

Types

type RecoverFunc

type RecoverFunc func(v interface{}, done chan<- error)

The RecoverFunc type defines the signature of a recover function within a goroutine.

func GetDefaultRecoverFunc

func GetDefaultRecoverFunc() RecoverFunc

GetDefaultRecoverFunc returns the current default recover function for goroutines used by the Go and Goroutine functions.