detach

Documentation

Overview

Package detach provides basic blocks for running goroutines with a detached context.

Index

• type Task
  • func Go(f func(context.Context)) Task
  • func (t Task) Cancel()
  • func (t Task) Finished() <-chan struct{}

Types

type Task

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

A Task describes the status of a detached function call started by calling Go.

func Go

func Go(f func(context.Context)) Task

Go starts a new goroutine with a detached context and returns a Task that can be used to cancel and/or wait for the function to return.

func (Task) Cancel

func (t Task) Cancel()

Cancel cancels a Task. After the first call, subsequent calls to Cancel do nothing.

func (Task) Finished

func (t Task) Finished() <-chan struct{}

Finished returns a channel that is closed on the task function completion.