mirror/groupcache
1
0
Fork 0
mirror of https://github.com/mailgun/groupcache.git synced 2024-10-01 12:22:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add comments for workspace.

Browse Source
This commit is contained in:
udhos 2023-12-28 01:11:21 -03:00
parent 473ad246d2
commit 0cfc57a63f
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
groupcache.go
View File

@ -68,7 +68,7 @@ func (f GetterFunc) Get(ctx context.Context, key string, dest Sink) error {
return f(ctx, key, dest) return f(ctx, key, dest)
} }
// GetGroup returns the named group previously created with NewGroup, or // GetGroupWithWorkspace returns the named group previously created with NewGroup, or
// nil if there's no such group. // nil if there's no such group.
func GetGroupWithWorkspace(ws *workspace, name string) *Group { func GetGroupWithWorkspace(ws *workspace, name string) *Group {
ws.mu.RLock() ws.mu.RLock()
@ -83,7 +83,7 @@ func GetGroup(name string) *Group {
return GetGroupWithWorkspace(DefaultWorkspace, name) return GetGroupWithWorkspace(DefaultWorkspace, name)
} }
// NewGroup creates a coordinated group-aware Getter from a Getter. // NewGroupWithWorkspace creates a coordinated group-aware Getter from a Getter.
// //
// The returned Getter tries (but does not guarantee) to run only one // The returned Getter tries (but does not guarantee) to run only one
// Get call at once for a given key across an entire set of peer // Get call at once for a given key across an entire set of peer
@ -109,7 +109,7 @@ func NewGroup(name string, cacheBytes int64, getter Getter) *Group {
return newGroup(DefaultWorkspace, name, cacheBytes, getter, nil) return newGroup(DefaultWorkspace, name, cacheBytes, getter, nil)
} }
// DeregisterGroup removes group from group pool // DeregisterGroupWithWorkspace removes group from group pool
func DeregisterGroupWithWorkspace(ws *workspace, name string) { func DeregisterGroupWithWorkspace(ws *workspace, name string) {
ws.mu.Lock() ws.mu.Lock()
delete(ws.groups, name) delete(ws.groups, name)
@ -149,7 +149,7 @@ func newGroup(ws *workspace, name string, cacheBytes int64, getter Getter, peers
return g return g
} }
// RegisterNewGroupHook registers a hook that is run each time // RegisterNewGroupHookWithWorkspace registers a hook that is run each time
// a group is created. // a group is created.
func RegisterNewGroupHookWithWorkspace(ws *workspace, fn func(*Group)) { func RegisterNewGroupHookWithWorkspace(ws *workspace, fn func(*Group)) {
if ws.newGroupHook != nil { if ws.newGroupHook != nil {
@ -164,7 +164,7 @@ func RegisterNewGroupHook(fn func(*Group)) {
RegisterNewGroupHookWithWorkspace(DefaultWorkspace, fn) RegisterNewGroupHookWithWorkspace(DefaultWorkspace, fn)
} }
// RegisterServerStart registers a hook that is run when the first // RegisterServerStartWithWorkspace registers a hook that is run when the first
// group is created. // group is created.
func RegisterServerStartWithWorkspace(ws *workspace, fn func()) { func RegisterServerStartWithWorkspace(ws *workspace, fn func()) {
if ws.initPeerServer != nil { if ws.initPeerServer != nil {

10
workspace.go
View File

@ -2,6 +2,7 @@ package groupcache
import "sync" import "sync"
// workspace holds the "global" state for groupcache.
type workspace struct { type workspace struct {
httpPoolMade bool httpPoolMade bool
portPicker func(groupName string) PeerPicker portPicker func(groupName string) PeerPicker
@ -16,8 +17,17 @@ type workspace struct {
newGroupHook func(*Group) newGroupHook func(*Group)
} }
// DefaultWorkspace is the default workspace used by non-workspace-aware APIs.
// If your application does not need to recreate groupcache resources,
// you should use the non-workspace-aware APIs.
// This is likely the most common case.
var DefaultWorkspace = NewWorkspace() var DefaultWorkspace = NewWorkspace()
// NewWorkspace creates an explicit workspace for workspace-aware APIs.
// If your application needs to recreate groupcache resources at some
// point, you should use the workspace-aware APIs.
// In order to release current groupcache resources, your application
// would drop all references to the workspace.
func NewWorkspace() *workspace { func NewWorkspace() *workspace {
return &workspace{ return &workspace{
groups: make(map[string]*Group), groups: make(map[string]*Group),