goroutinemap

Documentation

Overview

Package goroutinemap implements a data structure for managing go routines by name. It prevents the creation of new go routines if an existing go routine with the same name exists.

Index

• type GoRoutineMap
  • func NewGoRoutineMap() GoRoutineMap

Types

type GoRoutineMap

type GoRoutineMap interface {
	// Run adds operationName to the list of running operations and spawns a new
	// go routine to execute the operation. If an operation with the same name
	// already exists, an error is returned. Once the operation is complete, the
	// go routine is terminated and the operationName is removed from the list
	// of executing operations allowing a new operation to be started with the
	// same name without error.
	Run(operationName string, operation func() error) error

	// Wait blocks until all operations are completed. This is typically
	// necessary during tests - the test should wait until all operations finish
	// and evaluate results after that.
	Wait()
}

GoRoutineMap defines the supported set of operations.

func NewGoRoutineMap

func NewGoRoutineMap() GoRoutineMap

NewGoRoutineMap returns a new instance of GoRoutineMap.