mirror of
				https://github.com/openimsdk/open-im-server.git
				synced 2025-11-04 11:22:10 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			137 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			137 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright © 2024 OpenIM. All rights reserved.
 | 
						|
//
 | 
						|
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
						|
// you may not use this file except in compliance with the License.
 | 
						|
// You may obtain a copy of the License at
 | 
						|
//
 | 
						|
//     http://www.apache.org/licenses/LICENSE-2.0
 | 
						|
//
 | 
						|
// Unless required by applicable law or agreed to in writing, software
 | 
						|
// distributed under the License is distributed on an "AS IS" BASIS,
 | 
						|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
						|
// See the License for the specific language governing permissions and
 | 
						|
// limitations under the License.
 | 
						|
 | 
						|
package localcache
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"github.com/openimsdk/open-im-server/v3/pkg/localcache/lru"
 | 
						|
)
 | 
						|
 | 
						|
func defaultOption() *option {
 | 
						|
	return &option{
 | 
						|
		localSlotNum:    500,
 | 
						|
		localSlotSize:   20000,
 | 
						|
		linkSlotNum:     500,
 | 
						|
		expirationEvict: false,
 | 
						|
		localSuccessTTL: time.Minute,
 | 
						|
		localFailedTTL:  time.Second * 5,
 | 
						|
		delFn:           make([]func(ctx context.Context, key ...string), 0, 2),
 | 
						|
		target:          EmptyTarget{},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
type option struct {
 | 
						|
	localSlotNum  int
 | 
						|
	localSlotSize int
 | 
						|
	linkSlotNum   int
 | 
						|
	// expirationEvict: true means that the cache will be actively cleared when the timer expires,
 | 
						|
	// false means that the cache will be lazily deleted.
 | 
						|
	expirationEvict bool
 | 
						|
	localSuccessTTL time.Duration
 | 
						|
	localFailedTTL  time.Duration
 | 
						|
	delFn           []func(ctx context.Context, key ...string)
 | 
						|
	target          lru.Target
 | 
						|
}
 | 
						|
 | 
						|
type Option func(o *option)
 | 
						|
 | 
						|
func WithExpirationEvict() Option {
 | 
						|
	return func(o *option) {
 | 
						|
		o.expirationEvict = true
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLazy() Option {
 | 
						|
	return func(o *option) {
 | 
						|
		o.expirationEvict = false
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLocalDisable() Option {
 | 
						|
	return WithLinkSlotNum(0)
 | 
						|
}
 | 
						|
 | 
						|
func WithLinkDisable() Option {
 | 
						|
	return WithLinkSlotNum(0)
 | 
						|
}
 | 
						|
 | 
						|
func WithLinkSlotNum(linkSlotNum int) Option {
 | 
						|
	return func(o *option) {
 | 
						|
		o.linkSlotNum = linkSlotNum
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLocalSlotNum(localSlotNum int) Option {
 | 
						|
	return func(o *option) {
 | 
						|
		o.localSlotNum = localSlotNum
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLocalSlotSize(localSlotSize int) Option {
 | 
						|
	return func(o *option) {
 | 
						|
		o.localSlotSize = localSlotSize
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLocalSuccessTTL(localSuccessTTL time.Duration) Option {
 | 
						|
	if localSuccessTTL < 0 {
 | 
						|
		panic("localSuccessTTL should be greater than 0")
 | 
						|
	}
 | 
						|
	return func(o *option) {
 | 
						|
		o.localSuccessTTL = localSuccessTTL
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithLocalFailedTTL(localFailedTTL time.Duration) Option {
 | 
						|
	if localFailedTTL < 0 {
 | 
						|
		panic("localFailedTTL should be greater than 0")
 | 
						|
	}
 | 
						|
	return func(o *option) {
 | 
						|
		o.localFailedTTL = localFailedTTL
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithTarget(target lru.Target) Option {
 | 
						|
	if target == nil {
 | 
						|
		panic("target should not be nil")
 | 
						|
	}
 | 
						|
	return func(o *option) {
 | 
						|
		o.target = target
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func WithDeleteKeyBefore(fn func(ctx context.Context, key ...string)) Option {
 | 
						|
	if fn == nil {
 | 
						|
		panic("fn should not be nil")
 | 
						|
	}
 | 
						|
	return func(o *option) {
 | 
						|
		o.delFn = append(o.delFn, fn)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
type EmptyTarget struct{}
 | 
						|
 | 
						|
func (e EmptyTarget) IncrGetHit() {}
 | 
						|
 | 
						|
func (e EmptyTarget) IncrGetSuccess() {}
 | 
						|
 | 
						|
func (e EmptyTarget) IncrGetFailed() {}
 | 
						|
 | 
						|
func (e EmptyTarget) IncrDelHit() {}
 | 
						|
 | 
						|
func (e EmptyTarget) IncrDelNotFound() {}
 |