Skip to content

doc: explicit that result callback cannot call Submit() nor Close() #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rolinh merged 1 commit into from
Apr 6, 2026
Merged

doc: explicit that result callback cannot call Submit() nor Close() #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions workerpool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,12 @@ type Option func(*WorkerPool)
// - [Drain] will return [ErrCallbackSet] instead of collecting results
// - Results are processed immediately upon completion, avoiding memory
// buildup
// - The callback fn may be invoked concurrently from multiple goroutines
//
// The callback fn must be safe for concurrent use.
// The callback fn is invoked from the worker goroutines.
// This has a few implications:
// 1. fn must be safe for concurrent use.
// 2. fn must NOT call [Submit] nor [Close] as it will lead to a deadlock.
//
// WithResultCallback panics if fn is nil.
func WithResultCallback(fn func(Result)) Option {
// TODO(v2): New/NewWithContext should return an error so that option
Expand Down
Loading