When do you embed mutex in struct in Go?

by

It’s good practice to keep the mutex close to the data it is destined to protect. If a mutex ought to protect concurrent access to fields of a struct value, it’s very convenient to add the mutex as a field of that struct, so its purpose is obvious.

If in your app there is only a single “instance” of A, it’s fine to make the mutex a global variable too.

If your app is to create multiple values of A, all of which needs to be protected from concurrent access (but only individually, multiple values may be accessed concurrently), then obviously a global mutex is a bad choice, it would limit the concurrent access to a single value of A in any point in time.

Adding the mutex to the struct as a field, you will naturally have a separate mutex for each distinct struct values, responsible to guard that single, wrapper struct value (or its fields).

Although adding a mutex as in your example is not embedding, it’s a regular, named field. An embedded field declaration omits the field name.

It’s known and used to a lesser extent, but it’s also handy that you can “truly” embed a mutex in a struct, and you can call Lock() and Unlock() as if they would be part of the struct itself. It looks like this:

var hits struct {
    sync.Mutex
    n int
}

hits.Lock()
hits.n++
hits.Unlock()

(This example is taken from 10 things you (probably) don’t know about Go, slide #3.)

More Related Contents:

  1. What is the correct way to retrieve length of an array added a field in nested struct in golang
  2. What are the use(s) for tags in Go?
  3. What are the use(s) for struct tags in Go?
  4. Generic Structs with Go
  5. How to access unexported struct fields
  6. package’s type cannot be used as the vendored package’s type
  7. How to set default values in Go structs
  8. Why are interfaces needed in Golang?
  9. If I am using channels properly should I need to use mutexes?
  10. Golang embedded struct type
  11. Struct in for loop initializer
  12. Go struct tags with underscore before function names
  13. How to clone a structure with unexported field?
  14. Why can’t I append to a slice that’s the property of a struct in golang?
  15. Why do 2 time structs with the same date and time return false when compared with ==?
  16. What is the possible use case for defer?
  17. golang get only one stat from json
  18. cancel a blocking operation in Go
  19. Relative imports in Go
  20. Organizing a multiple-file Go project [closed]
  21. Can I create shared test utilities?
  22. How do you create a new instance of a struct from its type at run time in Go?
  23. How to get the directory of the currently running file?
  24. How to run test cases in a specified file?
  25. Instance new Type (Golang)
  26. What is the idiomatic way in Go to create a complex hierarchy of structs?
  27. What is a sensible way to layout a Go project [closed]
  28. Is this casting in golang?
  29. Go-compiled binary won’t run in an alpine docker container on Ubuntu host
  30. Streaming commands output progress

Leave a Comment