GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-25 21:39:25 +01:00
Code Issues Projects Releases Wiki Activity

ConfigStore: clarify intended use

Browse Source
This commit is contained in:
Shivaram Lingamneni 2022-05-03 23:27:24 -04:00
parent c603d41d08
commit 34ad3a2dc1
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
irc/utils/config.go
View File

@ -11,22 +11,23 @@ import (
/* /*
This can be used to implement the following pattern: This can be used to implement the following pattern:
1. Load and munge a config (this can be arbitrarily expensive) 1. Prepare a config object (this can be arbitrarily expensive)
2. Use Set() to install the config 2. Take a pointer to the config object and use Set() to install it
3. Use Get() to access the config 3. Use Get() to access the config from any goroutine
4. As long as any individual config is not modified (by any goroutine) 4. To update the config, call Set() again with a new prepared config object
after the initial call to Set(), this is free of data races, and Get() 5. As long as any individual config object is not modified (by any goroutine)
after it is installed with Set(), this is free of data races, and Get()
is extremely cheap (on amd64 it compiles down to plain MOV instructions). is extremely cheap (on amd64 it compiles down to plain MOV instructions).
*/ */
type ConfigStore[T any] struct { type ConfigStore[Config any] struct {
ptr unsafe.Pointer ptr unsafe.Pointer
} }
func (c *ConfigStore[T]) Get() *T { func (c *ConfigStore[Config]) Get() *Config {
return (*T)(atomic.LoadPointer(&c.ptr)) return (*Config)(atomic.LoadPointer(&c.ptr))
} }
func (c *ConfigStore[T]) Set(ptr *T) { func (c *ConfigStore[Config]) Set(ptr *Config) {
atomic.StorePointer(&c.ptr, unsafe.Pointer(ptr)) atomic.StorePointer(&c.ptr, unsafe.Pointer(ptr))
} }