localcache

README

localcache

Dangerous but concurrent local cache wrapper service with high performance.

How to use?

// new serivce
dangerous := localcache.NewService(&localcache.Options{})

// Register Upstream
dangerous.Register("getterName", 5*time.Second, func(key RequestKey, sink Sink) error {
     strVal, err := upstream()
     if err != nil {
         return err
    }
    sink.SetBytes([]byte(strVal))
    return nil
})

// Get Cache
cache := dangerous.Get(&Key{
    GetterName: "getterName",
    CacheName:  "cachename",
    Value:      context,
})

w.Write(cache.Bytes())

Documentation

Index

• Constants
• Variables
• type Broker
• type Cache
• type CacheWrapper
  • func (wrapper *CacheWrapper) Bytes() []byte
  • func (wrapper *CacheWrapper) CreateTime() time.Time
  • func (wrapper *CacheWrapper) GetError() error
  • func (wrapper *CacheWrapper) LastModified() string
  • func (wrapper *CacheWrapper) MD5() string
  • func (wrapper *CacheWrapper) Scan(v interface{}) error
  • func (wrapper *CacheWrapper) String() string
• type EmptyBroker
  • func (*EmptyBroker) Get(_ string) ([]byte, error)
  • func (*EmptyBroker) Set(_ string, _ []byte) error
• type GetterFunc
• type Key
  • func (k *Key) GetCacheName() string
  • func (k *Key) GetGetterName() string
  • func (k *Key) GetValue() interface{}
• type Options
• type RequestKey
• type Service
  • func NewService(opts *Options) *Service
  • func (serv *Service) Close()
  • func (serv *Service) Get(key RequestKey) Cache
  • func (serv *Service) Register(key string, expire time.Duration, getterFunc GetterFunc) error
• type Sink
• type UndefinedBroker
  • func (*UndefinedBroker) Get(_ string) ([]byte, error)
  • func (*UndefinedBroker) Set(_ string, _ []byte) error

Constants

const (
	EvtKindTimeout  = "TIMEOUT"
	EvtKindComplete = "COMPLETE"
)

Variables

var (
	// ErrCacheBrokerTimeout ...
	ErrCacheBrokerTimeout = errors.New("cache broker timeout")
	// ErrCacheGetterTimeout ...
	ErrCacheGetterTimeout = errors.New("cache getter timeout")
)

var ErrBrokerUndefined = errors.New("sorry! localcache's broker undefined")

var ErrGetterUndefined = errors.New("cache getter undefined")

ErrGetterUndefined ...

var ErrServiceClosed = errors.New("cache service closed")

ErrServiceClosed ...

Types

type Broker

type Broker interface {
	Get(key string) ([]byte, error)
	Set(key string, data []byte) error
}

Broker ...

type Cache

type Cache interface {
	CreateTime() time.Time
	Scan(v interface{}) error
	GetError() error
	String() string
	Bytes() []byte

	LastModified() string
	MD5() string
}

Cache ...

type CacheWrapper

type CacheWrapper struct {
	// contains filtered or unexported fields
}

CacheWrapper ...

func (*CacheWrapper) Bytes

func (wrapper *CacheWrapper) Bytes() []byte

Bytes ...

func (*CacheWrapper) CreateTime

func (wrapper *CacheWrapper) CreateTime() time.Time

CreateTime ...

func (*CacheWrapper) GetError

func (wrapper *CacheWrapper) GetError() error

GetError ...

func (*CacheWrapper) LastModified

func (wrapper *CacheWrapper) LastModified() string

LastModified ...

func (*CacheWrapper) MD5

func (wrapper *CacheWrapper) MD5() string

MD5 ...

func (*CacheWrapper) Scan

func (wrapper *CacheWrapper) Scan(v interface{}) error

Scan ...

func (*CacheWrapper) String

func (wrapper *CacheWrapper) String() string

type EmptyBroker

type EmptyBroker struct{}

func (*EmptyBroker) Get

func (*EmptyBroker) Get(_ string) ([]byte, error)

func (*EmptyBroker) Set

func (*EmptyBroker) Set(_ string, _ []byte) error

type GetterFunc

type GetterFunc func(key RequestKey, sink Sink) error

GetterFunc ...

type Key

type Key struct {
	GetterName string
	CacheName  string
	Value      interface{}
}

Key ...

func (*Key) GetCacheName

func (k *Key) GetCacheName() string

GetCacheName ...

func (*Key) GetGetterName

func (k *Key) GetGetterName() string

GetGetterName ...

func (*Key) GetValue

func (k *Key) GetValue() interface{}

GetValue ...

type Options

type Options struct {
	Broker     Broker
	GetTimeout time.Duration
}

Options ...

type RequestKey

type RequestKey interface {
	GetGetterName() string
	GetCacheName() string
	GetValue() interface{}
}

RequestKey ...

type Service

type Service struct {
	*Options

	Logger *log.Logger
	// contains filtered or unexported fields
}

Service ...

func NewService

func NewService(opts *Options) *Service

NewService returns a new cache service.

func (*Service) Close

func (serv *Service) Close()

Close ...

func (*Service) Get

func (serv *Service) Get(key RequestKey) Cache

Get Cache by key

func (*Service) Register

func (serv *Service) Register(key string, expire time.Duration, getterFunc GetterFunc) error

Register ...

type Sink

type Sink interface {
	SetValue(interface{}) error
	SetBytes([]byte) (int, error)

	Bytes() []byte
}

Sink ...

type UndefinedBroker

type UndefinedBroker struct{}

func (*UndefinedBroker) Get

func (*UndefinedBroker) Get(_ string) ([]byte, error)

func (*UndefinedBroker) Set

func (*UndefinedBroker) Set(_ string, _ []byte) error