Deprecated: use github.com/katzenpost/katzenpost instead.

worker

package

v0.0.16 Latest Latest Go to latest Published: Oct 21, 2023 License: AGPL-3.0 Imports: 1 Imported by: 24

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/katzenpost/core

Links

Open Source Insights

Documentation ¶

Overview ¶

Package worker provides background worker tasks.

Index ¶

type Worker

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Worker ¶

type Worker struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

Worker is a set of managed background go routines.

func (*Worker) Go ¶

func (w *Worker) Go(fn func())

Go excutes the function fn in a new Go routine. Multiple Go routines may be started under the same Worker. It is the function's responsibility to monitor the channel returned by `Worker.HaltCh()` and to return.

func (*Worker) Halt ¶

func (w *Worker) Halt()

Halt signals all Go routines started under a Worker to terminate, and waits till all go routines have returned.

func (*Worker) HaltCh ¶

func (w *Worker) HaltCh() <-chan interface{}

HaltCh returns the channel that will be closed on a call to Halt.

Source Files ¶

View all Source files

worker.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL