-
-
Save RyanBalfanz/9d45e7d83bceb1f8247fe69367fc35d7 to your computer and use it in GitHub Desktop.
GoLang exiting from multiple go routines with context and wait group
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package main | |
// Here's a simple example to show how to properly terminate multiple go routines by using a context. | |
// Thanks to the WaitGroup we'll be able to end all go routines gracefully before the main function ends. | |
import ( | |
"context" | |
"fmt" | |
"math/rand" | |
"os" | |
"sync" | |
"time" | |
) | |
func init() { | |
rand.Seed(time.Now().UnixNano()) | |
} | |
// it prints all values pushed into "ch" ("ch" here is read only) | |
func reader(ctx context.Context, wg *sync.WaitGroup, ch <-chan int) { | |
defer wg.Done() // decrements the WaitGroup counter by one when the function returns | |
for { | |
select { | |
case <-ctx.Done(): // Done returns a channel that's closed when work done on behalf of this context is canceled | |
fmt.Println("Exiting from reading go routine") | |
return | |
case v, ok := <-ch: | |
if !ok { | |
fmt.Println("Channel has been closed") | |
return | |
} | |
fmt.Println(v) | |
} | |
} | |
} | |
// it writes a random integer into "ch" every second ("ch" here is write only) | |
func writer(ctx context.Context, wg *sync.WaitGroup, ch chan<- int) { | |
defer wg.Done() // decrements the WaitGroup counter by one when the function returns | |
for { | |
select { | |
case <-ctx.Done(): // Done returns a channel that's closed when work done on behalf of this context is canceled | |
fmt.Println("Exiting from writing go routine") | |
return | |
case ch <- rand.Intn(100): // pushes a random integer from 0 to 100 into the channel | |
time.Sleep(1 * time.Second) // sleeps one second | |
} | |
} | |
} | |
func main() { | |
channel := make(chan int) | |
defer close(channel) | |
// a WaitGroup waits for a collection of goroutines to finish, pass this by address | |
waitGroup := sync.WaitGroup{} | |
// context.WithCancel returns a copy of parent with a new Done channel. | |
// The returned context's Done channel is closed when the returned cancel function is called or when the parent | |
// context's Done channel is closed, whichever happens first. | |
ctx, cancel := context.WithCancel(context.Background()) | |
waitGroup.Add(2) // adds delta, if the counter becomes zero, all goroutines blocked on Wait are released | |
go reader(ctx, &waitGroup, channel) // go routine that prints all values pushed into "channel" | |
go writer(ctx, &waitGroup, channel) // go routine that writes a random integer into "channel" every second | |
// go routine that listens for an Enter keystroke to terminate the program | |
go func() { | |
os.Stdin.Read(make([]byte, 1)) // wait for Enter keystroke | |
cancel() // cancel the associated context | |
}() | |
waitGroup.Wait() // it blocks until the WaitGroup counter is zero | |
fmt.Println("Exiting from main") | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment