threading

Documentation

Overview

threading package provides support for simple concurrency and threading

Index

• type Job
• type ThreadPool
  • func NewThreadPool(numberThreads int, loggingFrequency int, output bool, outputProgress bool) (*ThreadPool, error)
  • func NewThreadPoolWithJobQueue(numberThreads, jobQueueSize int, loggingFrequency int, output bool, ...) (*ThreadPool, error)
  • func (t *ThreadPool) AddJob(job Job)
  • func (t *ThreadPool) PendingJobs() int
  • func (t *ThreadPool) ProcessAndWait() error

Types

type Job

type Job struct {
	Name    string
	Process func() error
}

type ThreadPool

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

func NewThreadPool

func NewThreadPool(numberThreads int, loggingFrequency int, output bool, outputProgress bool) (*ThreadPool, error)

func NewThreadPoolWithJobQueue

func NewThreadPoolWithJobQueue(numberThreads, jobQueueSize int, loggingFrequency int, output bool, outputProgress bool) (*ThreadPool, error)

func (*ThreadPool) AddJob

func (t *ThreadPool) AddJob(job Job)

AddJob adds a job to the thread pool. It increases the wait group counter and sends the job to the jobs channel.

func (*ThreadPool) PendingJobs

func (t *ThreadPool) PendingJobs() int

PendingJobs returns the number of jobs that are pending.

func (*ThreadPool) ProcessAndWait

func (t *ThreadPool) ProcessAndWait() error

ProcessAndWait blocks until all jobs have finished. If no jobs were added, it returns an error.